Commit 769f90f8 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

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:

	58ad30cf ("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.
parents 58ad30cf 4658b0eb
Loading
Loading
Loading
Loading
+4 −0
Original line number Original line Diff line number Diff line
@@ -40,6 +40,10 @@ extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain',
              'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
              'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
              'maintainers_include', 'sphinx.ext.autosectionlabel' ]
              'maintainers_include', 'sphinx.ext.autosectionlabel' ]


# Ensure that autosectionlabel will produce unique names
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 2

# The name of the math extension changed on Sphinx 1.4
# The name of the math extension changed on Sphinx 1.4
if (major == 1 and minor > 3) or (major > 1):
if (major == 1 and minor > 3) or (major > 1):
    extensions.append("sphinx.ext.imgmath")
    extensions.append("sphinx.ext.imgmath")
+4 −4
Original line number Original line Diff line number Diff line
@@ -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
.. 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


+2 −2
Original line number Original line Diff line number Diff line
@@ -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.
+5 −6
Original line number Original line Diff line number Diff line
@@ -30,8 +30,7 @@ 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
+2 −2
Original line number Original line 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
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``


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
========================
========================
Loading