[PATCH v2 0/2] Docs: Update information at changes.rst

[PATCH v2 0/2] Docs: Update information at changes.rst

[Bruno Moreira-Guedes]

[-- Attachment #1: Type: text/plain, Size: 1115 bytes --]

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 reference.

Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev>
---
CHANGE SUMMARY
   version: v1  v2
[PATCH 1/2] *   -
[PATCH 1/2] *   *

CHANGELOG
[PATCH 1/2] Docs: Add cpio requirement to changes.rst
        v2:
                - No changes
[PATCH 2/2] Docs: Replace version by 'current' in changes.rst
        v2:
                - Renamed from 'Docs: Update kernel series in
                changes.rst'
                - Changed approach from the original, replacing 4.x by
                5.x, to using 'current', as suggested by Matthew Wilcox.
---
Bruno Moreira-Guedes (2):
  Docs: Add cpio requirement to changes.rst
  Docs: Replace version by 'current' in changes.rst

 Documentation/process/changes.rst | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

--
2.35.3


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

[Bruno Moreira-Guedes]

[-- Attachment #1: Type: text/plain, Size: 1182 bytes --]

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.

Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev>
---
 Documentation/process/changes.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index a337e8eabfe1..41a44e5f47e6 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -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
 **********
 
-- 
2.35.3


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2 1/2] Docs: Add cpio requirement to changes.rst

[Bagas Sanjaya]

On 4/19/22 21:48, Bruno Moreira-Guedes wrote:
> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> index a337e8eabfe1..41a44e5f47e6 100644
> --- a/Documentation/process/changes.rst
> +++ b/Documentation/process/changes.rst
> @@ -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
>  ====================== ===============  ========================================
>  

You mentioned that **any** version of cpio will work, right?
Or is there a specific minimum version?

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

Re: [PATCH v2 1/2] Docs: Add cpio requirement to changes.rst

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On 4/19/22 21:48, Bruno Moreira-Guedes wrote:
>> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
>> index a337e8eabfe1..41a44e5f47e6 100644
>> --- a/Documentation/process/changes.rst
>> +++ b/Documentation/process/changes.rst
>> @@ -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
>>  ====================== ===============  ========================================
>>  
>
> You mentioned that **any** version of cpio will work, right?
> Or is there a specific minimum version?

The statement of "any" seems fairly explicit to me.  It has been a few
... decades ... since cpio has seen any sort of rapid development; do
you have any reason to think there might be a version in the wild that
would not work?

jon

[PATCH v2 2/2] Docs: Replace version by 'current' in changes.rst

[Bruno Moreira-Guedes]

[-- Attachment #1: Type: text/plain, Size: 1044 bytes --]

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, as there might be in other
future versions. This patch updates it to 'latest' so the document won't
be outdated in the future.

Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev>
---
 Documentation/process/changes.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index 41a44e5f47e6..34415ae1af1b 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -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 current kernel version.
 
 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,
-- 
2.35.3


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2 0/2] Docs: Update information at changes.rst

[Jonathan Corbet]

Bruno Moreira-Guedes <codeagain@codeagain.dev> writes:

> 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 reference.
>
> Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev>

Patches applied, thanks.

jon

Re: [PATCH v2 0/2] Docs: Update information at changes.rst

[Bruno Moreira-Guedes]

[-- Attachment #1: Type: text/plain, Size: 585 bytes --]

On Wed, Apr 20, 2022 at 03:35:10AM -0600, Jonathan Corbet wrote:
> Bruno Moreira-Guedes <codeagain@codeagain.dev> writes:
> >
> > The PATCH 1/2 fixes the missing cpio requirement, while PATCH 2/2 fixes
> > the kernel version reference.
> >
> > Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev>
> 
> Patches applied, thanks.
Thanks, Jon! I have also been thinking whether this filename
('changes.rst') is a good description of the file contents. Do you think
renaming it to something like 'requirements.rst' and updating its
references would be a good patch?


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH v2 0/2] Docs: Update information at changes.rst

[Jonathan Corbet]

Bruno Moreira-Guedes <codeagain@codeagain.dev> writes:

> On Wed, Apr 20, 2022 at 03:35:10AM -0600, Jonathan Corbet wrote:
>> Bruno Moreira-Guedes <codeagain@codeagain.dev> writes:
>> >
>> > The PATCH 1/2 fixes the missing cpio requirement, while PATCH 2/2 fixes
>> > the kernel version reference.
>> >
>> > Signed-off-by: Bruno Moreira-Guedes <codeagain@codeagain.dev>
>> 
>> Patches applied, thanks.
> Thanks, Jon! I have also been thinking whether this filename
> ('changes.rst') is a good description of the file contents. Do you think
> renaming it to something like 'requirements.rst' and updating its
> references would be a good patch?

It's best not to rename things unnecessarily, especially relatively
well-known files that a lot of people expect to find in a specific
place.  We've done a lot of renaming over the last few years, but this
is one I might let slide for now.

Thanks,

jon

Re: [PATCH v2 0/2] Docs: Update information at changes.rst

[Bagas Sanjaya]

On 4/21/22 04:34, Jonathan Corbet wrote:
>> Thanks, Jon! I have also been thinking whether this filename
>> ('changes.rst') is a good description of the file contents. Do you think
>> renaming it to something like 'requirements.rst' and updating its
>> references would be a good patch?
> 
> It's best not to rename things unnecessarily, especially relatively
> well-known files that a lot of people expect to find in a specific
> place.  We've done a lot of renaming over the last few years, but this
> is one I might let slide for now.
> 

Did you mean the rename will be benefical?

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

Re: [PATCH v2 0/2] Docs: Update information at changes.rst

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> On 4/21/22 04:34, Jonathan Corbet wrote:
>>> Thanks, Jon! I have also been thinking whether this filename
>>> ('changes.rst') is a good description of the file contents. Do you think
>>> renaming it to something like 'requirements.rst' and updating its
>>> references would be a good patch?
>> 
>> It's best not to rename things unnecessarily, especially relatively
>> well-known files that a lot of people expect to find in a specific
>> place.  We've done a lot of renaming over the last few years, but this
>> is one I might let slide for now.
>> 
>
> Did you mean the rename will be benefical?

No, I would not do the rename at this time.

jon