Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Fri, 23 Oct 2020 13:47:57 -0600
From:   Jonathan Corbet <corbet@lwn.net>
To:     Peter Zijlstra <peterz@infradead.org>
Cc:     Kees Cook <keescook@chromium.org>,
        Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Ard Biesheuvel <ardb@kernel.org>,
        Ingo Molnar <mingo@kernel.org>, Jann Horn <jannh@google.com>,
        Will Deacon <will@kernel.org>, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 49/56] refcount.h: fix a kernel-doc markup
Message-ID: <20201023134757.628f91b7@lwn.net>
In-Reply-To: <20201023193907.GI2974@worktop.programming.kicks-ass.net>
References: <cover.1603469755.git.mchehab+huawei@kernel.org>
        <fd94a95cfe01b97190b6ffb9e942cb4bbeeaa6bf.1603469755.git.mchehab+huawei@kernel.org>
        <202010231039.DE05B63@keescook>
        <20201023193907.GI2974@worktop.programming.kicks-ass.net>
Organization: LWN.net
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit
Precedence: bulk

On Fri, 23 Oct 2020 21:39:07 +0200
Peter Zijlstra <peterz@infradead.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