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

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.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 58ad30cf

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

+4 −4
Original line number Diff line number Diff line
@@ -272,8 +272,8 @@ STA information lifetime rules 
.. kernel-doc:: net/mac80211/sta_info.c

   :doc: STA information lifetime rules



Aggregation

===========

Aggregation Functions

=====================



.. kernel-doc:: net/mac80211/sta_info.h

   :functions: sta_ampdu_mlme
@@ -284,8 +284,8 @@ Aggregation 
.. kernel-doc:: net/mac80211/sta_info.h

   :functions: tid_ampdu_rx



Synchronisation

===============

Synchronisation Functions

=========================



TBD

Documentation/driver-api/dmaengine/index.rst

+2 −2
Original line number Diff line number Diff line
@@ -5,8 +5,8 @@ DMAEngine documentation 
DMAEngine documentation provides documents for various aspects of DMAEngine

framework.



DMAEngine documentation

-----------------------

DMAEngine development documentation

-----------------------------------



This book helps with DMAengine internal APIs and guide for DMAEngine device

driver writers.

Documentation/filesystems/ecryptfs.rst

+5 −6
Original line number Diff line number Diff line
@@ -30,8 +30,7 @@ Userspace requirements include: 
- Libgcrypt





Notes

=====

.. note::



   In the beta/experimental releases of eCryptfs, when you upgrade

   eCryptfs, you should copy the files to an unencrypted location and

Documentation/kernel-hacking/hacking.rst

+2 −2
Original line number Diff line number Diff line
@@ -601,7 +601,7 @@ Defined in ``include/linux/export.h`` 


This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol

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()`

--------------------------------
@@ -610,7 +610,7 @@ Defined in ``include/linux/export.h`` 


This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol

namespace. Symbol Namespaces are documented in

:ref:`Documentation/core-api/symbol-namespaces.rst <Symbol Namespaces>`

:doc:`../core-api/symbol-namespaces`



Routines and Conventions

========================

Documentation/media/kapi/v4l2-controls.rst

+4 −4
Original line number Diff line number Diff line
@@ -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.





Inheriting Controls

-------------------

Inheriting Sub-device Controls

------------------------------



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
@@ -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.





Inheriting Controls

-------------------

Preventing Controls inheritance

-------------------------------



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

CRA Git | Maintained and supported by SUSTech CRA and CCSE