1
0
Fork 0
mirror of synced 2025-03-06 20:59:54 +01:00
linux/Documentation
Dave Tucker 5931d9a3d0 bpf, docs: Fix ordering of bpf documentation
This commit fixes the display of the BPF documentation in the sidebar
when rendered as HTML.

Before this patch, the sidebar would render as follows for some
sections:

| BPF Documentation
  |- BPF Type Format (BTF)
    |- BPF Type Format (BTF)

This was due to creating a heading in index.rst followed by
a sphinx toctree, where the file referenced carries the same
title as the section heading.

To fix this I applied a pattern that has been established in other
subfolders of Documentation:

1. Re-wrote index.rst to have a single toctree
2. Split the sections out in to their own files

Additionally maps.rst and programs.rst make use of a glob pattern to
include map_* or prog_* rst files in their toctree, meaning future map
or program type documentation will be automatically included.

Signed-off-by: Dave Tucker <dave@dtucker.co.uk>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/1a1eed800e7b9dc13b458de113a489641519b0cc.1636749493.git.dave@dtucker.co.uk
2021-11-17 23:24:01 +01:00
..
ABI pci-v5.16-changes 2021-11-06 14:36:12 -07:00
accounting
admin-guide A slow cycle for nfsd: mainly cleanup, including Neil's patch dropping 2021-11-10 16:45:54 -08:00
arm ARM: SoC updates for v5.16 2021-11-03 16:48:32 -07:00
arm64 Merge branch 'for-next/trbe-errata' into for-next/core 2021-10-29 12:25:33 +01:00
block This is a relatively unexciting cycle for documentation. 2021-11-02 22:11:39 -07:00
bpf bpf, docs: Fix ordering of bpf documentation 2021-11-17 23:24:01 +01:00
cdrom drivers/cdrom: improved ioctl for media change detection 2021-09-14 20:05:26 -06:00
core-api Merge branch 'akpm' (patches from Andrew) 2021-11-06 14:08:17 -07:00
cpu-freq cpufreq: Remove ready() callback 2021-09-02 18:04:17 +02:00
crypto crypto: engine - Add KPP Support to Crypto Engine 2021-10-29 21:04:03 +08:00
dev-tools Merge branch 'akpm' (patches from Andrew) 2021-11-09 10:11:53 -08:00
devicetree Revert "Merge branch 'mctp-i2c-driver'" 2021-11-15 07:53:10 -08:00
doc-guide
driver-api cxl for v5.16 2021-11-08 11:49:48 -08:00
fault-injection Char / Misc driver changes for 5.15-rc1 2021-09-01 08:35:06 -07:00
fb
features parisc: Move thread_info into task struct 2021-11-01 07:35:59 +01:00
filesystems A slow cycle for nfsd: mainly cleanup, including Neil's patch dropping 2021-11-10 16:45:54 -08:00
firmware-guide Documentation: ACPI: Fix non-D0 probe _DSC object example 2021-11-10 13:59:12 +01:00
firmware_class
fpga fpga: fix spelling mistakes 2021-07-21 19:54:21 -07:00
gpu drm-misc-next for 5.16: 2021-11-05 13:50:15 +10:00
hid
hwmon Driver core changes for 5.16-rc1 2021-11-04 08:32:38 -07:00
i2c Documentation: i2c: add i2c-sysfs into index 2021-08-10 22:58:32 +02:00
ia64
ide
iio
infiniband
input
isdn
kbuild Kbuild updates for v5.16 2021-11-08 09:15:45 -08:00
kernel-hacking docs: futex: Fix kernel-doc references 2021-10-19 17:27:05 +02:00
leds leds: add new LED_FUNCTION_PLAYER for player LEDs for game controllers. 2021-10-27 09:49:29 +02:00
litmus-tests
livepatch
locking doc: drm: remove TODO entry regarding DRM_MODSET_LOCK_ALL cleanup 2021-10-01 13:01:05 -04:00
m68k
maintainer docs: use the lore redirector everywhere 2021-10-12 13:58:19 -06:00
mhi
mips
misc-devices
netlabel
networking Networking fixes for 5.16-rc1, including fixes from bpf, can 2021-11-11 09:49:36 -08:00
nios2
nvdimm
openrisc
parisc
PCI pci-v5.15-changes 2021-09-07 19:13:42 -07:00
pcmcia
power Documentation: power: include kernel-doc in Energy Model doc 2021-09-07 21:17:28 +02:00
powerpc powerpc/doc: Fix htmldocs errors 2021-08-27 00:56:34 +10:00
process docs: submitting-patches: make section about the Link: tag more explicit 2021-10-28 13:53:47 -06:00
RCU rcu: Fix undefined Kconfig macros 2021-09-13 16:32:46 -07:00
riscv riscv: Ensure BPF_JIT_REGION_START aligned with PMD size 2021-06-18 21:10:05 -07:00
s390 vfio/mdev: Remove CONFIG_VFIO_MDEV_DEVICE 2021-06-21 15:29:25 -06:00
scheduler sched/fair: Add document for burstable CFS bandwidth 2021-10-05 15:51:41 +02:00
scsi
security security: add sctp_assoc_established hook 2021-11-03 11:09:20 +00:00
sh
sound ASoC: doc: update codec example code 2021-10-25 12:36:14 +01:00
sparc
sphinx docs: sphinx-requirements: Move sphinx_rtd_theme to top 2021-08-12 09:15:38 -06:00
sphinx-static
spi spi: Remove unused function spi_busnum_to_master() 2021-10-07 15:45:57 +01:00
staging
target
timers Documentation/no_hz: Introduce "dyntick-idle mode" before using it 2021-09-27 11:31:11 -06:00
trace tracing/histogram: Update division by 0 documentation 2021-11-01 20:46:29 -04:00
translations Merge branch 'akpm' (patches from Andrew) 2021-11-06 14:08:17 -07:00
usb docs: usb: fix malformed table 2021-08-05 12:31:51 +02:00
userspace-api Char/Misc driver update for 5.16-rc1 2021-11-04 08:21:47 -07:00
virt Char/Misc driver update for 5.16-rc1 2021-11-04 08:21:47 -07:00
vm mm/migrate.c: remove MIGRATE_PFN_LOCKED 2021-11-11 09:34:35 -08:00
w1 dt-bindings: w1: update w1-gpio.yaml reference 2021-09-16 21:02:09 -05:00
watchdog
x86 Driver core changes for 5.16-rc1 2021-11-04 08:32:38 -07:00
xtensa
.gitignore
arch.rst
asm-annotations.rst docs: use the lore redirector everywhere 2021-10-12 13:58:19 -06:00
atomic_bitops.txt
atomic_t.txt Documentation/atomic_t: Document forward progress expectations 2021-08-04 15:16:47 +02:00
Changes
CodingStyle
conf.py docs: pdfdocs: Adjust \headheight for fancyhdr 2021-10-12 14:09:03 -06:00
COPYING-logo
docutils.conf
dontdiff
index.rst
Kconfig
logo.gif
Makefile
memory-barriers.txt
SubmittingPatches
watch_queue.rst