Re: [PATCHv2] kconfig: add some Kconfig env variables to make help

From: Nicolas Schier <nicolas@fjasle.eu>
To: Masahiro Yamada <masahiroy@kernel.org>
Cc: Sergey Senozhatsky <senozhatsky@chromium.org>,
	linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCHv2] kconfig: add some Kconfig env variables to make help
Date: Sat, 9 Mar 2024 21:24:42 +0100	[thread overview]
Message-ID: <ZezFirN5okYdhL1U@fjasle.eu> (raw)
In-Reply-To: <CAK7LNAT7+GbXaF6MW18YvEeF4ZZLrn6sOutHPNxcoL_RD1Utyw@mail.gmail.com>

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

On Wed, Mar 06, 2024 at 01:46:35AM +0900 Masahiro Yamada wrote:
> On Mon, Mar 4, 2024 at 3:41 PM Nicolas Schier <n.schier@avm.de> wrote:
> >
> > On Fri, Mar 01, 2024 at 11:28:44PM +0900, Sergey Senozhatsky wrote:
> > > On (24/03/01 12:04), Nicolas Schier wrote:
> > > > Perhaps it might be a compromise to let 'make help' point to the
> > > > kbuild/kconfig documentation?
> > >
> > > Yes, I was thinking the same. A one-liner description per-env var
> > > and point to documentation if one-liner is not enough
> > >
> > >       KCONFIG_BARREL_ROLL     - kconfig does a barrel roll
> > >       KCONFIG_FOO_BAR         - kconfig does foo and then bar (see
> > >       documentation for details)
> >
> > No, I thought about leaving out any concrete examples but just adding a
> > sentence like:
> >
> >   kconfig and kbuild allow tuning and checks by settings various
> >   environment variables, cp. Documentation/kbuild/ for details.
> >
> > Then there is no need to re-document each variable in 'make help' but
> > those who are new are explicitly pointed to the maintained
> > documentation.
> 
> 
> That can be a compromised way, but it sounds silly...
> 
> Is it helpful at least for people who know 'make help'
> but do not know Documentation/kbuild/?

Touché, that's probably right.

Kind regards,
Nicolas

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