diff mbox series

[2/2] doc: Add tar requirement to changes.rst

Message ID	20230521132336.1279523-2-masahiroy@kernel.org
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; From: Masahiro Yamada <masahiroy@kernel.org> To: linux-kbuild@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Masahiro Yamada <masahiroy@kernel.org>, Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org Subject: [PATCH 2/2] doc: Add tar requirement to changes.rst Date: Sun, 21 May 2023 22:23:36 +0900 Message-Id: <20230521132336.1279523-2-masahiroy@kernel.org> In-Reply-To: <20230521132336.1279523-1-masahiroy@kernel.org> References: <20230521132336.1279523-1-masahiroy@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	[1/2] Revert "kheaders: substituting --sort in archive creation" \| [1/2] Revert "kheaders: substituting --sort in archive creation" [2/2] doc: Add tar requirement to changes.rst

Commit Message

Masahiro Yamada May 21, 2023, 1:23 p.m. UTC

  tar is used to build the kernel with CONFIG_IKHEADERS.

GNU tar 1.28 or later is required.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
---

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

Comments

Nicolas Schier May 24, 2023, 8:12 p.m. UTC | #1

On Sun 21 May 2023 22:23:36 GMT, Masahiro Yamada wrote:
> tar is used to build the kernel with CONFIG_IKHEADERS.
> 
> GNU tar 1.28 or later is required.
> 
> Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> ---
> 
>  Documentation/process/changes.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> index a9ef00509c9b..3c0074214d75 100644
> --- a/Documentation/process/changes.rst
> +++ b/Documentation/process/changes.rst
> @@ -60,6 +60,7 @@ openssl & libcrypto    1.0.0            openssl version
>  bc                     1.06.95          bc --version
>  Sphinx\ [#f1]_         1.7              sphinx-build --version
>  cpio                   any              cpio --version
> +GNU tar                1.28             tar --version
>  gtags (optional)       6.6.5            gtags --version
>  ====================== ===============  ========================================
>  
> @@ -175,6 +176,12 @@ You will need openssl to build kernels 3.7 and higher if module signing is
>  enabled.  You will also need openssl development packages to build kernels 4.3
>  and higher.
>  
> +Tar
> +---
> +
> +GNU tar is needed if you want to enable access to the kernel headers via sysfs
> +(CONFIG_IKHEADERS).

CONFIG_IKHEADERS does also require 'xz' (cp. kernel/gen_kheaders.sh), 
should it be mentioned in changes.rst as well?

Reviewed-by: Nicolas Schier <nicolas@fjasle.eu>


> +
>  gtags / GNU GLOBAL (optional)
>  -----------------------------
>  
> -- 
> 2.39.2

Masahiro Yamada May 28, 2023, 7:15 a.m. UTC | #2

On Thu, May 25, 2023 at 5:13 AM Nicolas Schier <nicolas@fjasle.eu> wrote:
>
> On Sun 21 May 2023 22:23:36 GMT, Masahiro Yamada wrote:
> > tar is used to build the kernel with CONFIG_IKHEADERS.
> >
> > GNU tar 1.28 or later is required.
> >
> > Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> > ---
> >
> >  Documentation/process/changes.rst | 7 +++++++
> >  1 file changed, 7 insertions(+)
> >
> > diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> > index a9ef00509c9b..3c0074214d75 100644
> > --- a/Documentation/process/changes.rst
> > +++ b/Documentation/process/changes.rst
> > @@ -60,6 +60,7 @@ openssl & libcrypto    1.0.0            openssl version
> >  bc                     1.06.95          bc --version
> >  Sphinx\ [#f1]_         1.7              sphinx-build --version
> >  cpio                   any              cpio --version
> > +GNU tar                1.28             tar --version
> >  gtags (optional)       6.6.5            gtags --version
> >  ====================== ===============  ========================================
> >
> > @@ -175,6 +176,12 @@ You will need openssl to build kernels 3.7 and higher if module signing is
> >  enabled.  You will also need openssl development packages to build kernels 4.3
> >  and higher.
> >
> > +Tar
> > +---
> > +
> > +GNU tar is needed if you want to enable access to the kernel headers via sysfs
> > +(CONFIG_IKHEADERS).
>
> CONFIG_IKHEADERS does also require 'xz' (cp. kernel/gen_kheaders.sh),
> should it be mentioned in changes.rst as well?


It is true, bue 'xz' is required in other situations too.

For example,
CONFIG_KERNEL_XZ
CONFIG_MODULE_COMPRESS_XZ
CONFIG_INITRAMFS_COMPRESSION_XZ


If we document the requirement for 'xz',
we need to document the requirement for
'gzip', 'zstd', 'lzma', etc. for the same reason.

So, I want to go only with 'tar' in this series.






> Reviewed-by: Nicolas Schier <nicolas@fjasle.eu>
>
>
> > +
> >  gtags / GNU GLOBAL (optional)
> >  -----------------------------
> >
> > --
> > 2.39.2
>
> --
> Nicolas Schier
>
> epost|xmpp: nicolas@fjasle.eu          irc://oftc.net/nsc
> ↳ gpg: 18ed 52db e34f 860e e9fb  c82b 7d97 0932 55a0 ce7f
>      -- frykten for herren er opphav til kunnskap --

Nicolas Schier May 30, 2023, 6:54 p.m. UTC | #3

On Sun 28 May 2023 16:15:02 GMT, Masahiro Yamada wrote:
> On Thu, May 25, 2023 at 5:13 AM Nicolas Schier <nicolas@fjasle.eu> 
> wrote:
> >
> > On Sun 21 May 2023 22:23:36 GMT, Masahiro Yamada wrote:
> > > tar is used to build the kernel with CONFIG_IKHEADERS.
> > >
> > > GNU tar 1.28 or later is required.
> > >
> > > Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
> > > ---
> > >
> > >  Documentation/process/changes.rst | 7 +++++++
> > >  1 file changed, 7 insertions(+)
> > >
> > > diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
> > > index a9ef00509c9b..3c0074214d75 100644
> > > --- a/Documentation/process/changes.rst
> > > +++ b/Documentation/process/changes.rst
> > > @@ -60,6 +60,7 @@ openssl & libcrypto    1.0.0            openssl version
> > >  bc                     1.06.95          bc --version
> > >  Sphinx\ [#f1]_         1.7              sphinx-build --version
> > >  cpio                   any              cpio --version
> > > +GNU tar                1.28             tar --version
> > >  gtags (optional)       6.6.5            gtags --version
> > >  ====================== ===============  ========================================
> > >
> > > @@ -175,6 +176,12 @@ You will need openssl to build kernels 3.7 and higher if module signing is
> > >  enabled.  You will also need openssl development packages to build kernels 4.3
> > >  and higher.
> > >
> > > +Tar
> > > +---
> > > +
> > > +GNU tar is needed if you want to enable access to the kernel headers via sysfs
> > > +(CONFIG_IKHEADERS).
> >
> > CONFIG_IKHEADERS does also require 'xz' (cp. kernel/gen_kheaders.sh),
> > should it be mentioned in changes.rst as well?
> 
> 
> It is true, bue 'xz' is required in other situations too.
> 
> For example,
> CONFIG_KERNEL_XZ
> CONFIG_MODULE_COMPRESS_XZ
> CONFIG_INITRAMFS_COMPRESSION_XZ
> 
> 
> If we document the requirement for 'xz',
> we need to document the requirement for
> 'gzip', 'zstd', 'lzma', etc. for the same reason.
> 
> So, I want to go only with 'tar' in this series.

yes, sounds reasonable.

Kind regards,
Nicolas

diff mbox series

Patch

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index a9ef00509c9b..3c0074214d75 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -60,6 +60,7 @@  openssl & libcrypto    1.0.0            openssl version
 bc                     1.06.95          bc --version
 Sphinx\ [#f1]_         1.7              sphinx-build --version
 cpio                   any              cpio --version
+GNU tar                1.28             tar --version
 gtags (optional)       6.6.5            gtags --version
 ====================== ===============  ========================================
 
@@ -175,6 +176,12 @@  You will need openssl to build kernels 3.7 and higher if module signing is
 enabled.  You will also need openssl development packages to build kernels 4.3
 and higher.
 
+Tar
+---
+
+GNU tar is needed if you want to enable access to the kernel headers via sysfs
+(CONFIG_IKHEADERS).
+
 gtags / GNU GLOBAL (optional)
 -----------------------------