linux-kernel - Re: [PATCH v3 49/56] refcount.h: fix a kernel-doc markup

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: <20201023134757.628f91b7@lwn.net>
Date:   Fri, 23 Oct 2020 13:47:57 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Peter Zijlstra <peterz@...radead.org>
Cc:     Kees Cook <keescook@...omium.org>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Ard Biesheuvel <ardb@...nel.org>,
        Ingo Molnar <mingo@...nel.org>, Jann Horn <jannh@...gle.com>,
        Will Deacon <will@...nel.org>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 49/56] refcount.h: fix a kernel-doc markup

On Fri, 23 Oct 2020 21:39:07 +0200
Peter Zijlstra <peterz@...radead.org> wrote:

> > >  /**
> > > - * struct refcount_t - variant of atomic_t specialized for reference counts
> > > + * struct refcount_struct - variant of atomic_t specialized for reference counts  
> > 
> > Hm, this is a weird one. Yes, it's actually "struct refcount_struct",
> > but the usage should be refcount_t (through the typedef). I'm not sure
> > what the right way to document this is.  
> 
> Yeah, this is wrong. If this is due to a kernel doc warning, the kernel
> doc machinery is wrong *again*.

...except that, since refcount_t is a typedef, "struct refcount_t" doesn't
actually exist.  Whether it works properly after doing s/struct// remains
to be seen...

jon