From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id E8BFDC3DA59 for ; Tue, 16 Jul 2024 07:35:41 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id E7B6988958; Tue, 16 Jul 2024 09:35:39 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b="ObqeMruI"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 1CCDD8897B; Tue, 16 Jul 2024 09:35:39 +0200 (CEST) Received: from mail-wm1-x331.google.com (mail-wm1-x331.google.com [IPv6:2a00:1450:4864:20::331]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 08DBC88907 for ; Tue, 16 Jul 2024 09:35:37 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=mkorpershoek@baylibre.com Received: by mail-wm1-x331.google.com with SMTP id 5b1f17b1804b1-42797bcfc77so36020865e9.2 for ; Tue, 16 Jul 2024 00:35:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20230601.gappssmtp.com; s=20230601; t=1721115336; x=1721720136; darn=lists.denx.de; h=mime-version:message-id:date:references:in-reply-to:subject:cc:to :from:from:to:cc:subject:date:message-id:reply-to; bh=liElh604OPcs9JLLhCamV/AChUeOF9e4gQ2lOyfKdTQ=; b=ObqeMruI2p1sxMOByk0Z9po4Dg8j47ASVxrat8sVzhH9lY3ADYian8wQ9PzpGMZJv7 A5rkiZbGlNNc+ONF7xDCAM4xWV8MyCjga8ESmLLrkPfsf0S99OuQEmM1H5TaTOeqK19K 4jwCHe1pbRULdpnI0IRpmyPS84Pu8HtlPjonohwIXlc2Vqqukv/NrUYkLtRMVWJFH+eh 1eLQXsde7DFvL2nYJTNfv35Qj4GiWLgAsl8/4rH1uImIZYBp4yPOjsPnblpkXMj6HI7t 6lxGIADozkiwXlmWihChcWjsDRSD2kUQb0ifWcERhc2gOUFHz2zlgtL/Oouaa+M66gcc Fw7g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721115336; x=1721720136; h=mime-version:message-id:date:references:in-reply-to:subject:cc:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=liElh604OPcs9JLLhCamV/AChUeOF9e4gQ2lOyfKdTQ=; b=Y8gPbfjJNZf0/VyHWiVuEpaKg6hpuTgywvwzhBSG9bCRVHGiGLNHUc0uxm1k8rKNgD fFoK3B98U29swraS39H/SUvxJxkhbOwvDF/Hujj6fgD56WsWBJNHv8TAUEA4T9Pme5t2 wvCi82goqQv7wTmZn0PHAPnmYhB0/gbz3s4CcDdBWQiQZjIbii3ckDl5FC2Tn4uypuMJ 36rJRljN37wrL437VRsNhHXfQlsXiFe6jONT4psRtYNbB7Wd6VDxCiGWakviwcpYhW70 a87ZGoclQCtJf9vPu2lTPJbC/SaxLXbtY9HuZfPiucvoG+gbqfPbO1pxRSsfDll3woGe wjlA== X-Forwarded-Encrypted: i=1; AJvYcCXO4j70KKMUjo4oYSVkW8IvsIAVtSwW/zuuHCkGicxVh1zojLXp0vVLT7rn+2VArxWUaBT+5QsKm6CIN40yrNDGag+t0g== X-Gm-Message-State: AOJu0Yy1t2ohJGex6JplV5wY7i45/LTo91wpYcv4ENaWWPECQk4o9kQN 1wb/w54ZEINgxDq+Zh2W9zHQAjqduTH3A5TbMlCHw7iXZWW9OgSsMhwijdaKEi0= X-Google-Smtp-Source: AGHT+IHatGchwpTFz5HA9xImbl6IqAfgln0v187S0oe++/i9uY22s9Uch0G48qXmh3FfHH399LeSFQ== X-Received: by 2002:a05:600c:190d:b0:426:6171:6083 with SMTP id 5b1f17b1804b1-427ba678b94mr9048915e9.13.1721115336194; Tue, 16 Jul 2024 00:35:36 -0700 (PDT) Received: from localhost ([82.66.159.240]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-3680db0481fsm8177249f8f.106.2024.07.16.00.35.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jul 2024 00:35:35 -0700 (PDT) From: Mattijs Korpershoek To: Simon Glass , U-Boot Mailing List Cc: Tom Rini , Heinrich Schuchardt , Simon Glass , Quentin Schulz Subject: Re: [PATCH v2 02/14] doc: Move bootstd into its own directory In-Reply-To: <20240716070419.1897560-3-sjg@chromium.org> References: <20240716070419.1897560-1-sjg@chromium.org> <20240716070419.1897560-3-sjg@chromium.org> Date: Tue, 16 Jul 2024 09:35:32 +0200 Message-ID: <8734o9okl7.fsf@baylibre.com> MIME-Version: 1.0 Content-Type: text/plain X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.8 at phobos.denx.de X-Virus-Status: Clean Hi Simon, Thank you for the patch. On mar., juil. 16, 2024 at 08:04, Simon Glass wrote: > Before adding more files, move the bootstd docs into a new directory, > with an index. > > Signed-off-by: Simon Glass > Reviewed-by: Quentin Schulz Reviewed-by: Mattijs Korpershoek > --- > > (no changes since v1) > > MAINTAINERS | 2 +- > doc/board/starfive/milk-v_mars_cm.rst | 2 +- > doc/develop/board_best_practices.rst | 2 +- > doc/develop/bootstd/index.rst | 9 +++++++++ > doc/develop/{bootstd.rst => bootstd/overview.rst} | 14 +++++++------- > doc/develop/index.rst | 2 +- > doc/usage/cmd/bootdev.rst | 2 +- > doc/usage/cmd/bootflow.rst | 2 +- > doc/usage/cmd/bootmeth.rst | 2 +- > doc/usage/environment.rst | 2 +- > 10 files changed, 24 insertions(+), 15 deletions(-) > create mode 100644 doc/develop/bootstd/index.rst > rename doc/develop/{bootstd.rst => bootstd/overview.rst} (99%) > > diff --git a/MAINTAINERS b/MAINTAINERS > index 9bee9284cca..86b830aa997 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -927,7 +927,7 @@ F: boot/bootmeth*.c > F: boot/bootstd.c > F: cmd/bootdev.c > F: cmd/bootflow.c > -F: doc/develop/bootstd.rst > +F: doc/develop/bootstd/ > F: doc/usage/bootdev.rst > F: doc/usage/bootflow.rst > F: doc/usage/bootmeth.rst > diff --git a/doc/board/starfive/milk-v_mars_cm.rst b/doc/board/starfive/milk-v_mars_cm.rst > index b31de6043bb..52d4e5e9098 100644 > --- a/doc/board/starfive/milk-v_mars_cm.rst > +++ b/doc/board/starfive/milk-v_mars_cm.rst > @@ -89,7 +89,7 @@ provide a default value. > > The variable *$fdtfile* is used in the boot process to automatically load > a device-tree provided by the operating system. For details of the boot > -process refer to the :doc:`U-Boot Standard Boot <../../../develop/bootstd>` > +process refer to the :doc:`/develop/bootstd/index` > description. > > Boot source selection > diff --git a/doc/develop/board_best_practices.rst b/doc/develop/board_best_practices.rst > index f44401eab7d..09632c80ce7 100644 > --- a/doc/develop/board_best_practices.rst > +++ b/doc/develop/board_best_practices.rst > @@ -7,7 +7,7 @@ In addition to the regular best practices such as using :doc:`checkpatch` and > following the :doc:`docstyle` and the :doc:`codingstyle` there are some things > which are specific to creating a new board port. > > -* Implement :doc:`bootstd` to ensure that most operating systems will be > +* Implement :doc:`bootstd/index` to ensure that most operating systems will be > supported by the platform. > > * The platform defconfig file must be generated via `make savedefconfig`. > diff --git a/doc/develop/bootstd/index.rst b/doc/develop/bootstd/index.rst > new file mode 100644 > index 00000000000..f4f87c7787c > --- /dev/null > +++ b/doc/develop/bootstd/index.rst > @@ -0,0 +1,9 @@ > +.. SPDX-License-Identifier: GPL-2.0+: > + > +Standard Boot > +============= > + > +.. toctree:: > + :maxdepth: 2 > + > + overview > diff --git a/doc/develop/bootstd.rst b/doc/develop/bootstd/overview.rst > similarity index 99% > rename from doc/develop/bootstd.rst > rename to doc/develop/bootstd/overview.rst > index 34631089ae0..761f61a573b 100644 > --- a/doc/develop/bootstd.rst > +++ b/doc/develop/bootstd/overview.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0+: > > -U-Boot Standard Boot > -==================== > +Standard Boot Overview > +====================== > > Introduction > ------------ > @@ -17,7 +17,7 @@ introduces the following concepts: > For Linux, the distro (Linux distribution, e.g. Debian, Fedora) is responsible > for creating a bootflow for each kernel combination that it wants to offer. > These bootflows are stored on media so they can be discovered by U-Boot. This > -feature is typically called `distro boot` (see :doc:`distro`) because it is > +feature is typically called `distro boot` (see :doc:`../distro`) because it is > a way for distributions to boot on any hardware. > > Traditionally U-Boot has relied on scripts to implement this feature. See > @@ -32,7 +32,7 @@ way to boot with U-Boot. The feature is extensible to different Operating > Systems (such as Chromium OS) and devices (beyond just block and network > devices). It supports EFI boot and EFI bootmgr too. > > -Finally, standard boot supports the operation of :doc:`vbe`. > +Finally, standard boot supports the operation of :doc:`../vbe`. > > Bootflow > -------- > @@ -427,16 +427,16 @@ Three commands are available: > > `bootdev` > Allows listing of available bootdevs, selecting a particular one and > - getting information about it. See :doc:`../usage/cmd/bootdev` > + getting information about it. See :doc:`/usage/cmd/bootdev` > > `bootflow` > Allows scanning one or more bootdevs for bootflows, listing available > bootflows, selecting one, obtaining information about it and booting it. > - See :doc:`../usage/cmd/bootflow` > + See :doc:`/usage/cmd/bootflow` > > `bootmeth` > Allow listing of available bootmethds and setting the order in which they > - are tried. See :doc:`../usage/cmd/bootmeth` > + are tried. See :doc:`/usage/cmd/bootmeth` > > .. _BootflowStates: > > diff --git a/doc/develop/index.rst b/doc/develop/index.rst > index f9c4bf839ee..c0107a783fc 100644 > --- a/doc/develop/index.rst > +++ b/doc/develop/index.rst > @@ -29,7 +29,7 @@ Implementation > > directories > bloblist > - bootstd > + bootstd/index > ci_testing > commands > config_binding > diff --git a/doc/usage/cmd/bootdev.rst b/doc/usage/cmd/bootdev.rst > index f759abab354..98a0f43c580 100644 > --- a/doc/usage/cmd/bootdev.rst > +++ b/doc/usage/cmd/bootdev.rst > @@ -22,7 +22,7 @@ Description > The `bootdev` command is used to manage bootdevs. It can list available > bootdevs, select one and obtain information about it. > > -See :doc:`../../develop/bootstd` for more information about bootdevs in general. > +See :doc:`/develop/bootstd/index` for more information about bootdevs in general. > > > bootdev list > diff --git a/doc/usage/cmd/bootflow.rst b/doc/usage/cmd/bootflow.rst > index 6519e4880a9..5d41fe37a7a 100644 > --- a/doc/usage/cmd/bootflow.rst > +++ b/doc/usage/cmd/bootflow.rst > @@ -26,7 +26,7 @@ Description > The `bootflow` command is used to manage bootflows. It can scan bootdevs to > locate bootflows, list them and boot them. > > -See :doc:`../../develop/bootstd` for more information. > +See :doc:`/develop/bootstd/index` for more information. > > Note that `CONFIG_BOOTSTD_FULL` (which enables `CONFIG_CMD_BOOTFLOW_FULL) must > be enabled to obtain full functionality with this command. Otherwise, it only > diff --git a/doc/usage/cmd/bootmeth.rst b/doc/usage/cmd/bootmeth.rst > index bac9fdf85cd..c3d2ec1574b 100644 > --- a/doc/usage/cmd/bootmeth.rst > +++ b/doc/usage/cmd/bootmeth.rst > @@ -21,7 +21,7 @@ Description > The `bootmeth` command is used to manage bootmeths. It can list them and change > the order in which they are used. > > -See :doc:`../../develop/bootstd` for more information. > +See :doc:`/develop/bootstd/index` for more information. > > > .. _bootmeth_order: > diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst > index 7d4b448cb30..cc33d3ec0f2 100644 > --- a/doc/usage/environment.rst > +++ b/doc/usage/environment.rst > @@ -100,7 +100,7 @@ to add environment variables. > > Board maintainers are encouraged to migrate to the text-based environment as it > is easier to maintain. The distro-board script still requires the old-style > -environments, so use :doc:`../develop/bootstd` instead. > +environments, so use :doc:`/develop/bootstd/index` instead. > > > List of environment variables > -- > 2.34.1