Skip to content

Commit 769f90f

Browse files
author
Jonathan Corbet
committed
Merge branch 'mauro' into docs-next
Mauro says (as he's cleaning up my mess): This small series address a regression caused by a new patch at docs-next (and at linux-next). Before this patch, when a cross-reference to a chapter within the documentation is needed, we had to add a markup like: .. _foo: foo === This behavor is now different after this patch: 58ad30c ("docs: fix reference to core-api/namespaces.rst") As a Sphinx extension now creates automatically a reference like the above, without requiring any extra markup. That, however, comes with a price: it is not possible anymore to have two sections with the same name within the entire Kernel docs! This causes thousands of warnings, as we have sections named "introduction" on lots of places. This series solve this regression by doing two changes: 1) The references are now prefixed by the document name. So, a file named "bar" would have the "foo" reference as "bar:foo". 2) It will only use the first two levels. The first one is (usually) the name of the document, and the second one the chapter name. This solves almost all problems we have. Still, there are a few places where we have two chapters at the same document with the same name. The first patch addresses this problem. The second patch limits the escope of the autosectionlabel.
2 parents 58ad30c + 4658b0e commit 769f90f

File tree

12 files changed

+35
-31
lines changed

12 files changed

+35
-31
lines changed

Documentation/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
4141
'maintainers_include', 'sphinx.ext.autosectionlabel' ]
4242

43+
# Ensure that autosectionlabel will produce unique names
44+
autosectionlabel_prefix_document = True
45+
autosectionlabel_maxdepth = 2
46+
4347
# The name of the math extension changed on Sphinx 1.4
4448
if (major == 1 and minor > 3) or (major > 1):
4549
extensions.append("sphinx.ext.imgmath")

Documentation/driver-api/80211/mac80211-advanced.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -272,8 +272,8 @@ STA information lifetime rules
272272
.. kernel-doc:: net/mac80211/sta_info.c
273273
:doc: STA information lifetime rules
274274

275-
Aggregation
276-
===========
275+
Aggregation Functions
276+
=====================
277277

278278
.. kernel-doc:: net/mac80211/sta_info.h
279279
:functions: sta_ampdu_mlme
@@ -284,8 +284,8 @@ Aggregation
284284
.. kernel-doc:: net/mac80211/sta_info.h
285285
:functions: tid_ampdu_rx
286286

287-
Synchronisation
288-
===============
287+
Synchronisation Functions
288+
=========================
289289

290290
TBD
291291

Documentation/driver-api/dmaengine/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ DMAEngine documentation
55
DMAEngine documentation provides documents for various aspects of DMAEngine
66
framework.
77

8-
DMAEngine documentation
9-
-----------------------
8+
DMAEngine development documentation
9+
-----------------------------------
1010

1111
This book helps with DMAengine internal APIs and guide for DMAEngine device
1212
driver writers.

Documentation/filesystems/ecryptfs.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,12 @@ Userspace requirements include:
3030
- Libgcrypt
3131

3232

33-
Notes
34-
=====
33+
.. note::
3534

36-
In the beta/experimental releases of eCryptfs, when you upgrade
37-
eCryptfs, you should copy the files to an unencrypted location and
38-
then copy the files back into the new eCryptfs mount to migrate the
39-
files.
35+
In the beta/experimental releases of eCryptfs, when you upgrade
36+
eCryptfs, you should copy the files to an unencrypted location and
37+
then copy the files back into the new eCryptfs mount to migrate the
38+
files.
4039

4140

4241
Mount-wide Passphrase

Documentation/kernel-hacking/hacking.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ Defined in ``include/linux/export.h``
601601

602602
This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol
603603
namespace. Symbol Namespaces are documented in
604-
:ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>`
604+
:doc:`../core-api/symbol-namespaces`
605605

606606
:c:func:`EXPORT_SYMBOL_NS_GPL()`
607607
--------------------------------
@@ -610,7 +610,7 @@ Defined in ``include/linux/export.h``
610610

611611
This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol
612612
namespace. Symbol Namespaces are documented in
613-
:ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>`
613+
:doc:`../core-api/symbol-namespaces`
614614

