netdev - Re: [PATCH net-next] net: Reorganize networking documentation toctree

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: <20251030182251.60e01849@kernel.org>
Date: Thu, 30 Oct 2025 18:22:51 -0700
From: Jakub Kicinski <kuba@...nel.org>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>, Linux
 Documentation <linux-doc@...r.kernel.org>, Linux Networking
 <netdev@...r.kernel.org>, Linux BPF <bpf@...r.kernel.org>, "David S.
 Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, Paolo
 Abeni <pabeni@...hat.com>, Simon Horman <horms@...nel.org>, Jonathan Corbet
 <corbet@....net>, Alexei Starovoitov <ast@...nel.org>, Daniel Borkmann
 <daniel@...earbox.net>, Jesper Dangaard Brouer <hawk@...nel.org>, John
 Fastabend <john.fastabend@...il.com>, Stanislav Fomichev <sdf@...ichev.me>
Subject: Re: [PATCH net-next] net: Reorganize networking documentation
 toctree

On Fri, 31 Oct 2025 08:11:44 +0700 Bagas Sanjaya wrote:
> On Thu, Oct 30, 2025 at 05:50:18PM -0700, Jakub Kicinski wrote:
> > On Tue, 28 Oct 2025 18:39:24 +0700 Bagas Sanjaya wrote:  
> > > Current netdev docs has one large, unorganized toctree that makes
> > > finding relevant docs harder like a needle in a haystack. Split the
> > > toctree into four categories: networking core; protocols; devices; and
> > > assorted miscellaneous.
> > > 
> > > While at it, also sort the toctree entries and reduce toctree depth.  
> > 
> > Looking at the outcome -- I'm not sure we're achieving sufficient
> > categorization here. It's a hard problem to group these things.
> > What ends up under Networking devices and Miscellaneous seems
> > pretty random. Bunch of the entries under there should be in protocols
> > or core. And at the end of the day if we don't have a very intuitive
> > categorization the reader has to search anyway. So no point..  
> 
> Do you have any categorization suggestions then?

No.