mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Borislav Petkov <bp@kernel.org>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, LKML <linux-kernel@vger.kernel.org>,
	"Borislav Petkov (AMD)" <bp@alien8.de>
Subject: Re: [PATCH] Documentation/kernel-parameters: Move the kernel build options
Date: Wed, 12 Nov 2025 17:12:35 -0800	[thread overview]
Message-ID: <00ea9ddc-0a71-4c93-95e2-656374b0719b@infradead.org> (raw)
In-Reply-To: <20251112114641.8230-1-bp@kernel.org>

Hi,

On 11/12/25 3:46 AM, Borislav Petkov wrote:
> From: "Borislav Petkov (AMD)" <bp@alien8.de>
> 
> Move the kernel build options abbreviations to the .txt file so that
> they are together instead of one having to go hunt them in the .rst
> file.
> 
> Tweak the formatting so that the inclusion of kernel-parameters.txt
> still keeps the whole thing somewhat presentable in the html output too.
> 
> Signed-off-by: Borislav Petkov (AMD) <bp@alien8.de>
> ---
>  .../admin-guide/kernel-parameters.rst         | 97 +-----------------
>  .../admin-guide/kernel-parameters.txt         | 98 +++++++++++++++++++
>  2 files changed, 99 insertions(+), 96 deletions(-)
> 

[snip]

> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 6c42061ca20e..e85a91e63f48 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -1,3 +1,101 @@

[snip]

> +	X86_UV	SGI UV support is enabled.
> +	XEN	Xen support is enabled
> +	XTENSA	xtensa architecture is enabled.
> +
> +In addition, the following text indicates that the option
> +
> +	BOOT	Is a boot loader parameter.
> +	BUGS=	Relates to possible processor bugs on the said processor.
> +	KNL	Is a kernel start-up parameter.
> +
> +
> +Kernel parameters
> +
>  	accept_memory=  [MM]
>  			Format: { eager | lazy }
>  			default: lazy

WorksForMe although I prefer to highlight the "Kernel Parameters" line somehow,
e.g., all caps or underline with "======================" (yes, that's still a
literal underline, not a Sphinx doc. heading).


Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy

  reply	other threads:[~2025-11-13  1:12 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-12 11:46 Borislav Petkov
2025-11-13  1:12 ` Randy Dunlap [this message]
2025-11-18 16:20 ` Jonathan Corbet
2025-11-19 15:06   ` Borislav Petkov
2025-11-19 15:42     ` Jonathan Corbet
2025-11-19 19:09       ` Borislav Petkov
2025-12-01 17:35         ` Jani Nikula

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=00ea9ddc-0a71-4c93-95e2-656374b0719b@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=bp@alien8.de \
    --cc=bp@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®