Skip to contentSkip to conversation

Docs: Update information at changes.rst

PATCH Superseded Bruno Moreira-Guedes 2 participants 5 messages Apr 19, 2022

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

cover Docs: Update information at changes.rst

Add and update information at 'Documentation/process/changes.rst'. The text has outdated kernel version and misses the 'cpio' build requirement, necessary for the kernel/gen_kheaders.sh script called by the install target.

The PATCH 1/2 fixes the missing cpio requirement, while PATCH 2/2 fixes the kernel version.

---
Bruno Moreira-Guedes (2):
Docs: Add cpio requirement to changes.rst
Docs: Update kernel series in changes.rst

 Documentation/process/changes.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
Signature · 1 line
2.35.3
#1 lore raw

PATCH 1/2 Docs: Add cpio requirement to changes.rst

The install target requires cpio to run the kernel/gen_kheaders.sh script, but it's missing in the requirements list at 'Documentation/process/changes.rst'. This patch adds it to the list.

---
 Documentation/process/changes.rst | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/process/changes.rst +6 -0
index a337e8eabfe1..41a44e5f47e6 100644
@@ -56,6 +56,7 @@ iptables               1.4.2            iptables -V
 openssl & libcrypto    1.0.0            openssl version
 bc                     1.06.95          bc --version
 Sphinx\ [#f1]_         1.7              sphinx-build --version
+cpio                   any              cpio --version
 ====================== ===============  ========================================
 
 .. [#f1] Sphinx is needed only to build the Kernel documentation
@@ -458,6 +459,11 @@ mcelog
 
 - <http://www.mcelog.org/>
 
+cpio
+----
+
+- <https://www.gnu.org/software/cpio/>
+
 Networking
 **********
 
Signature · 1 line
2.35.3
#2 lore raw

PATCH 2/2 Docs: Update kernel series in changes.rst

In reply to Bruno Moreira-Guedes

The file 'Documentation/process/changes.rst' states the listed requirements are for the 4.x kernel version. However, there are requirements updated for the 5.x version, so this patch updates it to match the current kernel version.

---
 Documentation/process/changes.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/process/changes.rst +1 -1
index 41a44e5f47e6..08515b11cf92 100644
@@ -7,7 +7,7 @@ Intro
 =====
 
 This document is designed to provide a list of the minimum levels of
-software necessary to run the 4.x kernels.
+software necessary to run the 5.x kernels.
 
 This document is originally based on my "Changes" file for 2.0.x kernels
 and therefore owes credit to the same people as that file (Jared Mauch,
Signature · 1 line
2.35.3
#3 lore raw

Re: [PATCH 2/2] Docs: Update kernel series in changes.rst

Documentation/process/changes.rst Intro · line 10

Quoted 6 lines · Bruno Moreira-Guedes
Documentation/process/changes.rst +1 -1
@@ -7,7 +7,7 @@ Intro
 =====
 
 This document is designed to provide a list of the minimum levels of
-software necessary to run the 4.x kernels.
+software necessary to run the 5.x kernels.

We don't change the major version when we update the minimum required tooling ... why not change this once and for all to say:

+software necessary to build the current kernel.

#4 lore raw

Re: [PATCH 2/2] Docs: Update kernel series in changes.rst

Quoted 9 lines · Matthew Wilcox

Documentation/process/changes.rst Intro · line 10

Quoted 3 lines · Bruno Moreira-Guedes

This document is designed to provide a list of the minimum levels of

Documentation/process/changes.rst +1 -1
-software necessary to run the 4.x kernels.
+software necessary to run the 5.x kernels.

We don't change the major version when we update the minimum required tooling ... why not change this once and for all to say:

+software necessary to build the current kernel.

Indeed it makes much more sense, I'm making a v2 soon!