confusing documentation about Development Process

confusing documentation about Development Process

[Costa Shulyupin]

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?
- What are the principal differences between the topics?
- Are there any outdated documents?
- How should it be?


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

Re: confusing documentation about Development Process

[Bagas Sanjaya]

On 5/5/23 12:39, Costa Shulyupin wrote:
> 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
> 

Have you RTFM above?

-- 
An old man doll... just what I always wanted! - Clara

Re: confusing documentation about Development Process

[Randy Dunlap]

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