[PATCH] v2 Docs: changes.rst: introduce optional column

Manuel Ebner posted 1 patch 3 weeks, 4 days ago
Documentation/process/changes.rst | 84 +++++++++++++++----------------
1 file changed, 42 insertions(+), 42 deletions(-)
[PATCH] v2 Docs: changes.rst: introduce optional column
Posted by Manuel Ebner 3 weeks, 4 days ago
The optional tag isn't obvious nor defined. Therefore replace with column.

Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
---
 Documentation/process/changes.rst | 84 +++++++++++++++----------------
 1 file changed, 42 insertions(+), 42 deletions(-)

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index b3fa980b63e3..905ac0f6cdc5 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -29,49 +29,49 @@ systems; obviously, if you don't have any PC Card hardware, for example,
 you probably do not need to concern yourself with pcmciautils.
 
 ====================== ===============  ========================================
-        Program        Minimal version       Command to check the version
+        Program        Minimal version  Required for 
 ====================== ===============  ========================================
-bash                   4.2              bash --version
-bc                     1.06.95          bc --version
-bindgen (optional)     0.71.1           bindgen --version
-binutils               2.30             ld -v
-bison                  2.0              bison --version
-btrfs-progs            0.18             btrfs --version
-Clang/LLVM (optional)  17.0.1           clang --version
-e2fsprogs              1.41.4           e2fsck -V
-flex                   2.5.35           flex --version
-gdb                    7.2              gdb --version
-genisoimage            1.1.11           genisoimage --version
-GNU awk (optional)     5.1.0            gawk --version
-GNU C                  8.1              gcc --version
-GNU make               4.0              make --version
-GNU tar                1.28             tar --version
-GRUB                   0.93             grub --version || grub-install --version
-gtags (optional)       6.6.5            gtags --version
-iproute2               6.14.0           ip -V
-iptables               1.4.2            iptables -V
-jfsutils               1.1.3            fsck.jfs -V
-kmod                   13               kmod -V
-liblzma                5.8.1            lzma -V
-lzop                   1.04             lzop -V
-mcelog                 0.6              mcelog --version
-mkimage (optional)     2017.01          mkimage --version
-mtools                 4.0.49           mtools -V
-nfs-utils              1.0.5            showmount --version
-openssl & libcrypto    1.0.0            openssl version
-pahole                 1.26             pahole --version
-pcmciautils            004              pccardctl -V
-PPP                    2.4.0            pppd --version
-procps                 3.2.0            ps --version
-Python                 3.9.x            python3 --version
-quota-tools            3.09             quota -V
-Rust (optional)        1.85.0           rustc --version
-Sphinx\ [#f1]_         3.4.3            sphinx-build --version
-squashfs-tools         4.0              mksquashfs -version
-syslinux               6.04             syslinux --version
-udev                   081              udevadm --version
-util-linux             2.10o            mount --version
-xfsprogs               2.6.0            xfs_db -V
+bash                   4.2              
+bc                     1.06.95          
+bindgen                0.71.1           generate Rust bindings
+binutils               2.30             
+bison                  2.0              
+btrfs-progs            0.18             
+Clang/LLVM             17.0.1           alternative to GNU C (gcc)
+e2fsprogs              1.41.4           ext4
+flex                   2.5.35           
+gdb                    7.2              
+genisoimage            1.1.11           
+GNU awk                5.1.0            objtool
+GNU C                  8.1              
+GNU make               4.0              
+GNU tar                1.28             
+GRUB                   0.93             
+gtags (optional)       6.6.5            
+iproute2               6.14.0           
+iptables               1.4.2            
+jfsutils               1.1.3            
+kmod                   13               
+liblzma                5.8.1            
+lzop                   1.04             
+mcelog                 0.6              
+mkimage                2017.01          ARCH=arc, arm, or powerpc
+mtools                 4.0.49           
+nfs-utils              1.0.5            
+openssl & libcrypto    1.0.0            
+pahole                 1.26             
+pcmciautils            004              
+PPP                    2.4.0            
+procps                 3.2.0            
+Python                 3.9.x            
+quota-tools            3.09             
+Rust                   1.85.0           CONFIG_RUST=y
+Sphinx\ [#f1]_         3.4.3            
+squashfs-tools         4.0              
+syslinux               6.04             
+udev                   081              
+util-linux             2.10o            
+xfsprogs               2.6.0            
 ====================== ===============  ========================================
 
 .. [#f1] Sphinx is needed only to build the Kernel documentation
-- 
2.54.0
Re: [PATCH] v2 Docs: changes.rst: introduce optional column
Posted by Nicolas Schier 3 weeks ago
On Mon, Aug 31, 2026 at 05:25:22PM +0200, Manuel Ebner wrote:
> The optional tag isn't obvious nor defined. Therefore replace with column.

Why do you throw away the 'Command to check the version' column?  At 
work, we have a script that uses these commands to check the actual 
tooling versions.

If there is a reason for change, please document it in the commit 
message.

> 
> Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
> ---
>  Documentation/process/changes.rst | 84 +++++++++++++++----------------
>  1 file changed, 42 insertions(+), 42 deletions(-)
> 
> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> index b3fa980b63e3..905ac0f6cdc5 100644
> --- a/Documentation/process/changes.rst
> +++ b/Documentation/process/changes.rst
> @@ -29,49 +29,49 @@ systems; obviously, if you don't have any PC Card hardware, for example,
>  you probably do not need to concern yourself with pcmciautils.
>  
>  ====================== ===============  ========================================
> -        Program        Minimal version       Command to check the version
> +        Program        Minimal version  Required for 

Do you want to align the column headers to the left or center them?

>  ====================== ===============  ========================================
> -bash                   4.2              bash --version
> -bc                     1.06.95          bc --version
> -bindgen (optional)     0.71.1           bindgen --version
> -binutils               2.30             ld -v
> -bison                  2.0              bison --version
> -btrfs-progs            0.18             btrfs --version
> -Clang/LLVM (optional)  17.0.1           clang --version
> -e2fsprogs              1.41.4           e2fsck -V
> -flex                   2.5.35           flex --version
> -gdb                    7.2              gdb --version
> -genisoimage            1.1.11           genisoimage --version
> -GNU awk (optional)     5.1.0            gawk --version
> -GNU C                  8.1              gcc --version
> -GNU make               4.0              make --version
> -GNU tar                1.28             tar --version
> -GRUB                   0.93             grub --version || grub-install --version
> -gtags (optional)       6.6.5            gtags --version
> -iproute2               6.14.0           ip -V
> -iptables               1.4.2            iptables -V
> -jfsutils               1.1.3            fsck.jfs -V
> -kmod                   13               kmod -V
> -liblzma                5.8.1            lzma -V
> -lzop                   1.04             lzop -V
> -mcelog                 0.6              mcelog --version
> -mkimage (optional)     2017.01          mkimage --version
> -mtools                 4.0.49           mtools -V
> -nfs-utils              1.0.5            showmount --version
> -openssl & libcrypto    1.0.0            openssl version
> -pahole                 1.26             pahole --version
> -pcmciautils            004              pccardctl -V
> -PPP                    2.4.0            pppd --version
> -procps                 3.2.0            ps --version
> -Python                 3.9.x            python3 --version
> -quota-tools            3.09             quota -V
> -Rust (optional)        1.85.0           rustc --version
> -Sphinx\ [#f1]_         3.4.3            sphinx-build --version
> -squashfs-tools         4.0              mksquashfs -version
> -syslinux               6.04             syslinux --version
> -udev                   081              udevadm --version
> -util-linux             2.10o            mount --version
> -xfsprogs               2.6.0            xfs_db -V
> +bash                   4.2              
> +bc                     1.06.95          
> +bindgen                0.71.1           generate Rust bindings
> +binutils               2.30             
> +bison                  2.0              
> +btrfs-progs            0.18             
> +Clang/LLVM             17.0.1           alternative to GNU C (gcc)
> +e2fsprogs              1.41.4           ext4
> +flex                   2.5.35           
> +gdb                    7.2              
> +genisoimage            1.1.11           
> +GNU awk                5.1.0            objtool
> +GNU C                  8.1              
> +GNU make               4.0              
> +GNU tar                1.28             
> +GRUB                   0.93             
> +gtags (optional)       6.6.5            
> +iproute2               6.14.0           
> +iptables               1.4.2            
> +jfsutils               1.1.3            
> +kmod                   13               
> +liblzma                5.8.1            
> +lzop                   1.04             
> +mcelog                 0.6              
> +mkimage                2017.01          ARCH=arc, arm, or powerpc
> +mtools                 4.0.49           
> +nfs-utils              1.0.5            
> +openssl & libcrypto    1.0.0            
> +pahole                 1.26             
> +pcmciautils            004              
> +PPP                    2.4.0            
> +procps                 3.2.0            
> +Python                 3.9.x            
> +quota-tools            3.09             
> +Rust                   1.85.0           CONFIG_RUST=y
> +Sphinx\ [#f1]_         3.4.3            
> +squashfs-tools         4.0              
> +syslinux               6.04             
> +udev                   081              
> +util-linux             2.10o            
> +xfsprogs               2.6.0            
>  ====================== ===============  ========================================
>  
>  .. [#f1] Sphinx is needed only to build the Kernel documentation

I kind of like the "Required for" column w/ naming 
concrete Kconfig symbols or envs like ARCH.  I think it would be good to 
get this a bit more complete, where possible.

Kind regards,
Nicolas
Re: [PATCH] v2 Docs: changes.rst: introduce optional column
Posted by Manuel Ebner 3 weeks ago
On Fri, 2026-09-04 at 18:11 +0200, Nicolas Schier wrote:
> On Mon, Aug 31, 2026 at 05:25:22PM +0200, Manuel Ebner wrote:
> > The optional tag isn't obvious nor defined. Therefore replace with column.
> 
> Why do you throw away the 'Command to check the version' column?  

I would do this to get some space for the optional column and have
the version commands in ./scrips/ver_linux . See below.

> At 
> work, we have a script that uses these commands to check the actual 
> tooling versions.

Well, I don't want to break that.

> If there is a reason for change, please document it in the commit 
> message.

Will do.

> > Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
> > ---
> >  Documentation/process/changes.rst | 84 +++++++++++++++----------------
> >  1 file changed, 42 insertions(+), 42 deletions(-)
> > 
> > diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> > index b3fa980b63e3..905ac0f6cdc5 100644
> > --- a/Documentation/process/changes.rst
> > +++ b/Documentation/process/changes.rst
> > @@ -29,49 +29,49 @@ systems; obviously, if you don't have any PC Card hardware, for example,
> >  you probably do not need to concern yourself with pcmciautils.
> >  
> >  ====================== ===============  ========================================
> > -        Program        Minimal version       Command to check the version
> > +        Program        Minimal version  Required for 
> 
> Do you want to align the column headers to the left or center them?

I should have done this the proper way but i didn't.

> >  ====================== ===============  ========================================
> > -bash                   4.2              bash --version
> > ...
> > +bash                   4.2              
> > ...
> >  ====================== ===============  ========================================
> >  
> >  .. [#f1] Sphinx is needed only to build the Kernel documentation
> 
> I kind of like the "Required for" column w/ naming 
> concrete Kconfig symbols or envs like ARCH.  

Thanks, do you prefer your scripts working or the required for column? Maybe there
is space for both, when 'program' and 'Minimal version' get squished.
Would one of those arrangements not break your scripts?

>  ====================== ===============  ================  =======================
>          Program        Minimal version    Required for        Version Command
>  ====================== ===============  ================  =======================

OR
>  ====================== ===============  =======================  ================
>          Program        Minimal version      Version Command        Required for
>  ====================== ===============  =======================  ================

> I think it would be good to 
> get this a bit more complete, where possible.

I have only little clue about tooling, versions or Kconfig so I'll need some help with that.

Thanks
 Manuel 

> Kind regards,
> Nicolas
Re: [PATCH] v2 Docs: changes.rst: introduce optional column
Posted by Nicolas Schier 2 weeks, 5 days ago
On Fri, Sep 04, 2026 at 07:02:52PM +0200, Manuel Ebner wrote:
> On Fri, 2026-09-04 at 18:11 +0200, Nicolas Schier wrote:
> > On Mon, Aug 31, 2026 at 05:25:22PM +0200, Manuel Ebner wrote:
> > > The optional tag isn't obvious nor defined. Therefore replace with column.
> > 
> > Why do you throw away the 'Command to check the version' column?  
> 
> I would do this to get some space for the optional column and have
> the version commands in ./scrips/ver_linux . See below.
> 
> > At 
> > work, we have a script that uses these commands to check the actual 
> > tooling versions.
> 
> Well, I don't want to break that.
> 
> > If there is a reason for change, please document it in the commit 
> > message.
> 
> Will do.

oh, I'm sorry.  I wasn't aware of scripts/ver_linux at all.  A good 
reason for removing the 'Command to check the version' column is the 
redundancy with scripts/ver_linux as having these infos in two places 
will almost always lead to inconsistencies.

Please, break my script and keep on removing the column.

Kind regards,
Nicolas
Re: [PATCH] v2 Docs: changes.rst: introduce optional column
Posted by Miguel Ojeda 3 weeks, 4 days ago
On Mon, Aug 31, 2026 at 5:25 PM Manuel Ebner <manuelebnerli@mailbox.org> wrote:
>
> +bindgen                0.71.1           generate Rust bindings

Should this simply say `CONFIG_RUST=y` too?

> +Clang/LLVM             17.0.1           alternative to GNU C (gcc)

Should we add an equivalent one to GNU C?

> +gtags (optional)       6.6.5

It seems the patch missed this one?

> +Sphinx\ [#f1]_         3.4.3

Should the footnote be moved into the new column?

> xfsprogs               2.6.0

Is this always required? There may be others that are actually optional too.

Cc'ing Guillaume and Nicolas -- we were discussing Python in this thread:

  https://lore.kernel.org/all/apG3hwaPA8f7SJeI@levanger/

Thanks!

Cheers,
Miguel