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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87a73b4ufg.fsf@intel.com>
Date:   Thu, 16 Apr 2020 13:05:39 +0300
From:   Jani Nikula <jani.nikula@...ux.intel.com>
To:     Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org,
        "Martin K. Petersen" <martin.petersen@...cle.com>,
        Paul Mackerras <paulus@...ba.org>,
        Madhuparna Bhowmik <madhuparnabhowmik04@...il.com>,
        "David S. Miller" <davem@...emloft.net>,
        Ricardo Ribalda Delgado <ribalda@...nel.org>,
        Luca Ceresoli <luca@...aceresoli.net>,
        dmaengine@...r.kernel.org, Matthias Maennich <maennich@...gle.com>,
        Harry Wei <harryxiyou@...il.com>, x86@...nel.org,
        ecryptfs@...r.kernel.org, Jakub Kicinski <kuba@...nel.org>,
        target-devel@...r.kernel.org, "H. Peter Anvin" <hpa@...or.com>,
        Hans Verkuil <hverkuil-cisco@...all.nl>,
        Benjamin Herrenschmidt <benh@...nel.crashing.org>,
        Johannes Berg <johannes.berg@...el.com>,
        Jacopo Mondi <jacopo@...ndi.org>,
        Tyler Hicks <code@...icks.com>, Vinod Koul <vkoul@...nel.org>,
        Alex Shi <alex.shi@...ux.alibaba.com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, linux-scsi@...r.kernel.org,
        Michael Ellerman <mpe@...erman.id.au>, netdev@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linuxppc-dev@...ts.ozlabs.org, Borislav Petkov <bp@...en8.de>
Subject: Re: [PATCH v2 0/2] Don't generate thousands of new warnings when building docs

On Fri, 20 Mar 2020, Jonathan Corbet <corbet@....net> wrote:
> On Fri, 20 Mar 2020 16:11:01 +0100
> Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:
>
>> 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