Received-SPF: pass (google.com: domain of linux-kernel+bounces-93732-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Date: Wed, 6 Mar 2024 11:18:05 +0100
From: Petr =?UTF-8?B?VGVzYcWZw61r?= <petr@tesarici.cz>
To: Thorsten Leemhuis <linux@leemhuis.info>
Cc: Jonathan Corbet <corbet@lwn.net>, regressions@lists.linux.dev,
 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Bagas Sanjaya
 <bagasdotme@gmail.com>
Subject: Re: [PATCH v1] docs: verify/bisect: fixes, finetuning, and support
 for Arch
Message-ID: <20240306111805.382fd341@meshulam.tesarici.cz>
In-Reply-To: <6592c9ef4244faa484b4113f088dbc1beca61015.1709716794.git.linux@leemhuis.info>
References: <6592c9ef4244faa484b4113f088dbc1beca61015.1709716794.git.linux@leemhuis.info>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit

On Wed,  6 Mar 2024 10:21:12 +0100
Thorsten Leemhuis <linux@leemhuis.info> wrote:

> Assorted changes for the recently added document.
> 
> Improvements:
> 
> * Add instructions for installing required software on Arch Linux.
> 
> Fixes:
> 
> * Move a 'git remote add -t master stable [...]' from a totally wrong
>   to the right place.
> 
> * Fix two anchors.
> 
> * Add two required packages to the openSUSE install instructions.
> 
> Fine tuning:
> 
> * Improve the reference section about downloading Linux mainline sources
>   to make it more obvious that those are alternatives.
> 
> * Include the full instructions for git bundles to ensure the remote
>   gets the right name; that way the text also works stand alone.
> 
> * Install ncurses and qt headers for use of menuconfig and xconfig by
>   default, but tell users that they are free to omit them.
> 
> * Mention ahead of time which version number are meant as example in
>   commands used during the step-by-step guide.
> 
> * Mention that 'kernel-install remove' might do a incomplete job.
> 
> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
> ---
> 
> Lo! A quick note reg "mention ahead of time which version numbers are
> meant as example in commands used during the step-by-step guide". I did
> that, as I've seen someone following the guide without replacing the
> version numbers, so pointing this out with a few words seemed wise. But
> I'm not sure if the way I did it was the best; if someone has a better
> idea how to do that, please let me know. Ciao, Thorsten


If you want to make 100% sure that nobody can follow the guide blindly
without replacing the version numbers, use e.g. 2.8...

Then again, this could also confuse some other folks...

The idea is probably not better.

Petr T