netdev - RE: [RFC 1/8] docs: networking: reorganize driver documentation again

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]

Message-ID: <61CC2BC414934749BD9F5BF3D5D94044986F531D@ORSMSX112.amr.corp.intel.com>
Date:   Thu, 11 Jun 2020 23:43:33 +0000
From:   "Kirsher, Jeffrey T" <jeffrey.t.kirsher@...el.com>
To:     Jakub Kicinski <kuba@...nel.org>,
        Stephen Hemminger <stephen@...workplumber.org>
CC:     "davem@...emloft.net" <davem@...emloft.net>,
        "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        "klassert@...nel.org" <klassert@...nel.org>,
        "akiyano@...zon.com" <akiyano@...zon.com>,
        "irusskikh@...vell.com" <irusskikh@...vell.com>,
        "ioana.ciornei@....com" <ioana.ciornei@....com>,
        "kys@...rosoft.com" <kys@...rosoft.com>,
        "saeedm@...lanox.com" <saeedm@...lanox.com>,
        "jdmason@...zu.us" <jdmason@...zu.us>,
        "snelson@...sando.io" <snelson@...sando.io>,
        "GR-Linux-NIC-Dev@...vell.com" <GR-Linux-NIC-Dev@...vell.com>,
        "stuyoder@...il.com" <stuyoder@...il.com>,
        "sgoutham@...vell.com" <sgoutham@...vell.com>,
        "luobin9@...wei.com" <luobin9@...wei.com>,
        "csully@...gle.com" <csully@...gle.com>,
        "kou.ishizaki@...hiba.co.jp" <kou.ishizaki@...hiba.co.jp>,
        "peppe.cavallaro@...com" <peppe.cavallaro@...com>,
        "chessman@....org" <chessman@....org>
Subject: RE: [RFC 1/8] docs: networking: reorganize driver documentation
 again

> -----Original Message-----
> From: Jakub Kicinski <kuba@...nel.org>
> Sent: Thursday, June 11, 2020 16:09
> To: Stephen Hemminger <stephen@...workplumber.org>
> Cc: Kirsher, Jeffrey T <jeffrey.t.kirsher@...el.com>; davem@...emloft.net;
> netdev@...r.kernel.org; linux-doc@...r.kernel.org; klassert@...nel.org;
> akiyano@...zon.com; irusskikh@...vell.com; ioana.ciornei@....com;
> kys@...rosoft.com; saeedm@...lanox.com; jdmason@...zu.us;
> snelson@...sando.io; GR-Linux-NIC-Dev@...vell.com; stuyoder@...il.com;
> sgoutham@...vell.com; luobin9@...wei.com; csully@...gle.com;
> kou.ishizaki@...hiba.co.jp; peppe.cavallaro@...com; chessman@....org
> Subject: Re: [RFC 1/8] docs: networking: reorganize driver documentation again
> 
> On Thu, 11 Jun 2020 15:18:42 -0700 Stephen Hemminger wrote:
> > > > Organize driver documentation by device type. Most documents have
> > > > fairly verbose yet uninformative names, so let users first select
> > > > a well defined device type, and then search for a particular
> > > > driver.
> > > >
> > > > While at it rename the section from Vendor drivers to Hardware
> > > > drivers. This seems more accurate, besides people sometimes refer
> > > > to out-of-tree drivers as vendor drivers.
> > > >
> > > > Signed-off-by: Jakub Kicinski <kuba@...nel.org>
> >
> > How much of it is still relevant and useful?
> >
> > The last time I checked, lots of this had bad advice about settings.
> > And there was lots of drivers documenting what was generic Linux
> > functionality
> >
> > And still there were references to old commands like ifconfig or ifenslave.
> 
> For general documentation I hope now that it's slightly de-cluttered it's more
> likely folks (including myself, time allowing) will be more inclined to clean up /
> contribute. I haven't looked in detail, yet.
[Kirsher, Jeffrey T] 

I agree, I have been meaning to "organize" the networking documentation for the last year, but was not finding the time.  So thank you!  This will also make it easier to review and update the current documentation.

> 
> As for the vendor docs - I guess that the obsolescence of the docs/ instructions
> goes hand in hand with obsolescence of the HW itself.