1
0
Fork 0

Documentation: change linux-4.x references to 5.x

As linux-5.0.x is coming up soon, the documentation should match,
in particular the README.rst file, so change all 4.x references
accordingly. There was a mix of lowercase and uppercase X here,
which I changed to using lowercase consistently.

Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
hifive-unleashed-5.1
Arnd Bergmann 2019-02-12 15:41:01 +01:00 committed by Jonathan Corbet
parent bfeffd1552
commit 0358affb5c
3 changed files with 78 additions and 73 deletions

View File

@ -1,9 +1,9 @@
.. _readme: .. _readme:
Linux kernel release 4.x <http://kernel.org/> Linux kernel release 5.x <http://kernel.org/>
============================================= =============================================
These are the release notes for Linux version 4. Read them carefully, These are the release notes for Linux version 5. Read them carefully,
as they tell you what this is all about, explain how to install the as they tell you what this is all about, explain how to install the
kernel, and what to do if something goes wrong. kernel, and what to do if something goes wrong.
@ -63,7 +63,7 @@ Installing the kernel source
directory where you have permissions (e.g. your home directory) and directory where you have permissions (e.g. your home directory) and
unpack it:: unpack it::
xz -cd linux-4.X.tar.xz | tar xvf - xz -cd linux-5.x.tar.xz | tar xvf -
Replace "X" with the version number of the latest kernel. Replace "X" with the version number of the latest kernel.
@ -72,26 +72,26 @@ Installing the kernel source
files. They should match the library, and not get messed up by files. They should match the library, and not get messed up by
whatever the kernel-du-jour happens to be. whatever the kernel-du-jour happens to be.
- You can also upgrade between 4.x releases by patching. Patches are - You can also upgrade between 5.x releases by patching. Patches are
distributed in the xz format. To install by patching, get all the distributed in the xz format. To install by patching, get all the
newer patch files, enter the top level directory of the kernel source newer patch files, enter the top level directory of the kernel source
(linux-4.X) and execute:: (linux-5.x) and execute::
xz -cd ../patch-4.x.xz | patch -p1 xz -cd ../patch-5.x.xz | patch -p1
Replace "x" for all versions bigger than the version "X" of your current Replace "x" for all versions bigger than the version "x" of your current
source tree, **in_order**, and you should be ok. You may want to remove source tree, **in_order**, and you should be ok. You may want to remove
the backup files (some-file-name~ or some-file-name.orig), and make sure the backup files (some-file-name~ or some-file-name.orig), and make sure
that there are no failed patches (some-file-name# or some-file-name.rej). that there are no failed patches (some-file-name# or some-file-name.rej).
If there are, either you or I have made a mistake. If there are, either you or I have made a mistake.
Unlike patches for the 4.x kernels, patches for the 4.x.y kernels Unlike patches for the 5.x kernels, patches for the 5.x.y kernels
(also known as the -stable kernels) are not incremental but instead apply (also known as the -stable kernels) are not incremental but instead apply
directly to the base 4.x kernel. For example, if your base kernel is 4.0 directly to the base 5.x kernel. For example, if your base kernel is 5.0
and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1 and you want to apply the 5.0.3 patch, you must not first apply the 5.0.1
and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and and 5.0.2 patches. Similarly, if you are running kernel version 5.0.2 and
want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is, want to jump to 5.0.3, you must first reverse the 5.0.2 patch (that is,
patch -R) **before** applying the 4.0.3 patch. You can read more on this in patch -R) **before** applying the 5.0.3 patch. You can read more on this in
:ref:`Documentation/process/applying-patches.rst <applying_patches>`. :ref:`Documentation/process/applying-patches.rst <applying_patches>`.
Alternatively, the script patch-kernel can be used to automate this Alternatively, the script patch-kernel can be used to automate this
@ -114,7 +114,7 @@ Installing the kernel source
Software requirements Software requirements
--------------------- ---------------------
Compiling and running the 4.x kernels requires up-to-date Compiling and running the 5.x kernels requires up-to-date
versions of various software packages. Consult versions of various software packages. Consult
:ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers :ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
required and how to get updates for these packages. Beware that using required and how to get updates for these packages. Beware that using
@ -132,12 +132,12 @@ Build directory for the kernel
place for the output files (including .config). place for the output files (including .config).
Example:: Example::
kernel source code: /usr/src/linux-4.X kernel source code: /usr/src/linux-5.x
build directory: /home/name/build/kernel build directory: /home/name/build/kernel
To configure and build the kernel, use:: To configure and build the kernel, use::
cd /usr/src/linux-4.X cd /usr/src/linux-5.x
make O=/home/name/build/kernel menuconfig make O=/home/name/build/kernel menuconfig
make O=/home/name/build/kernel make O=/home/name/build/kernel
sudo make O=/home/name/build/kernel modules_install install sudo make O=/home/name/build/kernel modules_install install

