RE: [RFC 1/8] docs: networking: reorganize driver documentation again
From: Kirsher, Jeffrey T <hidden>
Date: 2020-06-11 23:43:46
Also in:
linux-doc
-----Original Message----- From: Jakub Kicinski <kuba@kernel.org> Sent: Thursday, June 11, 2020 16:09 To: Stephen Hemminger <stephen@networkplumber.org> Cc: Kirsher, Jeffrey T <redacted>; davem@davemloft.net; netdev@vger.kernel.org; linux-doc@vger.kernel.org; klassert@kernel.org; akiyano@amazon.com; irusskikh@marvell.com; ioana.ciornei@nxp.com; kys@microsoft.com; saeedm@mellanox.com; jdmason@kudzu.us; snelson@pensando.io; GR-Linux-NIC-Dev@marvell.com; stuyoder@gmail.com; sgoutham@marvell.com; luobin9@huawei.com; csully@google.com; kou.ishizaki@toshiba.co.jp; peppe.cavallaro@st.com; chessman@tux.org Subject: Re: [RFC 1/8] docs: networking: reorganize driver documentation again On Thu, 11 Jun 2020 15:18:42 -0700 Stephen Hemminger wrote:quoted
quoted
quoted
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@kernel.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.