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:   Mon, 26 Oct 2020 09:10:59 +0100
From:   Peter Zijlstra <peterz@infradead.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc:     Jonathan Corbet <corbet@lwn.net>,
        Kees Cook <keescook@chromium.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: <20201026081059.GB2628@hirez.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>
 <20201023134757.628f91b7@lwn.net>
 <20201024082827.08ad3010@coco.lan>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20201024082827.08ad3010@coco.lan>
Precedence: bulk

On Sat, Oct 24, 2020 at 08:28:27AM +0200, Mauro Carvalho Chehab wrote:
> If the intent is to document the struct and its internal fields,
> this kernel-doc should work:
> 
> 	/**
> 	 * struct refcount_struct - variant of atomic_t specialized for reference counts
> 	 * @refs: atomic_t counter field
> 	 *
> 	 * The counter saturates at REFCOUNT_SATURATED and will not move once
> 	 * there. This avoids wrapping the counter and causing 'spurious'
> 	 * use-after-free bugs.
> 	 */
> 
> Which produces this result:

Who cares... :-(

> If you want both, then you would either split struct and typedef, e. g.
> with something like:
> 
> 	/**
> 	 * struct refcount_struct - variant of atomic_t specialized for reference counts
> 	 * @refs: atomic_t counter field
> 	 *
> 	 * The counter saturates at REFCOUNT_SATURATED and will not move once
> 	 * there. This avoids wrapping the counter and causing 'spurious'
> 	 * use-after-free bugs.
> 	 */
> 	struct refcount_struct {
> 	        atomic_t refs;
> 	};
> 
> 	/**
> 	 * typedef refcount_t - variant of atomic_t specialized for reference counts
> 	 * @refs: atomic_t counter field
> 	 *
> 	 * The counter saturates at REFCOUNT_SATURATED and will not move once
> 	 * there. This avoids wrapping the counter and causing 'spurious'
> 	 * use-after-free bugs.
> 	 */
> 	typedef struct refcount_struct refcount_t;
> 
> Or, you could add the member at the description field. E. g. something
> like this:
> 
> 	/**
> 	 * typedef refcount_t - variant of atomic_t specialized for reference counts
> 	 *
> 	 * The counter saturates at REFCOUNT_SATURATED and will not move once
> 	 * there. This avoids wrapping the counter and causing 'spurious'
> 	 * use-after-free bugs.
> 	 *
> 	 * Members:
> 	 *   ``refs``
> 	 *        atomic_t counter field
> 	 */
> 	typedef struct refcount_struct {
> 	        atomic_t refs;
> 	} refcount_t;
> 
> If you want to test it, you can run kernel-doc directly, to see how
> it will parse it. For ReST output, that's the syntax:
> 
> 	./scripts/kernel-doc --sphinx-version 3 include/linux/refcount.h

I'll just go ahead and remove the superfluous * from the comment... It's
trivially clear what is meant. If the stupid tool can't deal with that,
I don't care.

All this wanking about docs and making perfectly fine comments bloody
unreadable shit has to stop.