View File

@ -216,14 +216,14 @@ You can use the ``interdiff`` program (http://cyberelk.net/tim/patchutils/) to
generate a patch representing the differences between two patches and then generate a patch representing the differences between two patches and then
apply the result. apply the result.
This will let you move from something like 4.7.2 to 4.7.3 in a single This will let you move from something like 5.7.2 to 5.7.3 in a single
step. The -z flag to interdiff will even let you feed it patches in gzip or step. The -z flag to interdiff will even let you feed it patches in gzip or
bzip2 compressed form directly without the use of zcat or bzcat or manual bzip2 compressed form directly without the use of zcat or bzcat or manual
decompression. decompression.
Here's how you'd go from 4.7.2 to 4.7.3 in a single step:: Here's how you'd go from 5.7.2 to 5.7.3 in a single step::
interdiff -z ../patch-4.7.2.gz ../patch-4.7.3.gz | patch -p1 interdiff -z ../patch-5.7.2.gz ../patch-5.7.3.gz | patch -p1
Although interdiff may save you a step or two you are generally advised to Although interdiff may save you a step or two you are generally advised to
do the additional steps since interdiff can get things wrong in some cases. do the additional steps since interdiff can get things wrong in some cases.
@ -245,62 +245,67 @@ The patches are available at http://kernel.org/
Most recent patches are linked from the front page, but they also have Most recent patches are linked from the front page, but they also have
specific homes. specific homes.
The 4.x.y (-stable) and 4.x patches live at The 5.x.y (-stable) and 5.x patches live at
https://www.kernel.org/pub/linux/kernel/v4.x/ https://www.kernel.org/pub/linux/kernel/v5.x/
The -rc patches live at The -rc patches are not stored on the webserver but are generated on
demand from git tags such as
https://www.kernel.org/pub/linux/kernel/v4.x/testing/ https://git.kernel.org/torvalds/p/v5.1-rc1/v5.0
The stable -rc patches live at
https://www.kernel.org/pub/linux/kernel/v5.x/stable-review/
The 4.x kernels The 5.x kernels
=============== ===============
These are the base stable releases released by Linus. The highest numbered These are the base stable releases released by Linus. The highest numbered
release is the most recent. release is the most recent.
If regressions or other serious flaws are found, then a -stable fix patch If regressions or other serious flaws are found, then a -stable fix patch
will be released (see below) on top of this base. Once a new 4.x base will be released (see below) on top of this base. Once a new 5.x base
kernel is released, a patch is made available that is a delta between the kernel is released, a patch is made available that is a delta between the
previous 4.x kernel and the new one. previous 5.x kernel and the new one.
To apply a patch moving from 4.6 to 4.7, you'd do the following (note To apply a patch moving from 5.6 to 5.7, you'd do the following (note
that such patches do **NOT** apply on top of 4.x.y kernels but on top of the that such patches do **NOT** apply on top of 5.x.y kernels but on top of the
base 4.x kernel -- if you need to move from 4.x.y to 4.x+1 you need to base 5.x kernel -- if you need to move from 5.x.y to 5.x+1 you need to
first revert the 4.x.y patch). first revert the 5.x.y patch).
Here are some examples:: Here are some examples::
# moving from 4.6 to 4.7 # moving from 5.6 to 5.7
$ cd ~/linux-4.6 # change to kernel source dir $ cd ~/linux-5.6 # change to kernel source dir
$ patch -p1 < ../patch-4.7 # apply the 4.7 patch $ patch -p1 < ../patch-5.7 # apply the 5.7 patch
$ cd .. $ cd ..
$ mv linux-4.6 linux-4.7 # rename source dir $ mv linux-5.6 linux-5.7 # rename source dir
# moving from 4.6.1 to 4.7 # moving from 5.6.1 to 5.7
$ cd ~/linux-4.6.1 # change to kernel source dir $ cd ~/linux-5.6.1 # change to kernel source dir
$ patch -p1 -R < ../patch-4.6.1 # revert the 4.6.1 patch $ patch -p1 -R < ../patch-5.6.1 # revert the 5.6.1 patch
# source dir is now 4.6 # source dir is now 5.6
$ patch -p1 < ../patch-4.7 # apply new 4.7 patch $ patch -p1 < ../patch-5.7 # apply new 5.7 patch
$ cd .. $ cd ..
$ mv linux-4.6.1 linux-4.7 # rename source dir $ mv linux-5.6.1 linux-5.7 # rename source dir
The 4.x.y kernels The 5.x.y kernels
================= =================
Kernels with 3-digit versions are -stable kernels. They contain small(ish) Kernels with 3-digit versions are -stable kernels. They contain small(ish)
critical fixes for security problems or significant regressions discovered critical fixes for security problems or significant regressions discovered
in a given 4.x kernel. in a given 5.x kernel.
This is the recommended branch for users who want the most recent stable This is the recommended branch for users who want the most recent stable
kernel and are not interested in helping test development/experimental kernel and are not interested in helping test development/experimental
versions. versions.
If no 4.x.y kernel is available, then the highest numbered 4.x kernel is If no 5.x.y kernel is available, then the highest numbered 5.x kernel is
the current stable kernel. the current stable kernel.
.. note:: .. note::
@ -308,23 +313,23 @@ the current stable kernel.
The -stable team usually do make incremental patches available as well The -stable team usually do make incremental patches available as well
as patches against the latest mainline release, but I only cover the as patches against the latest mainline release, but I only cover the
non-incremental ones below. The incremental ones can be found at non-incremental ones below. The incremental ones can be found at
https://www.kernel.org/pub/linux/kernel/v4.x/incr/ https://www.kernel.org/pub/linux/kernel/v5.x/incr/
These patches are not incremental, meaning that for example the 4.7.3 These patches are not incremental, meaning that for example the 5.7.3
patch does not apply on top of the 4.7.2 kernel source, but rather on top patch does not apply on top of the 5.7.2 kernel source, but rather on top
of the base 4.7 kernel source. of the base 5.7 kernel source.
So, in order to apply the 4.7.3 patch to your existing 4.7.2 kernel So, in order to apply the 5.7.3 patch to your existing 5.7.2 kernel
source you have to first back out the 4.7.2 patch (so you are left with a source you have to first back out the 5.7.2 patch (so you are left with a
base 4.7 kernel source) and then apply the new 4.7.3 patch. base 5.7 kernel source) and then apply the new 5.7.3 patch.
Here's a small example:: Here's a small example::
$ cd ~/linux-4.7.2 # change to the kernel source dir $ cd ~/linux-5.7.2 # change to the kernel source dir
$ patch -p1 -R < ../patch-4.7.2 # revert the 4.7.2 patch $ patch -p1 -R < ../patch-5.7.2 # revert the 5.7.2 patch
$ patch -p1 < ../patch-4.7.3 # apply the new 4.7.3 patch $ patch -p1 < ../patch-5.7.3 # apply the new 5.7.3 patch
$ cd .. $ cd ..
$ mv linux-4.7.2 linux-4.7.3 # rename the kernel source dir $ mv linux-5.7.2 linux-5.7.3 # rename the kernel source dir
The -rc kernels The -rc kernels
=============== ===============
@ -343,38 +348,38 @@ This is a good branch to run for people who want to help out testing
development kernels but do not want to run some of the really experimental development kernels but do not want to run some of the really experimental
stuff (such people should see the sections about -next and -mm kernels below). stuff (such people should see the sections about -next and -mm kernels below).
The -rc patches are not incremental, they apply to a base 4.x kernel, just The -rc patches are not incremental, they apply to a base 5.x kernel, just
like the 4.x.y patches described above. The kernel version before the -rcN like the 5.x.y patches described above. The kernel version before the -rcN
suffix denotes the version of the kernel that this -rc kernel will eventually suffix denotes the version of the kernel that this -rc kernel will eventually
turn into. turn into.
So, 4.8-rc5 means that this is the fifth release candidate for the 4.8 So, 5.8-rc5 means that this is the fifth release candidate for the 5.8
kernel and the patch should be applied on top of the 4.7 kernel source. kernel and the patch should be applied on top of the 5.7 kernel source.
Here are 3 examples of how to apply these patches:: Here are 3 examples of how to apply these patches::
# first an example of moving from 4.7 to 4.8-rc3 # first an example of moving from 5.7 to 5.8-rc3
$ cd ~/linux-4.7 # change to the 4.7 source dir $ cd ~/linux-5.7 # change to the 5.7 source dir
$ patch -p1 < ../patch-4.8-rc3 # apply the 4.8-rc3 patch $ patch -p1 < ../patch-5.8-rc3 # apply the 5.8-rc3 patch
$ cd .. $ cd ..
$ mv linux-4.7 linux-4.8-rc3 # rename the source dir $ mv linux-5.7 linux-5.8-rc3 # rename the source dir
# now let's move from 4.8-rc3 to 4.8-rc5 # now let's move from 5.8-rc3 to 5.8-rc5
$ cd ~/linux-4.8-rc3 # change to the 4.8-rc3 dir $ cd ~/linux-5.8-rc3 # change to the 5.8-rc3 dir
$ patch -p1 -R < ../patch-4.8-rc3 # revert the 4.8-rc3 patch $ patch -p1 -R < ../patch-5.8-rc3 # revert the 5.8-rc3 patch
$ patch -p1 < ../patch-4.8-rc5 # apply the new 4.8-rc5 patch $ patch -p1 < ../patch-5.8-rc5 # apply the new 5.8-rc5 patch
$ cd .. $ cd ..
$ mv linux-4.8-rc3 linux-4.8-rc5 # rename the source dir $ mv linux-5.8-rc3 linux-5.8-rc5 # rename the source dir
# finally let's try and move from 4.7.3 to 4.8-rc5 # finally let's try and move from 5.7.3 to 5.8-rc5
$ cd ~/linux-4.7.3 # change to the kernel source dir $ cd ~/linux-5.7.3 # change to the kernel source dir
$ patch -p1 -R < ../patch-4.7.3 # revert the 4.7.3 patch $ patch -p1 -R < ../patch-5.7.3 # revert the 5.7.3 patch
$ patch -p1 < ../patch-4.8-rc5 # apply new 4.8-rc5 patch $ patch -p1 < ../patch-5.8-rc5 # apply new 5.8-rc5 patch
$ cd .. $ cd ..
$ mv linux-4.7.3 linux-4.8-rc5 # rename the kernel source dir $ mv linux-5.7.3 linux-5.8-rc5 # rename the kernel source dir
The -mm patches and the linux-next tree The -mm patches and the linux-next tree

View File

@ -4,7 +4,7 @@
.. _it_readme: .. _it_readme:
Rilascio del kernel Linux 4.x <http://kernel.org/> Rilascio del kernel Linux 5.x <http://kernel.org/>
=================================================== ===================================================
.. warning:: .. warning::