linux-kernel - Re: confusing documentation about Development Process

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

Message-ID: <d7495c1c-4931-2056-90f9-56080adaf2d5@infradead.org>
Date:   Sat, 6 May 2023 20:55:52 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Costa Shulyupin <costa.shul@...hat.com>, linux-doc@...r.kernel.org,
        Jonathan Corbet <corbet@....net>
Cc:     open list <linux-kernel@...r.kernel.org>
Subject: Re: confusing documentation about Development Process

Hi Costa,

On 5/4/23 22:39, Costa Shulyupin wrote:
> There are five topics named "Development Process" or "Working with the
> development community" or both.
> 
> It is clear that these topics are related to the development. Some
> content is overlapping.
> 
> Questions:
> - Is it by design or chance?

Chance. (I would probably call it evolution.)

> - What are the principal differences between the topics?

Some of these are much older than others, so I would say that
currency (being current) is the biggest difference in them.
And also the level of detail that is attempted in each of them.

> - Are there any outdated documents?

Probably. We aren't very good at removing documents from the kernel tree
unless a complete driver or subsystem or architecture or platform is
removed.

> - How should it be?

Good question and a fair one too. We (mostly Jon) are attempting to do some
documentation reorganization but it's a slow process.

If you have any specific questions about the kernel development process or you
have specific suggestions about documentation changes, please be forthcoming
with your specifics.

We know that there is a lot of cleaning up that needs to be done, but
combining documents is a fairly low priority IMO.

Oh, and you can always send patches as well.  :)

Hopefully Jon will also make some comments on your questions.

> References:
> 
> "Working with the development community":
> https://docs.kernel.org/index.html#working-with-the-development-community
> 
> - "All development-process docs" linked to "Working with the kernel
> development" community: https://docs.kernel.org/process/index.html
> 
> -  - "How the development process works":
> https://docs.kernel.org/process/2.Process.html
> 
> - "A guide to the Kernel Development Process":
> https://docs.kernel.org/process/development-process.html
> 
> Development tools and processes:
> https://docs.kernel.org/index.html#development-tools-and-processes
> 
> Thanks,
> Costa

thanks.
-- 
~Randy