| Message ID | e9345b39-352e-cfc6-7359-9b681cb760e8@infradead.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | Documentation: networking: add a chapter for the DIM library | expand |
On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote: > From: Randy Dunlap <rdunlap@infradead.org> > > Add a Documentation networking chapter for the DIM library. > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Tal Gilboa <talgi@mellanox.com> > Cc: "David S. Miller" <davem@davemloft.net> > Cc: Jakub Kicinski <jakub.kicinski@netronome.com> > Cc: netdev@vger.kernel.org > Cc: linux-rdma@vger.kernel.org > --- > Documentation/networking/index.rst | 1 + > Documentation/networking/lib-dim.rst | 6 ++++++ > 2 files changed, 7 insertions(+) > > --- linux-next-20191010.orig/Documentation/networking/index.rst > +++ linux-next-20191010/Documentation/networking/index.rst > @@ -33,6 +33,7 @@ Contents: > scaling > tls > tls-offload > + lib-dim > > .. only:: subproject and html > > --- /dev/null > +++ linux-next-20191010/Documentation/networking/lib-dim.rst > @@ -0,0 +1,6 @@ > +===================================================== > +Dynamic Interrupt Moderation (DIM) library interfaces > +===================================================== > + > +.. kernel-doc:: include/linux/dim.h > + :internal: > > CC: linux-doc, Jake How does this relate to Documentation/networking/net_dim.txt ? (note in case you want to edit that one there is a patch with updates for that file from Jake I'll be applying shortly)
On 10/10/19 4:20 PM, Jakub Kicinski wrote: > On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote: >> From: Randy Dunlap <rdunlap@infradead.org> >> >> Add a Documentation networking chapter for the DIM library. >> >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> >> Cc: Tal Gilboa <talgi@mellanox.com> >> Cc: "David S. Miller" <davem@davemloft.net> >> Cc: Jakub Kicinski <jakub.kicinski@netronome.com> >> Cc: netdev@vger.kernel.org >> Cc: linux-rdma@vger.kernel.org >> --- >> Documentation/networking/index.rst | 1 + >> Documentation/networking/lib-dim.rst | 6 ++++++ >> 2 files changed, 7 insertions(+) >> >> --- linux-next-20191010.orig/Documentation/networking/index.rst >> +++ linux-next-20191010/Documentation/networking/index.rst >> @@ -33,6 +33,7 @@ Contents: >> scaling >> tls >> tls-offload >> + lib-dim >> >> .. only:: subproject and html >> >> --- /dev/null >> +++ linux-next-20191010/Documentation/networking/lib-dim.rst >> @@ -0,0 +1,6 @@ >> +===================================================== >> +Dynamic Interrupt Moderation (DIM) library interfaces >> +===================================================== >> + >> +.. kernel-doc:: include/linux/dim.h >> + :internal: >> >> > > CC: linux-doc, Jake > > How does this relate to Documentation/networking/net_dim.txt ? > (note in case you want to edit that one there is a patch with > updates for that file from Jake I'll be applying shortly) > There is also a small patch from Jesse: https://lore.kernel.org/netdev/20191010193112.15215-1-jesse.brandeburg@intel.com/
On Thu, 10 Oct 2019 16:34:59 -0700, Randy Dunlap wrote: > On 10/10/19 4:20 PM, Jakub Kicinski wrote: > > On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote: > >> From: Randy Dunlap <rdunlap@infradead.org> > >> > >> Add a Documentation networking chapter for the DIM library. > >> > >> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > >> Cc: Tal Gilboa <talgi@mellanox.com> > >> Cc: "David S. Miller" <davem@davemloft.net> > >> Cc: Jakub Kicinski <jakub.kicinski@netronome.com> > >> Cc: netdev@vger.kernel.org > >> Cc: linux-rdma@vger.kernel.org > >> --- > >> Documentation/networking/index.rst | 1 + > >> Documentation/networking/lib-dim.rst | 6 ++++++ > >> 2 files changed, 7 insertions(+) > >> > >> --- linux-next-20191010.orig/Documentation/networking/index.rst > >> +++ linux-next-20191010/Documentation/networking/index.rst > >> @@ -33,6 +33,7 @@ Contents: > >> scaling > >> tls > >> tls-offload > >> + lib-dim > >> > >> .. only:: subproject and html > >> > >> --- /dev/null > >> +++ linux-next-20191010/Documentation/networking/lib-dim.rst > >> @@ -0,0 +1,6 @@ > >> +===================================================== > >> +Dynamic Interrupt Moderation (DIM) library interfaces > >> +===================================================== > >> + > >> +.. kernel-doc:: include/linux/dim.h > >> + :internal: > >> > >> > > > > CC: linux-doc, Jake > > > > How does this relate to Documentation/networking/net_dim.txt ? > > (note in case you want to edit that one there is a patch with > > updates for that file from Jake I'll be applying shortly) Applied now. > There is also a small patch from Jesse: > https://lore.kernel.org/netdev/20191010193112.15215-1-jesse.brandeburg@intel.com/ Ack, as Jake said this duplicates part of what his patch covered, tho. Will you try to convert and integrate the existing file instead, or do you think the kdoc file should be separate?
On 10/10/19 4:58 PM, Jakub Kicinski wrote: > On Thu, 10 Oct 2019 16:34:59 -0700, Randy Dunlap wrote: >> On 10/10/19 4:20 PM, Jakub Kicinski wrote: >>> On Thu, 10 Oct 2019 15:55:15 -0700, Randy Dunlap wrote: >>>> From: Randy Dunlap <rdunlap@infradead.org> >>>> >>>> Add a Documentation networking chapter for the DIM library. >>>> >>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org> >>>> Cc: Tal Gilboa <talgi@mellanox.com> >>>> Cc: "David S. Miller" <davem@davemloft.net> >>>> Cc: Jakub Kicinski <jakub.kicinski@netronome.com> >>>> Cc: netdev@vger.kernel.org >>>> Cc: linux-rdma@vger.kernel.org >>>> --- >>>> Documentation/networking/index.rst | 1 + >>>> Documentation/networking/lib-dim.rst | 6 ++++++ >>>> 2 files changed, 7 insertions(+) >>>> >>>> --- linux-next-20191010.orig/Documentation/networking/index.rst >>>> +++ linux-next-20191010/Documentation/networking/index.rst >>>> @@ -33,6 +33,7 @@ Contents: >>>> scaling >>>> tls >>>> tls-offload >>>> + lib-dim >>>> >>>> .. only:: subproject and html >>>> >>>> --- /dev/null >>>> +++ linux-next-20191010/Documentation/networking/lib-dim.rst >>>> @@ -0,0 +1,6 @@ >>>> +===================================================== >>>> +Dynamic Interrupt Moderation (DIM) library interfaces >>>> +===================================================== >>>> + >>>> +.. kernel-doc:: include/linux/dim.h >>>> + :internal: >>>> >>>> >>> >>> CC: linux-doc, Jake >>> >>> How does this relate to Documentation/networking/net_dim.txt ? >>> (note in case you want to edit that one there is a patch with >>> updates for that file from Jake I'll be applying shortly) > > Applied now. > >> There is also a small patch from Jesse: >> https://lore.kernel.org/netdev/20191010193112.15215-1-jesse.brandeburg@intel.com/ > > Ack, as Jake said this duplicates part of what his patch covered, tho. Yes, so I noticed. > Will you try to convert and integrate the existing file instead, or do > you think the kdoc file should be separate? I'll take a look at doing that. thanks.
On Thu, 10 Oct 2019 17:01:02 -0700, Randy Dunlap wrote: > > Will you try to convert and integrate the existing file instead, or do > > you think the kdoc file should be separate? > > I'll take a look at doing that. Thanks!
--- linux-next-20191010.orig/Documentation/networking/index.rst +++ linux-next-20191010/Documentation/networking/index.rst @@ -33,6 +33,7 @@ Contents: scaling tls tls-offload + lib-dim .. only:: subproject and html --- /dev/null +++ linux-next-20191010/Documentation/networking/lib-dim.rst @@ -0,0 +1,6 @@ +===================================================== +Dynamic Interrupt Moderation (DIM) library interfaces +===================================================== + +.. kernel-doc:: include/linux/dim.h + :internal: