Re: [PATCH net-next v2 6/6] docs: networking: Describe irq suspension

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 2002 bytes --]

On Mon, Oct 21, 2024 at 09:33:21AM -0700, Joe Damato wrote:
> On Mon, Oct 21, 2024 at 05:49:14PM +0700, Bagas Sanjaya wrote:
> > On Mon, Oct 21, 2024 at 01:53:01AM +0000, Joe Damato wrote:
> > > diff --git a/Documentation/networking/napi.rst b/Documentation/networking/napi.rst
> > > index dfa5d549be9c..3b43477a52ce 100644
> > > --- a/Documentation/networking/napi.rst
> > > +++ b/Documentation/networking/napi.rst
> > > @@ -192,6 +192,28 @@ is reused to control the delay of the timer, while
> > >  ``napi_defer_hard_irqs`` controls the number of consecutive empty polls
> > >  before NAPI gives up and goes back to using hardware IRQs.
> > >  
> > > +The above parameters can also be set on a per-NAPI basis using netlink via
> > > +netdev-genl. This can be done programmatically in a user application or by
> > > +using a script included in the kernel source tree: ``tools/net/ynl/cli.py``.
> > > +
> > > +For example, using the script:
> > > +
> > > +.. code-block:: bash
> > > +
> > > +  $ kernel-source/tools/net/ynl/cli.py \
> > > +            --spec Documentation/netlink/specs/netdev.yaml \
> > > +            --do napi-set \
> > > +            --json='{"id": 345,
> > > +                     "defer-hard-irqs": 111,
> > > +                     "gro-flush-timeout": 11111}'
> > > +
> > > +Similarly, the parameter ``irq-suspend-timeout`` can be set using netlink
> > > +via netdev-genl. There is no global sysfs parameter for this value.
> > 
> > In JSON, both gro-flush-timeout and irq-suspend-timeout parameter
> > names are written in hyphens; but the rest of the docs uses underscores
> > (that is, gro_flush_timeout and irq_suspend_timeout), right?
> 
> That's right. The YAML specification uses hyphens throughout, so we
> follow that convention there.
> 
> In the rest of the docs we use the name of the field which appears
> in the code itself, which uses underscores.

OK, thanks!

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]