From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Fri, 06 Oct 2023 11:26:13 +0200 Received: from metis.whiteo.stw.pengutronix.de ([2a0a:edc0:2:b01:1d::104]) by lore.white.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qoh65-008C5a-Ex for lore@lore.pengutronix.de; Fri, 06 Oct 2023 11:26:13 +0200 Received: from bombadil.infradead.org ([2607:7c80:54:3::133]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qoh63-0003Gy-A8 for lore@pengutronix.de; Fri, 06 Oct 2023 11:26:13 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: MIME-Version:Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-Type: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Owner; bh=ieP3qOld2v6W/oURCxH+CpoXCuZnbSd8CsTfs9FLgwM=; b=fkeNH+v9n/wuA5hYsF10oKQvDW bN1KUadau1N3ICtKj+gbd3jl492Fap/OJgIbJsL0II/6oZJzN/8jzTqfuZ6MR6XoryL+dLSz6YdAi HdAPT4B0EiA1jjOe5oIN7XRRQOtKwi6k/p9V0yKmW4Xb7c+6IJoP2UihSIJ8HWUq9tJHWEBVvyJM/ OHgM77UpwnFwRBF7ezCVhL8pRmr8QwJn2bm64t3Tx1Rq0cDeMusR1N0f6BB9TMl01JK5Bpu7hXjoM wG/zgxJ5e3g6C485okZ7ck+3hIajAYh+tDdMwszT3cMFK0oTdqf69NkA6myypmkOMeDHHc9+p2rRl V6k8FLPQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.96 #2 (Red Hat Linux)) id 1qoh4W-005Npo-0b; Fri, 06 Oct 2023 09:24:36 +0000 Received: from metis.whiteo.stw.pengutronix.de ([2a0a:edc0:2:b01:1d::104]) by bombadil.infradead.org with esmtps (Exim 4.96 #2 (Red Hat Linux)) id 1qoh4Q-005NpJ-3B for barebox@lists.infradead.org; Fri, 06 Oct 2023 09:24:34 +0000 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1qoh4M-00037K-6l; Fri, 06 Oct 2023 11:24:26 +0200 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1qoh4L-00BTzt-Qc; Fri, 06 Oct 2023 11:24:25 +0200 Received: from rhi by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1qoh4L-000JPw-2V; Fri, 06 Oct 2023 11:24:25 +0200 From: Roland Hieber To: barebox@lists.infradead.org Cc: Roland Hieber Date: Fri, 6 Oct 2023 11:24:05 +0200 Message-Id: <20231006092404.74601-1-rhi@pengutronix.de> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20231006_022431_026022_BF3C2745 X-CRM114-Status: GOOD ( 14.99 ) X-BeenThere: barebox@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "barebox" X-SA-Exim-Connect-IP: 2607:7c80:54:3::133 X-SA-Exim-Mail-From: barebox-bounces+lore=pengutronix.de@lists.infradead.org X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on metis.whiteo.stw.pengutronix.de X-Spam-Level: X-Spam-Status: No, score=-4.9 required=4.0 tests=AWL,BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED,SPF_HELO_NONE,SPF_NONE autolearn=unavailable autolearn_force=no version=3.4.2 Subject: [PATCH] doc: booting-linux: improve bootspec chapter X-SA-Exim-Version: 4.2.1 (built Wed, 08 May 2019 21:11:16 +0000) X-SA-Exim-Scanned: Yes (on metis.whiteo.stw.pengutronix.de) * use the official name of the spec in the title * transform the URL to a link with title * mention other well-known search terms (e.g. "blspec", which is used in PTXdist, and "bootspec", which is often used by my colleagues) * don't highlight the scripts/kernel-install output as shell code * keep the NFS boot paragraph near the SD boot paragraph * format 'machine-id' and 'linux-appendroot' explanations as definition lists so they are easily found when looking for them * pick some more low-hanging formatting and copy editing fruits (it's harvest season after all) Signed-off-by: Roland Hieber --- Documentation/user/booting-linux.rst | 43 ++++++++++++++++------------ 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst index 76883862b938..b26ada943a59 100644 --- a/Documentation/user/booting-linux.rst +++ b/Documentation/user/booting-linux.rst @@ -163,12 +163,12 @@ setting the ``global.boot.default`` variable to ``mmc`` and then calling .. _bootloader_spec: -Bootloader Spec -^^^^^^^^^^^^^^^ +Boot Loader Specification +^^^^^^^^^^^^^^^^^^^^^^^^^ -barebox supports booting according to the bootloader spec: - -https://uapi-group.org/specifications/specs/boot_loader_specification/ +barebox supports booting according to the `Boot Loader Specification +`__ +(sometimes also known as *Bootloader Spec*, *bootspec* or *blspec*). It follows another philosophy than the :ref:`boot_entries`. With Boot Entries booting is completely configured in the bootloader. Bootloader Spec Entries @@ -209,7 +209,7 @@ Spec Entry on a SD card: The entry can be listed with the ``-l`` option: -.. code-block:: sh +.. code-block:: none scripts/kernel-install --device=/dev/mmcblk0 -l @@ -223,24 +223,29 @@ The entry can be listed with the ``-l`` option: When the SD card shows up as ``mmc1`` in barebox, this entry can be booted with ``boot mmc1`` or by setting ``global.boot.default`` to ``mmc1``. -``machine-id`` is an optional key. If the ``global.boot.machine_id`` variable -is set to a non-empty value, barebox will only boot the Bootloader Spec Entry -whose ``machine-id`` key matches the ``global.boot.machine_id`` variable. -All other Bootloader Spec entries will be ignored. - -A bootloader spec entry can also reside on an NFS server in which case an -RFC2224-compatible NFS URI string must be passed to the boot command: +A bootloader spec entry can also reside on an NFS server, in which case an +`RFC 2224 `__-compatible NFS URI +must be passed to the boot command: .. code-block:: sh boot nfs://nfshost[:port]//path/ -In addition to the options defined in the original spec barebox understands the -``linux-appendroot`` option. This is a boolean value and if set to ``true`` barebox -will automatically append a ``root=`` string to the Linux commandline based on the -device where the entry is found on. This makes it possible to use the same rootfs -image on different devices without having to specify a different root= option each -time. +Additional notes about keys in the bootloader spec entries: + +``machine-id`` + This key is optional. If the ``global.boot.machine_id`` variable is set to a + non-empty value, barebox will only boot the Bootloader Spec Entry whose + ``machine-id`` key matches the ``global.boot.machine_id`` variable. All + other Bootloader Spec entries will be ignored. + +``linux-appendroot`` + This boolean option is understood by Barebox although it is not part of the + original specification. If set to ``true``, barebox will automatically append + a ``root=`` string to the Linux commandline based on the device where the + entry is found on. This makes it possible to use the same rootfs image on + different devices without having to specify a different ``root=`` option each + time. .. _booting_linux_net: -- 2.39.2