Don't generate thousands of new warnings when building docs
Get series with b4
b4 am [email protected]Versions newest first
- v2 Latest2 patches 4 repliesIn review
Patches in v2 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/2 | docs: prevent warnings due to autosectionlabelDocumentation/ Documentation/ Documentation/ +8 more | +31 | 0 replies | |
| 2/2 | docs: conf.py: avoid thousands of duplicate label warning on SphinxDocumentation/ | +4 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.
Cover letter [PATCH v2 0/2] Don't generate thousands of new warnings when building docs
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:
58ad30cf91f0 ("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.
Mauro Carvalho Chehab (2):
docs: prevent warnings due to autosectionlabel
docs: conf.py: avoid thousands of duplicate label warning on Sphinx
Documentation/conf.py | 4 ++++ Documentation/driver-api/80211/mac80211-advanced.rst | 8 ++++---- Documentation/driver-api/dmaengine/index.rst | 4 ++-- Documentation/filesystems/ecryptfs.rst | 11 +++++------ Documentation/kernel-hacking/hacking.rst | 4 ++-- Documentation/media/kapi/v4l2-controls.rst | 8 ++++---- Documentation/networking/snmp_counter.rst | 4 ++-- Documentation/powerpc/ultravisor.rst | 4 ++-- Documentation/security/siphash.rst | 8 ++++---- Documentation/target/tcmu-design.rst | 6 +++--- .../translations/zh_CN/process/5.Posting.rst | 2 +- Documentation/x86/intel-iommu.rst | 3 ++- 12 files changed, 35 insertions(+), 31 deletions(-)
Signature · 1 line
2.24.1