On Fri, 21 Nov 2025 13:00:09 -0500 Sasha Levin <[email protected]> wrote:
> Reorganize README to provide targeted documentation paths for different user > roles including developers, researchers, security experts, and maintainers. > > Add quick start section and essential docs links. > > Signed-off-by: Sasha Levin <[email protected]> > Reviewed-by: Randy Dunlap <[email protected]> > Reviewed-by: Mauro Carvalho Chehab <[email protected]> > Reviewed-by: Kees Cook <[email protected]> Reviewed-by: SeongJae Park <[email protected]> > --- > > Changes since v4: > > - Remove explicit reference to GPLv2 > - Fix up the commit message to drop AI blurb > > README | 160 +++++++++++++++++++++++++++++++++++++++++++++++++++++---- > 1 file changed, 149 insertions(+), 11 deletions(-) > > diff --git a/README b/README > index fd903645e6de0..1fc993d7cf07e 100644 > --- a/README > +++ b/README > @@ -1,18 +1,156 @@ [...] > +Documentation can be built with make htmldocs or viewed online at: > +https://www.kernel.org/doc/html/latest/ > + > + > +Who Are You? > +============ > + > +Find your role below: > + > +* New Kernel Developer - Getting started with kernel development > +* Academic Researcher - Studying kernel internals and architecture > +* Security Expert - Hardening and vulnerability analysis > +* Backport/Maintenance Engineer - Maintaining stable kernels > +* System Administrator - Configuring and troubleshooting > +* Maintainer - Leading subsystems and reviewing patches > +* Hardware Vendor - Writing drivers for new hardware > +* Distribution Maintainer - Packaging kernels for distros > + > + > +For Specific Users > +================== > + > +New Kernel Developer > +-------------------- [...] > +Distribution Maintainer > +----------------------- > + > +Package and distribute the kernel: > + > +* Stable Kernel Rules: Documentation/process/stable-kernel-rules.rst > +* ABI Documentation: Documentation/ABI/README > +* Kernel Configuration: Documentation/kbuild/kconfig.rst > +* Module Signing: Documentation/admin-guide/module-signing.rst > +* Kernel Parameters: Documentation/admin-guide/kernel-parameters.rst > +* Tainted Kernels: Documentation/admin-guide/tainted-kernels.rst > + > + > + > +Communication and Support > +========================= Nit. Having only two blank lines above this section would make this document look more consistent. Thanks, SJ [...]
