netdev - Re: [PATCH net-next V1] net: adjust net_device layout for cacheline usage

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] [day] [month] [year] [list]

Message-ID: <20210212165732.77a34579@carbon>
Date:   Fri, 12 Feb 2021 16:57:32 +0100
From:   Jesper Dangaard Brouer <brouer@...hat.com>
To:     Jakub Kicinski <kuba@...nel.org>
Cc:     Eric Dumazet <eric.dumazet@...il.com>,
        David Ahern <dsahern@...il.com>, netdev@...r.kernel.org,
        "David S. Miller" <davem@...emloft.net>, bpf@...r.kernel.org,
        Daniel Borkmann <borkmann@...earbox.net>,
        Alexei Starovoitov <alexei.starovoitov@...il.com>,
        brouer@...hat.com
Subject: Re: [PATCH net-next V1] net: adjust net_device layout for cacheline
 usage

On Fri, 29 Jan 2021 12:07:23 -0800
Jakub Kicinski <kuba@...nel.org> wrote:

> On Fri, 29 Jan 2021 20:47:41 +0100 Eric Dumazet wrote:
> > On 1/29/21 8:35 PM, Jakub Kicinski wrote:
> >   
> > > kdoc didn't complain, and as you say it's already a mess, plus it's
> > > two screen-fulls of scrolling away... 
> > > 
> > > I think converting to inline kdoc of members would be an improvement,
> > > if you want to sign up for that? Otherwise -EDIDNTCARE on my side :)
> > >     
> > 
> > What about removing this kdoc ?
> > 
> > kdoc for a huge structure is mostly useless...  
> 
> It's definitely not useful for "us", I'd guess most seasoned developers
> will just grep for uses of the field - but maybe it is useful for noobs
> trying to have high-level sense of the code? 
> 
> Either way is fine by me, we can always preserve meaningful comments
> inline without the kdoc decorator.

I agree that removing this kdoc makes sense. But as Jakub says we
should preserve meaningful comments inline.  I'll add this task to my
TODO list, but anyone feel free to do the work before I get around to it.

-- 
Best regards,
  Jesper Dangaard Brouer
  MSc.CS, Principal Kernel Engineer at Red Hat
  LinkedIn: http://www.linkedin.com/in/brouer