linux-kernel - confusing changes in the documentation table of contents

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

Message-ID: <CADDUTFyArtN--_27xLWpqnBM2e_udmL+E6Ka7KgimTUOguWthg@mail.gmail.com>
Date:   Mon, 17 Jul 2023 08:12:27 +0300
From:   Costa Shulyupin <costa.shul@...hat.com>
To:     linux-doc@...r.kernel.org, kernelnewbies@...nelnewbies.org,
        Jonathan Corbet <corbet@....net>
Cc:     open list <linux-kernel@...r.kernel.org>
Subject: confusing changes in the documentation table of contents

Hi,

In https://www.kernel.org/doc/html/v6.2/ Table of Contents consisted
of 10 items. It was compact, organized and observable:

The Linux Kernel documentation
- Working with the development community
- Internal API manuals
- Development tools and processes
- User-oriented documentation
- Firmware-related documentation
- Architecture-specific documentation
- Other documentation
- Translations
Indices and tables

Since  https://www.kernel.org/doc/html/v6.3/ it consists of 60+ items.
Now it is long, unorganized and unobservable:

A guide to the Kernel Development Process
Submitting patches: the essential guide to getting your code into the kernel
Code of conduct
Kernel Maintainer Handbook
All development-process docs

Linux kernel licensing rules
HOWTO do Linux kernel development
Contributor Covenant Code of Conduct
Linux Kernel Contributor Covenant Code of Conduct Interpretation
A guide to the Kernel Development Process
Submitting patches: the essential guide to getting your code into the kernel
Handling regressions
Programming Language
Linux kernel coding style
Subsystem and maintainer tree specific development process notes
Kernel Maintainer PGP guide
Email clients info for Linux
Linux Kernel Enforcement Statement
Kernel Driver Statement
Security bugs
Embargoed hardware issues
Minimal requirements to compile the Kernel
The Linux Kernel Driver Interface
Linux kernel management style
Everything you ever wanted to know about Linux -stable releases
Linux Kernel patch submission checklist
Index of Further Kernel Documentation
Deprecated Interfaces, Language Features, Attributes, and Conventions
List of maintainers and how to submit kernel changes
Researcher Guidelines
Applying Patches To The Linux Kernel
Adding a New System Call
Linux magic numbers
Why the “volatile” type class should not be used
(How to avoid) Botching up ioctls
clang-format
arch/riscv maintenance guidelines for developers
Unaligned Memory Accesses

Core API Documentation
Driver implementer’s API guide
Kernel subsystem documentation
Locking in the kernel

Linux kernel licensing rules
How to write kernel documentation
Development tools for the kernel
Kernel Testing Guide
Kernel Hacking Guides
Linux Tracing Technologies
fault-injection
Kernel Livepatching
Rust

The Linux kernel user’s and administrator’s guide
The kernel build system
Reporting issues
User-space tools
The Linux kernel user-space API guide

The Linux kernel firmware guide
Open Firmware and Devicetree

CPU Architectures

Unsorted Documentation

Questions:
- Why?
- What are further plans?
- What to do?

Thanks,
Costa