Received-SPF: pass (google.com: domain of linux-kernel+bounces-90092-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Mon, 4 Mar 2024 07:41:39 +0100
From: Nicolas Schier <n.schier@avm.de>
To: Sergey Senozhatsky <senozhatsky@chromium.org>
Cc: Masahiro Yamada <masahiroy@kernel.org>, linux-kbuild@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCHv2] kconfig: add some Kconfig env variables to make help
Message-ID: <ZeVtIwua9T5prwUl@buildd.core.avm.de>
Mail-Followup-To: Sergey Senozhatsky <senozhatsky@chromium.org>,
	Masahiro Yamada <masahiroy@kernel.org>,
	linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20240222051621.GH11472@google.com>
 <20240228045652.GH11972@google.com>
 <CAK7LNAQ8OyNMeGzVoTRg-sHDZ4YK0EKY_eEWNepekaibO_ZKwg@mail.gmail.com>
 <20240229021010.GM11972@google.com>
 <CAK7LNASujf8m4PpMyoCC1cTN_YGeG1HVaOR+3pZx5=3OJp=85A@mail.gmail.com>
 <20240229034739.GN11972@google.com>
 <CAK7LNAS-mOxY884pLEMwWaX+wgzXdc6+=vqN=wfHBekuKL5ryA@mail.gmail.com>
 <20240301043316.GO11972@google.com>
 <ZeG2PRYmdO0r44kS@buildd.core.avm.de>
 <20240301142844.GP11972@google.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <20240301142844.GP11972@google.com>
Organization: AVM GmbH

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.

Kind regards,
Nicolas