Jani Nikula a592a36e49 Documentation: use a source-read extension for the index link boilerplate ... The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>		2026-01-23 11:59:34 -07:00
..
caif	…
device_drivers	Documentation: use a source-read extension for the index link boilerplate	2026-01-23 11:59:34 -07:00
devlink	net/mlx5: implement swp_l4_csum_mode via devlink params	2025-11-20 19:01:22 -08:00
diagnostic	Documentation: use a source-read extension for the index link boilerplate	2026-01-23 11:59:34 -07:00
dsa	Documentation: net: dsa: mention simple HSR offload helpers	2025-12-01 16:51:55 -08:00
mac80211_hwsim	…
net_cachelines	tcp: remove icsk->icsk_retransmit_timer	2025-11-25 19:28:29 -08:00
pse-pd	net: pse-pd: Add support for PSE PIs	2024-04-18 18:27:33 -07:00
xfrm	net: Move XFRM documentation into its own subdirectory	2025-11-12 08:30:03 +01:00
6lowpan.rst	…
6pack.rst	net: 6pack: Demote "How to turn on 6pack support" section heading	2025-10-21 10:57:45 +02:00
af_xdp.rst	net: xsk: introduce XDP_MAX_TX_SKB_BUDGET setsockopt	2025-07-10 14:48:29 +02:00
alias.rst	…
arcnet-hardware.rst	Documentation: ARCnet: Update obsolete contact info	2025-10-31 18:08:08 -07:00
arcnet.rst	Documentation: ARCnet: Update obsolete contact info	2025-10-31 18:08:08 -07:00
atm.rst	…
ax25.rst	Documentation: networking: ax25: update the mailing list info.	2025-10-21 17:41:57 -07:00
bareudp.rst	docs: net: bareudp: fix spelling and grammar mistakes	2024-11-30 13:54:28 -08:00
batman-adv.rst	batman-adv: Use consistent name for mesh interface	2025-02-22 11:36:22 +01:00
bonding.rst	bonding: support aggregator selection based on port priority	2025-09-09 10:56:02 +02:00
bridge.rst	Documentation: update mailing list addresses	2024-02-21 13:44:21 -07:00
can.rst	linux-can-fixes-for-6.18-20251014	2025-10-15 17:56:20 -07:00
can_ucan_protocol.rst	Documentation: networking: correct spelling	2023-01-31 13:00:47 +01:00
cdc_mbim.rst	Fix spelling mistake	2024-11-28 12:08:32 +01:00
checksum-offloads.rst	…
dctcp.rst	…
devmem.rst	net: add devmem TCP TX documentation	2025-05-13 11:12:48 +02:00
dns_resolver.rst	net: dns_resolver: Fix request-key cross-reference	2025-09-26 15:21:38 -07:00
driver.rst	net: docs: update the sample code in driver.rst	2023-04-13 13:30:21 +02:00
eql.rst	…
ethtool-netlink.rst	ethtool: netlink: add ETHTOOL_MSG_MSE_GET and wire up PHY MSE access	2025-11-03 18:32:27 -08:00
failover.rst	…
fib_trie.rst	…
filter.rst	ARC: Add eBPF JIT support	2024-05-12 16:51:36 -07:00
gen_stats.rst	…
generic-hdlc.rst	…
generic_netlink.rst	Documentation: networking: Update generic_netlink_howto URL	2022-11-23 17:25:02 -08:00
gtp.rst	Documentation: networking: correct spelling	2023-01-31 13:00:47 +01:00
ieee802154.rst	Documentation: ieee802154: fix grammar	2024-10-28 21:14:27 +01:00
ila.rst	…
index.rst	Documentation: use a source-read extension for the index link boilerplate	2026-01-23 11:59:34 -07:00
ioam6-sysctl.rst	…
iou-zcrx.rst	io_uring/zcrx: add support for IORING_SETUP_CQE_MIXED	2025-08-27 11:24:22 -06:00
ip-sysctl.rst	tcp: add net.ipv4.tcp_rcvbuf_low_rtt	2025-11-20 17:44:23 -08:00
ip_dynaddr.rst	…
ipsec.rst	…
ipv6.rst	…
ipvlan.rst	Documentation: networking: correct spelling	2023-01-31 13:00:47 +01:00
ipvs-sysctl.rst	ipvs: run_estimation should control the kthread tasks	2022-12-10 22:44:43 +01:00
iso15765-2.rst	Documentation/networking: fix basic node example document ISO 15765-2	2025-02-08 11:28:11 +01:00
j1939.rst	can: j1939: Extend stack documentation with buffer size behavior	2025-02-19 11:10:53 +01:00
kapi.rst	net-shapers: implement NL get operation	2024-10-10 08:30:22 -07:00
kcm.rst	docs/kcm: Fix typo "BFP"	2025-03-24 12:20:42 -07:00
l2tp.rst	documentation/networking: update l2tp docs	2024-08-11 04:38:49 +01:00
lapb-module.rst	…
mac80211-auth-assoc-deauth.txt	…
mac80211-injection.rst	…
mctp.rst	…
mpls-sysctl.rst	…
mptcp-sysctl.rst	mptcp: make ADD_ADDR retransmission timeout adaptive	2025-09-09 18:57:45 -07:00
mptcp.rst	Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net	2025-09-11 17:40:13 -07:00
msg_zerocopy.rst	docs: net: description of MSG_ZEROCOPY for AF_VSOCK	2023-10-15 13:19:42 +01:00
multi-pf-netdev.rst	tools: ynl: move python code to separate sub-directory	2025-01-09 12:53:27 -08:00
multiqueue.rst	…
napi.rst	net: Extend NAPI threaded polling to allow kthread based busy polling	2025-11-03 18:11:40 -08:00
net_dim.rst	dim: pass dim_sample to net_dim() by reference	2024-11-03 12:36:54 -08:00
net_failover.rst	Documentation: net: net_failover: Separate cloud-ifupdown-helper and reattach-vf.sh code blocks marker	2025-10-17 16:28:29 -07:00
netconsole.rst	Documentation: netconsole: Separate literal code blocks for full and short netcat command name versions	2025-10-31 16:54:22 -07:00
netdev-features.rst	net: enable driver support for netmem TX	2025-05-13 11:12:49 +02:00
netdevices.rst	netdev: fix the locking for netdev notifications	2025-04-17 18:55:14 -07:00
netfilter-sysctl.rst	…
netif-msg.rst	…
netmem.rst	net: enable driver support for netmem TX	2025-05-13 11:12:49 +02:00
nexthop-group-resilient.rst	…
nf_conntrack-sysctl.rst	netfilter: conntrack: remove DCCP protocol support	2025-07-03 13:51:39 +02:00
nf_flowtable.rst	…
nfc.rst	net: nfc: Format userspace interface subsection headings	2025-10-21 10:57:45 +02:00
oa-tc6-framework.rst	Documentation: networking: add OPEN Alliance 10BASE-T1x MAC-PHY serial interface	2024-09-11 20:53:42 -07:00
openvswitch.rst	…
operstates.rst	…
packet_mmap.rst	docs: networking: packet_mmap: replace dead links with archive.org links	2024-10-28 15:47:10 -07:00
page_pool.rst	net: page_pool: expose page pool stats via netlink	2023-11-28 15:48:39 +01:00
phonet.rst	Documentation: networking: correct spelling	2023-01-31 13:00:47 +01:00
phy-link-topology.rst	Documentation: networking: document phy_link_topology	2024-08-23 13:04:35 +01:00
phy.rst	Revert "Documentation: net: add flow control guide and document ethtool API"	2025-10-01 09:48:21 +02:00
pktgen.rst	pktgen: Introducing 'SHARED' flag for testing with non-shared skb	2023-09-28 16:25:14 +02:00
plip.rst	…
ppp_generic.rst	…
proc_net_tcp.rst	…
psp.rst	psp: add documentation	2025-09-18 12:32:06 +02:00
radiotap-headers.rst	…
rds.rst	Documentation: Fix networking typos	2025-08-18 10:31:20 -06:00
regulatory.rst	Documentation: networking: correct spelling	2023-01-31 13:00:47 +01:00
representors.rst	Documentation: Add documentation for eswitch attribute	2024-03-28 18:20:08 -07:00
rxrpc.rst	Documentation: rxrpc: Demote three sections	2025-09-24 18:12:10 -07:00
scaling.rst	net: move aRFS rmap management and CPU affinity to core	2025-02-26 19:51:37 -08:00
sctp.rst	…
secid.rst	…
seg6-sysctl.rst	doc: fix seg6_flowlabel path	2025-10-12 22:51:37 +01:00
segmentation-offloads.rst	net: gso: restore ids of outer ip headers correctly	2025-09-25 12:42:49 +02:00
sfp-phylink.rst	doc: sfp-phylink: update the porting guide with PCS handling	2024-03-07 15:27:05 +01:00
skbuff.rst	skbuff: render the checksum comment to documentation	2022-05-10 17:48:37 -07:00
smc-sysctl.rst	net/smc: handle -ENOMEM from smc_wr_alloc_link_mem gracefully	2025-10-30 13:31:43 +01:00
snmp_counter.rst	docs: automarkup: linkify git revs	2023-11-17 13:13:24 -07:00
sriov.rst	docs: net: document guidance of implementing the SR-IOV NDOs	2024-06-21 10:18:45 +01:00
statistics.rst	net: docs: add missing features that can have stats	2025-10-20 18:31:25 -07:00
strparser.rst	docs: networking: strparser: Fix a typo	2025-03-24 12:14:16 -07:00
switchdev.rst	net: rename netns_local to netns_immutable	2025-03-04 12:44:48 +01:00
sysfs-tagging.rst	Documentation: networking: correct spelling	2023-01-31 13:00:47 +01:00
tc-actions-env-rules.rst	…
tc-queue-filters.rst	Documentation: networking: TC queue based filtering	2022-10-25 10:32:40 +02:00
tcp-thin.rst	…
tcp_ao.rst	Documentation: networking/tcp_ao: typo and grammar fixes	2024-10-03 16:38:48 -07:00
team.rst	…
timestamping.rst	docs: networking: timestamping: improve stacked PHC sentence	2025-05-13 15:40:54 -07:00
tipc.rst	Documentation: tipc: fix formatting issue in tipc.rst	2024-11-19 11:17:13 +01:00
tls-handshake.rst	net/handshake: Enable the SNI extension to work properly	2023-05-24 22:05:24 -07:00
tls-offload-layers.svg	…
tls-offload-reorder-bad.svg	…
tls-offload-reorder-good.svg	…
tls-offload.rst	Documentation: tls_offload: fix typos and grammar	2024-11-28 12:09:06 +01:00
tls.rst	net/tls: support setting the maximum payload size	2025-10-27 16:13:42 -07:00
tproxy.rst	docs: tproxy: fix formatting for nft code block	2025-04-29 00:00:26 +02:00
tuntap.rst	…
udplite.rst	…
vrf.rst	…
vxlan.rst	…
x25-iface.rst	docs: networking: fix x25-iface.rst heading & index order	2023-05-10 10:31:46 +01:00
x25.rst	…
xdp-rx-metadata.rst	doc: xdp: Clarify driver implementation for XDP Rx metadata	2025-07-16 16:36:11 -07:00
xsk-tx-metadata.rst	xsk: Add launch time hardware offload support to XDP Tx metadata	2025-02-20 15:13:45 -08:00