Re: [PATCH 1/6] net: page_pool: Add alloc stats and fast path stat

[Joe Damato <jdamato@fastly.com>]

On Thu, Jan 27, 2022 at 8:32 AM Jakub Kicinski <kuba@kernel.org> wrote:
>
> On Wed, 26 Jan 2022 14:48:15 -0800 Joe Damato wrote:
> > Add a stats structure with a an internal alloc structure for holding
> > allocation path related stats.
> >
> > The alloc structure contains the stat 'fast'. This stat tracks fast
> > path allocations.
> >
> > A static inline accessor function is exposed for accessing this stat.
>
> > +/**
> > + * stats for tracking page_pool events.
> > + *
> > + * accessor functions for these stats provided below.
> > + *
> > + * Note that it is the responsibility of the API consumer to ensure that
> > + * the page_pool has not been destroyed while accessing stats fields.
> > + */
> > +struct page_pool_stats {
> > +     struct {
> > +             u64 fast; /* fast path allocations */
> > +     } alloc;
> > +};
>
> scripts/kernel-doc says:
>
> include/net/page_pool.h:75: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * stats for tracking page_pool events.

Thank you. I had only been running scripts/checkpatch, but will
remember to also run kernel-doc in the future. I will correct the
comments in the v2.