The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: "Nir Lichtman" <nir@lichtman.org>
To: <corbet@lwn.net>, <paulmck@kernel.org>,
	<akpm@linux-foundation.org>, <rostedt@goodmis.org>,
	<Neeraj.Upadhyay@amd.com>, <mcanal@igalia.com>,
	<thuth@redhat.com>, <ardb@kernel.org>,
	<gregkh@linuxfoundation.org>, <bp@alien8.de>,
	<linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Cc: <rob@landley.net>
Subject: [PATCH] docs: clarify rdinit precedence and correct ramdisk to initramfs
Date: Thu, 30 Jan 2025 10:59:33 +0200	[thread overview]
Message-ID: <000201db72f5$49b11e60$dd135b20$@lichtman.org> (raw)

Problem: Current documentation regarding the init and rdinit params is
confusing,
The description of rdinit claims that it is related to ramdisks, even though
in practice
It only controls the init executable of the initramfs
(the deprecated ramdisk mechanism is initialized only after attempting to
load rdinit
or its default "/init")
Rob Landley's document from 2005 "Ramfs, rootfs and initramfs"
clarifies the distinction between initramfs and ramdisk.
Another confusing point is that the init param is ignored, in case rdinit or
"/init"
exist and are executable in the initramfs; the source code gives priority to
rdinit.

Solution: Add more clarification to the kernel params documentation, and fix
From ramdisk to initramfs in the rdinit doc.

Signed-off-by: Nir Lichtman <nir@lichtman.org>
---
 Documentation/admin-guide/kernel-parameters.txt | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/kernel-parameters.txt
b/Documentation/admin-guide/kernel-parameters.txt
index fb8752b42ec8..246cb73f71a8 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -2182,6 +2182,8 @@
 			Format: <full_path>
 			Run specified binary instead of /sbin/init as init
 			process.
+			Note that rdinit= or /init if rdinit= is not set
will take
+			precedence in case they are found in the initramfs.
 
 	initcall_debug	[KNL] Trace initcalls as they are executed.  Useful
 			for working out where the kernel is dying during
@@ -5933,8 +5935,8 @@
 
 	rdinit=		[KNL]
 			Format: <full_path>
-			Run specified binary instead of /init from the
ramdisk,
-			used for early userspace startup. See initrd.
+			Run specified binary instead of /init from the
initramfs,
+			used for early userspace startup.
 
 	rdrand=		[X86,EARLY]
 			force - Override the decision by the kernel to hide
the
-- 
2.39.5



             reply	other threads:[~2025-01-30  8:59 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-30  8:59 Nir Lichtman [this message]
2025-01-30  9:52 ` [PATCH] docs: clarify rdinit precedence and correct ramdisk to initramfs Greg KH
2025-01-30 10:04   ` Nir Lichtman

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='000201db72f5$49b11e60$dd135b20$@lichtman.org' \
    --to=nir@lichtman.org \
    --cc=Neeraj.Upadhyay@amd.com \
    --cc=akpm@linux-foundation.org \
    --cc=ardb@kernel.org \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mcanal@igalia.com \
    --cc=paulmck@kernel.org \
    --cc=rob@landley.net \
    --cc=rostedt@goodmis.org \
    --cc=thuth@redhat.com \
    /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