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

Kees Cook
2020-10-23T17:40:15Z

On Fri, Oct 23, 2020 at 06:33:36PM +0200, Mauro Carvalho Chehab wrote:
> The documented typedef just after the kernel-doc markup
> is named "refcount_struct".
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> include/linux/refcount.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/refcount.h b/include/linux/refcount.h
> index 497990c69b0b..8f431b0e69e4 100644
> --- a/include/linux/refcount.h
> +++ b/include/linux/refcount.h
> @@ -101,7 +101,7 @@
> struct mutex;
>
> /**
> - * 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.

-Kees

> * @refs: atomic_t counter field
> *
> * The counter saturates at REFCOUNT_SATURATED and will not move once
> --
> 2.26.2
>

--
Kees Cook