Commit c44166fe authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: prevent warnings due to autosectionlabel

Changeset 58ad30cf ("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: 58ad30cf ("docs: fix reference to core-api/namespaces.rst")
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2bffb91e4a63d41bf5fae1c23e1e8b3bba0b8806.1584716446.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 58ad30cf
...@@ -272,8 +272,8 @@ STA information lifetime rules ...@@ -272,8 +272,8 @@ STA information lifetime rules
.. kernel-doc:: net/mac80211/sta_info.c .. kernel-doc:: net/mac80211/sta_info.c
:doc: STA information lifetime rules :doc: STA information lifetime rules
Aggregation Aggregation Functions
=========== =====================
.. kernel-doc:: net/mac80211/sta_info.h .. kernel-doc:: net/mac80211/sta_info.h
:functions: sta_ampdu_mlme :functions: sta_ampdu_mlme
...@@ -284,8 +284,8 @@ Aggregation ...@@ -284,8 +284,8 @@ Aggregation
.. kernel-doc:: net/mac80211/sta_info.h .. kernel-doc:: net/mac80211/sta_info.h
:functions: tid_ampdu_rx :functions: tid_ampdu_rx
Synchronisation Synchronisation Functions
=============== =========================
TBD TBD
......
...@@ -5,8 +5,8 @@ DMAEngine documentation ...@@ -5,8 +5,8 @@ DMAEngine documentation
DMAEngine documentation provides documents for various aspects of DMAEngine DMAEngine documentation provides documents for various aspects of DMAEngine
framework. framework.
DMAEngine documentation DMAEngine development documentation
----------------------- -----------------------------------
This book helps with DMAengine internal APIs and guide for DMAEngine device This book helps with DMAengine internal APIs and guide for DMAEngine device
driver writers. driver writers.
......
...@@ -30,13 +30,12 @@ Userspace requirements include: ...@@ -30,13 +30,12 @@ Userspace requirements include:
- Libgcrypt - Libgcrypt
Notes .. note::
=====
In the beta/experimental releases of eCryptfs, when you upgrade In the beta/experimental releases of eCryptfs, when you upgrade
eCryptfs, you should copy the files to an unencrypted location and eCryptfs, you should copy the files to an unencrypted location and
then copy the files back into the new eCryptfs mount to migrate the then copy the files back into the new eCryptfs mount to migrate the
files. files.
Mount-wide Passphrase Mount-wide Passphrase
......
...@@ -601,7 +601,7 @@ Defined in ``include/linux/export.h`` ...@@ -601,7 +601,7 @@ Defined in ``include/linux/export.h``
This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol
namespace. Symbol Namespaces are documented in namespace. Symbol Namespaces are documented in
:ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>` :doc:`../core-api/symbol-namespaces`
:c:func:`EXPORT_SYMBOL_NS_GPL()` :c:func:`EXPORT_SYMBOL_NS_GPL()`
-------------------------------- --------------------------------
...@@ -610,7 +610,7 @@ Defined in ``include/linux/export.h`` ...@@ -610,7 +610,7 @@ Defined in ``include/linux/export.h``
This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol
namespace. Symbol Namespaces are documented in namespace. Symbol Namespaces are documented in
:ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>` :doc:`../core-api/symbol-namespaces`
Routines and Conventions Routines and Conventions
======================== ========================
......
...@@ -291,8 +291,8 @@ and QUERYMENU. And G/S_CTRL as well as G/TRY/S_EXT_CTRLS are automatically suppo ...@@ -291,8 +291,8 @@ and QUERYMENU. And G/S_CTRL as well as G/TRY/S_EXT_CTRLS are automatically suppo
In practice the basic usage as described above is sufficient for most drivers. In practice the basic usage as described above is sufficient for most drivers.
Inheriting Controls Inheriting Sub-device Controls
------------------- ------------------------------
When a sub-device is registered with a V4L2 driver by calling When a sub-device is registered with a V4L2 driver by calling
v4l2_device_register_subdev() and the ctrl_handler fields of both v4l2_subdev 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. ...@@ -757,8 +757,8 @@ attempting to find another control from the same handler will deadlock.
It is recommended not to use this function from inside the control ops. It is recommended not to use this function from inside the control ops.
Inheriting Controls Preventing Controls inheritance
------------------- -------------------------------
When one control handler is added to another using v4l2_ctrl_add_handler, then When one control handler is added to another using v4l2_ctrl_add_handler, then
by default all controls from one are merged to the other. But a subdev might by default all controls from one are merged to the other. But a subdev might
......
...@@ -908,8 +908,8 @@ A TLP probe packet is sent. ...@@ -908,8 +908,8 @@ A TLP probe packet is sent.
A packet loss is detected and recovered by TLP. A packet loss is detected and recovered by TLP.
TCP Fast Open TCP Fast Open description
============= =========================
TCP Fast Open is a technology which allows data transfer before the TCP Fast Open is a technology which allows data transfer before the
3-way handshake complete. Please refer the `TCP Fast Open wiki`_ for a 3-way handshake complete. Please refer the `TCP Fast Open wiki`_ for a
general description. general description.
......
...@@ -8,8 +8,8 @@ Protected Execution Facility ...@@ -8,8 +8,8 @@ Protected Execution Facility
.. contents:: .. contents::
:depth: 3 :depth: 3
Protected Execution Facility Introduction
############################ ############
Protected Execution Facility (PEF) is an architectural change for Protected Execution Facility (PEF) is an architectural change for
POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips POWER 9 that enables Secure Virtual Machines (SVMs). DD2.3 chips
......
...@@ -128,8 +128,8 @@ then when you can be absolutely certain that the outputs will never be ...@@ -128,8 +128,8 @@ then when you can be absolutely certain that the outputs will never be
transmitted out of the kernel. This is only remotely useful over `jhash` as a transmitted out of the kernel. This is only remotely useful over `jhash` as a
means of mitigating hashtable flooding denial of service attacks. means of mitigating hashtable flooding denial of service attacks.
Generating a key Generating a HalfSipHash key
================ ============================
Keys should always be generated from a cryptographically secure source of Keys should always be generated from a cryptographically secure source of
random numbers, either using get_random_bytes or get_random_once: random numbers, either using get_random_bytes or get_random_once:
...@@ -139,8 +139,8 @@ get_random_bytes(&key, sizeof(key)); ...@@ -139,8 +139,8 @@ get_random_bytes(&key, sizeof(key));
If you're not deriving your key from here, you're doing it wrong. If you're not deriving your key from here, you're doing it wrong.
Using the functions Using the HalfSipHash functions
=================== ===============================
There are two variants of the function, one that takes a list of integers, and There are two variants of the function, one that takes a list of integers, and
one that takes a buffer:: one that takes a buffer::
......
...@@ -5,7 +5,7 @@ TCM Userspace Design ...@@ -5,7 +5,7 @@ TCM Userspace Design
.. Contents: .. Contents:
1) TCM Userspace Design 1) Design
a) Background a) Background
b) Benefits b) Benefits
c) Design constraints c) Design constraints
...@@ -23,8 +23,8 @@ TCM Userspace Design ...@@ -23,8 +23,8 @@ TCM Userspace Design
3) A final note 3) A final note
TCM Userspace Design Design
==================== ======
TCM is another name for LIO, an in-kernel iSCSI target (server). TCM is another name for LIO, an in-kernel iSCSI target (server).
Existing TCM targets run in the kernel. TCMU (TCM in Userspace) Existing TCM targets run in the kernel. TCMU (TCM in Userspace)
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
.. _cn_development_posting: .. _cn_development_posting:
补丁 补丁
======== ========
迟早,当您的工作准备好提交给社区进行审查,并最终包含到主线内核中时。不出所料, 迟早,当您的工作准备好提交给社区进行审查,并最终包含到主线内核中时。不出所料,
......
...@@ -95,9 +95,10 @@ and any RMRR's processed:: ...@@ -95,9 +95,10 @@ and any RMRR's processed::
When DMAR is enabled for use, you will notice.. When DMAR is enabled for use, you will notice..
PCI-DMA: Using DMAR IOMMU PCI-DMA: Using DMAR IOMMU
-------------------------
Fault reporting Fault reporting
--------------- ^^^^^^^^^^^^^^^
:: ::
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment