2019-02-24 08:47:32

by Zenghui Yu

[permalink] [raw]
Subject: [PATCH] Documentation/process/howto: Update for 4.x -> 5.x versioning

As linux-5.0 is coming up soon, the howto.rst document can be
updated for the new kernel version. Change all 4.x references
to 5.x now.

Signed-off-by: Zenghui Yu <[email protected]>
---
Documentation/process/howto.rst | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
index f16242b..19001e2 100644
--- a/Documentation/process/howto.rst
+++ b/Documentation/process/howto.rst
@@ -235,16 +235,16 @@ Linux kernel development process currently
consists of a few different
main kernel "branches" and lots of different subsystem-specific kernel
branches. These different branches are:

- - main 4.x kernel tree
- - 4.x.y -stable kernel tree
+ - main 5.x kernel tree
+ - 5.x.y -stable kernel tree
- subsystem specific kernel trees and patches
- - the 4.x -next kernel tree for integration tests
+ - the 5.x -next kernel tree for integration tests

-4.x kernel tree
+5.x kernel tree
~~~~~~~~~~~~~~~

-4.x kernels are maintained by Linus Torvalds, and can be found on
-https://kernel.org in the pub/linux/kernel/v4.x/ directory. Its development
+5.x kernels are maintained by Linus Torvalds, and can be found on
+https://kernel.org in the pub/linux/kernel/v5.x/ directory. Its development
process is as follows:

- As soon as a new kernel is released a two weeks window is open,
@@ -277,21 +277,21 @@ mailing list about kernel releases:
released according to perceived bug status, not according to a
preconceived timeline."*

-4.x.y -stable kernel tree
+5.x.y -stable kernel tree
~~~~~~~~~~~~~~~~~~~~~~~~~

Kernels with 3-part versions are -stable kernels. They contain
relatively small and critical fixes for security problems or significant
-regressions discovered in a given 4.x kernel.
+regressions discovered in a given 5.x kernel.

This is the recommended branch for users who want the most recent stable
kernel and are not interested in helping test development/experimental
versions.

-If no 4.x.y kernel is available, then the highest numbered 4.x
+If no 5.x.y kernel is available, then the highest numbered 5.x
kernel is the current stable kernel.

-4.x.y are maintained by the "stable" team <[email protected]>, and
+5.x.y are maintained by the "stable" team <[email protected]>, and
are released as needs dictate. The normal release period is approximately
two weeks, but it can be longer if there are no pressing problems. A
security-related problem, instead, can cause a release to happen almost
@@ -326,10 +326,10 @@ revisions to it, and maintainers can mark
patches as under review,
accepted, or rejected. Most of these patchwork sites are listed at
https://patchwork.kernel.org/.

-4.x -next kernel tree for integration tests
+5.x -next kernel tree for integration tests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-Before updates from subsystem trees are merged into the mainline 4.x
+Before updates from subsystem trees are merged into the mainline 5.x
tree, they need to be integration-tested. For this purpose, a special
testing repository exists into which virtually all subsystem trees are
pulled on an almost daily basis:
--
2.7.4


2019-02-24 10:19:31

by Federico Vaga

[permalink] [raw]
Subject: Re: [PATCH] Documentation/process/howto: Update for 4.x -> 5.x versioning

hello,

I have just a general observation for the community, not related to the
content of this patch, but related with the idea behind.

Is it really important to specify the major release number in the documents? .
Can't we just use a generic x.y.z, or a more generic statement?

When you open a documentation page like

https://www.kernel.org/doc/html/latest/

you will see the release number in the top left corner, which implies that
what you read is (should be) valid for that version. And if you read from the
sources you should know which version you checked out, and if you don't you
can always verify.

I do not see the added value of having those numbers in the documents, unless
the purpose is to highlight some specific exceptions.

Am I missing some important reasons that justify these numbers?

Thank you

On Sunday, February 24, 2019 9:43:20 AM CET Zenghui Yu wrote:
> As linux-5.0 is coming up soon, the howto.rst document can be
> updated for the new kernel version. Change all 4.x references
> to 5.x now.
>
> Signed-off-by: Zenghui Yu <[email protected]>
> ---
> Documentation/process/howto.rst | 24 ++++++++++++------------
> 1 file changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/Documentation/process/howto.rst
> b/Documentation/process/howto.rst index f16242b..19001e2 100644
> --- a/Documentation/process/howto.rst
> +++ b/Documentation/process/howto.rst
> @@ -235,16 +235,16 @@ Linux kernel development process currently
> consists of a few different
> main kernel "branches" and lots of different subsystem-specific kernel
> branches. These different branches are:
>
> - - main 4.x kernel tree
> - - 4.x.y -stable kernel tree
> + - main 5.x kernel tree
> + - 5.x.y -stable kernel tree
> - subsystem specific kernel trees and patches
> - - the 4.x -next kernel tree for integration tests
> + - the 5.x -next kernel tree for integration tests
>
> -4.x kernel tree
> +5.x kernel tree
> ~~~~~~~~~~~~~~~
>
> -4.x kernels are maintained by Linus Torvalds, and can be found on
> -https://kernel.org in the pub/linux/kernel/v4.x/ directory. Its
> development +5.x kernels are maintained by Linus Torvalds, and can be found
> on +https://kernel.org in the pub/linux/kernel/v5.x/ directory. Its
> development process is as follows:
>
> - As soon as a new kernel is released a two weeks window is open,
> @@ -277,21 +277,21 @@ mailing list about kernel releases:
> released according to perceived bug status, not according to a
> preconceived timeline."*
>
> -4.x.y -stable kernel tree
> +5.x.y -stable kernel tree
> ~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Kernels with 3-part versions are -stable kernels. They contain
> relatively small and critical fixes for security problems or significant
> -regressions discovered in a given 4.x kernel.
> +regressions discovered in a given 5.x kernel.
>
> This is the recommended branch for users who want the most recent stable
> kernel and are not interested in helping test development/experimental
> versions.
>
> -If no 4.x.y kernel is available, then the highest numbered 4.x
> +If no 5.x.y kernel is available, then the highest numbered 5.x
> kernel is the current stable kernel.
>
> -4.x.y are maintained by the "stable" team <[email protected]>, and
> +5.x.y are maintained by the "stable" team <[email protected]>, and
> are released as needs dictate. The normal release period is approximately
> two weeks, but it can be longer if there are no pressing problems. A
> security-related problem, instead, can cause a release to happen almost
> @@ -326,10 +326,10 @@ revisions to it, and maintainers can mark
> patches as under review,
> accepted, or rejected. Most of these patchwork sites are listed at
> https://patchwork.kernel.org/.
>
> -4.x -next kernel tree for integration tests
> +5.x -next kernel tree for integration tests
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> -Before updates from subsystem trees are merged into the mainline 4.x
> +Before updates from subsystem trees are merged into the mainline 5.x
> tree, they need to be integration-tested. For this purpose, a special
> testing repository exists into which virtually all subsystem trees are
> pulled on an almost daily basis:





2019-02-24 12:54:22

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] Documentation/process/howto: Update for 4.x -> 5.x versioning

On Sun, Feb 24, 2019 at 04:43:20PM +0800, Zenghui Yu wrote:
> As linux-5.0 is coming up soon, the howto.rst document can be
> updated for the new kernel version. Change all 4.x references
> to 5.x now.
>
> Signed-off-by: Zenghui Yu <[email protected]>
> ---
> Documentation/process/howto.rst | 24 ++++++++++++------------
> 1 file changed, 12 insertions(+), 12 deletions(-)

I think Jon already sent a patch for this last week, you might want to
look in the archives.

thanks,

greg k-h

2019-02-24 12:55:47

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] Documentation/process/howto: Update for 4.x -> 5.x versioning

On Sun, Feb 24, 2019 at 11:16:56AM +0100, Federico Vaga wrote:
> hello,
>
> I have just a general observation for the community, not related to the
> content of this patch, but related with the idea behind.
>
> Is it really important to specify the major release number in the documents? .
> Can't we just use a generic x.y.z, or a more generic statement?
>
> When you open a documentation page like
>
> https://www.kernel.org/doc/html/latest/
>
> you will see the release number in the top left corner, which implies that
> what you read is (should be) valid for that version. And if you read from the
> sources you should know which version you checked out, and if you don't you
> can always verify.
>
> I do not see the added value of having those numbers in the documents, unless
> the purpose is to highlight some specific exceptions.
>
> Am I missing some important reasons that justify these numbers?

Nothing really, it's just "history". Given that the "major" number only
changes every 3-4 years, it's not all that big of a deal.

If you can think of a way to write these documents such that they do not
depend on a version number at all, I'm sure no one would object to those
patches.

thanks,

greg k-h

2019-02-24 15:26:36

by Zenghui Yu

[permalink] [raw]
Subject: Re: [PATCH] Documentation/process/howto: Update for 4.x -> 5.x versioning

On Sun, Feb 24, 2019 at 8:53 PM Greg KH <[email protected]> wrote:
>
> On Sun, Feb 24, 2019 at 04:43:20PM +0800, Zenghui Yu wrote:
> > As linux-5.0 is coming up soon, the howto.rst document can be
> > updated for the new kernel version. Change all 4.x references
> > to 5.x now.
> >
> > Signed-off-by: Zenghui Yu <[email protected]>
> > ---
> > Documentation/process/howto.rst | 24 ++++++++++++------------
> > 1 file changed, 12 insertions(+), 12 deletions(-)
>
> I think Jon already sent a patch for this last week, you might want to
> look in the archives.
>

Thanks for the reminder. After looking into the archives:

https://marc.info/?l=linux-doc

I find something about the "4.x -> 5.x versioning" have already been fixed.
But Documentation/process/howto.rst seems to be missed.

Also, I realized I've sent my patch using Gmail WEB client... and now I find
some embarrassing format problems in it. So if still needed, I will send a V2.

Thanks,
Zenghui