615615
Routines and Conventions
616616
========================

Documentation/media/kapi/v4l2-controls.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,8 @@ and QUERYMENU. And G/S_CTRL as well as G/TRY/S_EXT_CTRLS are automatically suppo
291291
In practice the basic usage as described above is sufficient for most drivers.
292292

293293

294-
Inheriting Controls
295-
-------------------
294+
Inheriting Sub-device Controls
295+
------------------------------
296296

297297
When a sub-device is registered with a V4L2 driver by calling
298298
v4l2_device_register_subdev() and the ctrl_handler fields of both v4l2_subdev
@@ -757,8 +757,8 @@ attempting to find another control from the same handler will deadlock.
757757
It is recommended not to use this function from inside the control ops.
758758

759759

760-
Inheriting Controls
761-
-------------------
760+
Preventing Controls inheritance
761+
-------------------------------
762762

763763
When one control handler is added to another using v4l2_ctrl_add_handler, then
764764
by default all controls from one are merged to the other. But a subdev might

Documentation/networking/snmp_counter.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -908,8 +908,8 @@ A TLP probe packet is sent.
908908

909909
A packet loss is detected and recovered by TLP.
910910

911-
TCP Fast Open
912-
=============
911+
TCP Fast Open description
912+
=========================
913913
TCP Fast Open is a technology which allows data transfer before the
914914
3-way handshake complete. Please refer the `TCP Fast Open wiki`_ for a
915915
general description.

Documentation/powerpc/ultravisor.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Protected Execution Facility
88
.. contents::
99
:depth: 3
1010

11-
Protected Execution Facility
12-
############################
11+
Introduction
12+
############
1313

1414
Protected Execution Facility (PEF) is an architectural change for
1515
POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips

Documentation/security/siphash.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ then when you can be absolutely certain that the outputs will never be
128128
transmitted out of the kernel. This is only remotely useful over `jhash` as a
129129
means of mitigating hashtable flooding denial of service attacks.
130130

131-
Generating a key
132-
================
131+
Generating a HalfSipHash key
132+
============================
133133

134134
Keys should always be generated from a cryptographically secure source of
135135
random numbers, either using get_random_bytes or get_random_once:
@@ -139,8 +139,8 @@ get_random_bytes(&key, sizeof(key));
139139

140140
If you're not deriving your key from here, you're doing it wrong.
141141

142-
Using the functions
143-
===================
142+
Using the HalfSipHash functions
143+
===============================
144144

145145
There are two variants of the function, one that takes a list of integers, and
146146
one that takes a buffer::

Documentation/target/tcmu-design.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ TCM Userspace Design
55

66
.. Contents:
77
8-
1) TCM Userspace Design
8+
1) Design
99
a) Background
1010
b) Benefits
1111
c) Design constraints
@@ -23,8 +23,8 @@ TCM Userspace Design
2323
3) A final note
2424
2525
26-
TCM Userspace Design
27-
====================
26+
Design
27+
======
2828

2929
TCM is another name for LIO, an in-kernel iSCSI target (server).
3030
Existing TCM targets run in the kernel. TCMU (TCM in Userspace)

Documentation/translations/zh_CN/process/5.Posting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
.. _cn_development_posting:
77

8-
发送补丁
8+
发布补丁
99
========
1010

1111
迟早,当您的工作准备好提交给社区进行审查,并最终包含到主线内核中时。不出所料,

Documentation/x86/intel-iommu.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,10 @@ and any RMRR's processed::
9595
When DMAR is enabled for use, you will notice..
9696

9797
PCI-DMA: Using DMAR IOMMU
98+
-------------------------
9899

99100
Fault reporting
100-
---------------
101+
^^^^^^^^^^^^^^^
101102

102103
::
103104

0 commit comments

Comments
 (0)