netdev - Re: [PATCH] Documentation: networking: add a chapter for the DIM library

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 10 Oct 2019 16:58:28 -0700
From:   Jakub Kicinski <jakub.kicinski@...ronome.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        "linux-rdma@...r.kernel.org" <linux-rdma@...r.kernel.org>,
        Tal Gilboa <talgi@...lanox.com>,
        David Miller <davem@...emloft.net>, linux-doc@...r.kernel.org,
        Jacob Keller <jacob.e.keller@...el.com>
Subject: Re: [PATCH] Documentation: networking: add a chapter for the DIM
 library

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@...radead.org>
> >>
> >> Add a Documentation networking chapter for the DIM library.
> >>
> >> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> >> Cc: Tal Gilboa <talgi@...lanox.com>
> >> Cc: "David S. Miller" <davem@...emloft.net>
> >> Cc: Jakub Kicinski <jakub.kicinski@...ronome.com>
> >> Cc: netdev@...r.kernel.org
> >> Cc: linux-rdma@...r.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?