linux-kernel - Re: [PATCH 5/6] scripts: kernel-doc: add support for typedef enum

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20201003092423.58e25910@coco.lan>
Date:   Sat, 3 Oct 2020 09:24:23 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Andrew Lunn <andrew@...n.ch>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        "David S. Miller" <davem@...emloft.net>,
        Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 5/6] scripts: kernel-doc: add support for typedef enum

Hi Andrew,

Em Fri, 2 Oct 2020 14:07:28 +0200
Andrew Lunn <andrew@...n.ch> escreveu:

> On Fri, Oct 02, 2020 at 07:49:49AM +0200, Mauro Carvalho Chehab wrote:
> > The PHY kernel-doc markup has gained support for documenting
> > a typedef enum.
> > 
> > However, right now the parser was not prepared for it.  
> 
> Hi Mauro
> 
> Thanks for this. I'm using Sphinx 3.2.1, since that is what my Debian
> box has. So it can be hard to see the new warnings amongst the old.

Yeah, there were simply too much warnings with docs, and 3.2.1 is
even worse.

Things will improve a lot after merging my set of patches fixing
the issues for it. Yet, there are some warnings that can't currently
be fixed on Sphinx 3.2 (~10 warnings). Fixing those will require
some internal changes in Sphinx itself.

So, except if you need Sphinx 3 for some reason, I would suggest you
to uninstall it, and then use venv with Sphinx 2.4.4. The Kernel build
system should be able to provide you the commands for installing it,
once you remove the one from your PATH.

> Will this patch get merged via Jonathan Corbet's tree?

Yes, that's the plan.

Thanks,
Mauro