Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: prevent warnings due to autosectionlabel

Changeset 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
enabled a new feature at Sphinx: it will now generate index for each
document title, plus to each chapter inside it.

There's a drawback, though: one document cannot have two sections
with the same name anymore.

A followup patch will change the logic of autosectionlabel to
avoid most creating references for every single section title,
but still we need to be able to reference the chapters inside
a document.

There are a few places where there are two chapters with the
same name. This patch renames one of the chapters, in order to
avoid symbol conflict within the same document.

PS.: as I don't speach Chinese, I had some help from a friend
(Wen Liu) at the Chinese translation for "publishing patches"
for this document:

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

Fixes: 58ad30cf91f0 ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2bffb91e4a63d41bf5fae1c23e1e8b3bba0b8806.1584716446.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
c44166fe 58ad30cf

+31 -31
+4 -4
Documentation/driver-api/80211/mac80211-advanced.rst
··· 272 272 .. kernel-doc:: net/mac80211/sta_info.c 273 273 :doc: STA information lifetime rules 274 274 275 - Aggregation 276 - =========== 275 + Aggregation Functions 276 + ===================== 277 277 278 278 .. kernel-doc:: net/mac80211/sta_info.h 279 279 :functions: sta_ampdu_mlme ··· 284 284 .. kernel-doc:: net/mac80211/sta_info.h 285 285 :functions: tid_ampdu_rx 286 286 287 - Synchronisation 288 - =============== 287 + Synchronisation Functions 288 + ========================= 289 289 290 290 TBD 291 291
+2 -2
Documentation/driver-api/dmaengine/index.rst
··· 5 5 DMAEngine documentation provides documents for various aspects of DMAEngine 6 6 framework. 7 7 8 - DMAEngine documentation 9 - ----------------------- 8 + DMAEngine development documentation 9 + ----------------------------------- 10 10 11 11 This book helps with DMAengine internal APIs and guide for DMAEngine device 12 12 driver writers.
+5 -6
Documentation/filesystems/ecryptfs.rst
··· 30 30 - Libgcrypt 31 31 32 32 33 - Notes 34 - ===== 33 + .. note:: 35 34 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. 40 39 41 40 42 41 Mount-wide Passphrase
+2 -2
Documentation/kernel-hacking/hacking.rst
··· 601 601 602 602 This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol 603 603 namespace. Symbol Namespaces are documented in 604 - :ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>` 604 + :doc:`../core-api/symbol-namespaces` 605 605 606 606 :c:func:`EXPORT_SYMBOL_NS_GPL()` 607 607 -------------------------------- ··· 610 610 611 611 This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol 612 612 namespace. Symbol Namespaces are documented in 613 - :ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>` 613 + :doc:`../core-api/symbol-namespaces` 614 614 615 615 Routines and Conventions 616 616 ========================
+4 -4
Documentation/media/kapi/v4l2-controls.rst
··· 291 291 In practice the basic usage as described above is sufficient for most drivers. 292 292 293 293 294 - Inheriting Controls 295 - ------------------- 294 + Inheriting Sub-device Controls 295 + ------------------------------ 296 296 297 297 When a sub-device is registered with a V4L2 driver by calling 298 298 v4l2_device_register_subdev() and the ctrl_handler fields of both v4l2_subdev ··· 757 757 It is recommended not to use this function from inside the control ops. 758 758 759 759 760 - Inheriting Controls 761 - ------------------- 760 + Preventing Controls inheritance 761 + ------------------------------- 762 762 763 763 When one control handler is added to another using v4l2_ctrl_add_handler, then 764 764 by default all controls from one are merged to the other. But a subdev might
+2 -2
Documentation/networking/snmp_counter.rst
··· 908 908 909 909 A packet loss is detected and recovered by TLP. 910 910 911 - TCP Fast Open 912 - ============= 911 + TCP Fast Open description 912 + ========================= 913 913 TCP Fast Open is a technology which allows data transfer before the 914 914 3-way handshake complete. Please refer the `TCP Fast Open wiki`_ for a 915 915 general description.
+2 -2
Documentation/powerpc/ultravisor.rst
··· 8 8 .. contents:: 9 9 :depth: 3 10 10 11 - Protected Execution Facility 12 - ############################ 11 + Introduction 12 + ############ 13 13 14 14 Protected Execution Facility (PEF) is an architectural change for 15 15 POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips
+4 -4
Documentation/security/siphash.rst
··· 128 128 transmitted out of the kernel. This is only remotely useful over `jhash` as a 129 129 means of mitigating hashtable flooding denial of service attacks. 130 130 131 - Generating a key 132 - ================ 131 + Generating a HalfSipHash key 132 + ============================ 133 133 134 134 Keys should always be generated from a cryptographically secure source of 135 135 random numbers, either using get_random_bytes or get_random_once: ··· 139 139 140 140 If you're not deriving your key from here, you're doing it wrong. 141 141 142 - Using the functions 143 - =================== 142 + Using the HalfSipHash functions 143 + =============================== 144 144 145 145 There are two variants of the function, one that takes a list of integers, and 146 146 one that takes a buffer::
+3 -3
Documentation/target/tcmu-design.rst
··· 5 5 6 6 .. Contents: 7 7 8 - 1) TCM Userspace Design 8 + 1) Design 9 9 a) Background 10 10 b) Benefits 11 11 c) Design constraints ··· 23 23 3) A final note 24 24 25 25 26 - TCM Userspace Design 27 - ==================== 26 + Design 27 + ====== 28 28 29 29 TCM is another name for LIO, an in-kernel iSCSI target (server). 30 30 Existing TCM targets run in the kernel. TCMU (TCM in Userspace)
+1 -1
Documentation/translations/zh_CN/process/5.Posting.rst
··· 5 5 6 6 .. _cn_development_posting: 7 7 8 - 发送补丁 8 + 发布补丁 9 9 ======== 10 10 11 11 迟早,当您的工作准备好提交给社区进行审查,并最终包含到主线内核中时。不出所料,
+2 -1
Documentation/x86/intel-iommu.rst
··· 95 95 When DMAR is enabled for use, you will notice.. 96 96 97 97 PCI-DMA: Using DMAR IOMMU 98 + ------------------------- 98 99 99 100 Fault reporting 100 - --------------- 101 + ^^^^^^^^^^^^^^^ 101 102 102 103 :: 103 104