Re: [PATCH v2 0/2] Don't generate thousands of new warnings when building docs

From
Jani Nikula <jani.nikula@linux.intel.com>
Date
2020-04-16 10:06:13
Also in
dmaengine, linux-doc, linux-scsi, linuxppc-dev, lkml, target-devel
Reply to
Jonathan Corbet, 2020-03-20
On Fri, 20 Mar 2020, Jonathan Corbet [off-list ref] wrote:
On Fri, 20 Mar 2020 16:11:01 +0100
Mauro Carvalho Chehab [off-list ref] wrote:
quoted
This small series address a regression caused by a new patch at
docs-next (and at linux-next).
I don't know how I missed that mess, sorry.  I plead distracting times or
something like that.  Heck, I think I'll blame everything on the plague
for at least the next few weeks.

Anyway, I've applied this, thanks for cleaning it up.
There's still more fallout from the autosectionlabel extension
introduced in 58ad30cf91f0 ("docs: fix reference to
core-api/namespaces.rst"), e.g. in i915.rst.

The biggest trouble is, if you have headings in kernel-doc comments,
Sphinx is unable pinpoint where the dupes are. For example:

 Documentation/gpu/i915.rst:610: WARNING: duplicate label gpu/i915:layout, other instance in
 Documentation/gpu/i915.rst

However there is no "layout" label in i915.rst. The one being warned
about I can dig into based on the line number, but not the second
one. You have to resort to grepping the source. And avoiding duplicate
subsection headings in completely isolated places is a minefield.

BR,
Jani.


-- 
Jani Nikula, Intel Open Source Graphics Center
Thread (6 messages) 6 messages, 4 authors, last reply 2020-04-16
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help