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 86F05C25B0E for ; Fri, 19 Aug 2022 06:34:41 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id B8AD5848DA; Fri, 19 Aug 2022 08:34:38 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org 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=linaro.org header.i=@linaro.org header.b="HgLzBf53"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 99CC484968; Fri, 19 Aug 2022 08:34:36 +0200 (CEST) Received: from mail-pg1-x530.google.com (mail-pg1-x530.google.com [IPv6:2607:f8b0:4864:20::530]) (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 8E25E84806 for ; Fri, 19 Aug 2022 08:34:33 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=takahiro.akashi@linaro.org Received: by mail-pg1-x530.google.com with SMTP id 12so3033240pga.1 for ; Thu, 18 Aug 2022 23:34:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date:from:to:cc; bh=YpbabjXu1SHGSYL5Cb9nG55PgZ+0j5tYese6czxj02s=; b=HgLzBf5390nvJ8vX1SXfUtcBkQ53nDn+MoetWJ38qVePfqwQXhc4NywKLq6t8DhJF3 HdWBHpo5Stybt5KHnkwKNUH5r/G4OQnthRaPBnJHIpsxmfGq8sXKMT3EeRY2tQsh5LwW KPx5mLE+EnjuBgEH/6AkxOrdql4VNiG4YOvOqQ6XaW5scjrkSTKjtO7gN5/2t6/NSbkZ zB3dIHXJUcbb40Xji/61ejdaKp78j9lxHcVTxq0jLEM4kNycw/dKMPqDWBOG35cIWRkO H0PtlNpPGBqiEJl+Ts2aW4u77rxmfuRkbNvPotztQxCZ4q5WtbRjRY2r4gAsZu3pAYNp /9dw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc; bh=YpbabjXu1SHGSYL5Cb9nG55PgZ+0j5tYese6czxj02s=; b=Dv0c0dcmdbuknkA7XPWHdyWAcwGoGaZoKDD9bbPlOD/cveyLBPBWUA94RITT8TKdWj 9FL0uvZPQhRSumn+mLLiZBq9WsQz8DiavjpiPWsB3fFchSXSD0sNzH+aVsYlewfhqsC8 RzWJE96Q6oHoghEwUv0OIej7S84+Dv5+EoKYGSvE+eXh0/V0ry54F5fNusJ/reWFDPWd AiqHHzaOeLyG8sKsQSlDftswww0uzuPrNEhU20jjOqMpxtY3dB5ahoazYF7XMQaCQfrj WBKoQXuofqvn8/U+rcP6YSmFZIf78RDOq70z3U8iu322B9t3FrH/RPWHXDVjhFTRDtCC CZIg== X-Gm-Message-State: ACgBeo0kg4CfhrJvwxNs4jSO69pCeNjviYknYOV23XUwepsGx3GDZRM9 UkCytIXcIf/DCIBQqV+kQawL2A== X-Google-Smtp-Source: AA6agR4Ke7WPQE6KnbKheAHep99FInr+BLEAXiICQj9FSTSck2YRsAtJCcwqF3ygYfE3RXO+ElDHkQ== X-Received: by 2002:a63:cc42:0:b0:41d:c915:ffd with SMTP id q2-20020a63cc42000000b0041dc9150ffdmr5062543pgi.161.1660890871773; Thu, 18 Aug 2022 23:34:31 -0700 (PDT) Received: from laputa ([2400:4050:c3e1:100:d8f6:519f:2123:6238]) by smtp.gmail.com with ESMTPSA id u1-20020a62d441000000b0052d0a93f6d5sm2698045pfl.116.2022.08.18.23.34.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 18 Aug 2022 23:34:30 -0700 (PDT) Date: Fri, 19 Aug 2022 15:34:26 +0900 From: Takahiro Akashi To: Masahisa Kojima Cc: u-boot@lists.denx.de, Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Mark Kettenis , Bin Meng , Marek Beh??n Subject: Re: [PATCH v11 8/9] doc:eficonfig: add documentation for eficonfig command Message-ID: <20220819063426.GA73684@laputa> Mail-Followup-To: Takahiro Akashi , Masahisa Kojima , u-boot@lists.denx.de, Heinrich Schuchardt , Ilias Apalodimas , Simon Glass , Mark Kettenis , Bin Meng , Marek Beh??n References: <20220817093614.32266-1-masahisa.kojima@linaro.org> <20220817093614.32266-9-masahisa.kojima@linaro.org> <20220819055714.GA72617@laputa> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: 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.6 at phobos.denx.de X-Virus-Status: Clean On Fri, Aug 19, 2022 at 03:15:09PM +0900, Masahisa Kojima wrote: > Hi Akashi-san, > > On Fri, 19 Aug 2022 at 14:57, Takahiro Akashi > wrote: > > > > On Wed, Aug 17, 2022 at 06:36:13PM +0900, Masahisa Kojima wrote: > > > Add documentation for eficonfig command. > > > > > > Signed-off-by: Masahisa Kojima > > > --- > > > No update since v10 > > > > > > Changes in v10: > > > - describe how to boot system after editting by eficonfig > > > > > > Changes in v8: > > > - command name is changed from "efimenu" to "eficonfig" > > > > > > Newly created in v7 > > > > > > doc/usage/cmd/eficonfig.rst | 63 +++++++++++++++++++++++++++++++++++++ > > > doc/usage/index.rst | 1 + > > > 2 files changed, 64 insertions(+) > > > create mode 100644 doc/usage/cmd/eficonfig.rst > > > > > > diff --git a/doc/usage/cmd/eficonfig.rst b/doc/usage/cmd/eficonfig.rst > > > new file mode 100644 > > > index 0000000000..958e96992c > > > --- /dev/null > > > +++ b/doc/usage/cmd/eficonfig.rst > > > @@ -0,0 +1,63 @@ > > > +.. SPDX-License-Identifier: GPL-2.0+ > > > +.. (C) Copyright 2022, Masahisa Kojima > > > + > > > +eficonfig command > > > +================= > > > + > > > +Synopsis > > > +-------- > > > +:: > > > + > > > + eficonfig > > > + > > > +Description > > > +----------- > > > + > > > +The "eficonfig" command uses U-Boot menu interface and privides > > > +a menu-driven UEFI variable maintenance feature. > > > +The "eficonfig" has the following menu entries. > > > + > > > +Add Boot Option > > > + Add new UEFI Boot Option. > > > + User can edit description, file path, and optional_data. > > > + > > > +Edit Boot Option > > > + Edit the existing UEFI Boot Option > > > + User can edit description, file path, and optional_data. > > > + > > > +Change Boot Order > > > + Change the order of UEFI BootOrder variable. > > > + > > > +Delete Boot Option > > > + Delete the UEFI Boot Option > > > + > > > +Configuration > > > +------------- > > > + > > > +The "eficonfig" command is enabled by:: > > > + > > > + CONFIG_CMD_EFICONFIG=y > > > + > > > +If CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, user can not enter > > > +U-Boot console. In this case, bootmenu can be used to invoke "eficonfig":: > > > + > > > + CONFIG_USE_PREBOOT=y > > > + CONFIG_PREBOOT="setenv bootmenu_0 UEFI Maintenance Menu=eficonfig" > > > + > > > +How to boot the system with newly added UEFI Boot Option > > > +'''''''''''''''''''''''''''''''''''''''''''''''''''''''' > > > + > > > +"eficonfig" command is responsible to configure the UEFI variables, > > > +not directly handle the system boot. > > > +The new Boot Option added by "eficonfig" is appended at the last entry > > > +of UEFI BootOrder variable, user may want to change the boot order > > > +through "Change Boot Order". > > > +If the bootmenu is enabled and "eficonfig" is configured as preboot command, > > > +the newly added Boot Options are enumerated in the bootmenu when user exits > > > +from the eficonfig menu. > > > > Right, and when user quits from eficonfig, bootmenu also quits. > > *If possible*, I expect that we return to bootmenu's screen > > directly for better user-experience :) > > > > Otherwise, we have to enable U-Boot console to re-invoke > > bootmenu. (we can instead reboot U-Boot, though.) > > If CONFIG_BOOTMENU_DISABLE_UBOOT_CONSOLE is enabled, bootmenu appears > again when user quits from eficonfig. Ah, okay but why not always enable this behavior on? -Takahiro Akashi > I need to describe this condition in the document. > > Thanks, > Masahisa Kojima > > > > > -Takahiro Akashi > > > > > +User may select the entry in the bootmenu to boot the system, or follow > > > +the U-Boot configuration the system already has. > > > + > > > +See also > > > +-------- > > > +* :doc:`bootmenu` provides a simple mechanism for creating menus with different boot items > > > diff --git a/doc/usage/index.rst b/doc/usage/index.rst > > > index 28f9683a3e..09f2928970 100644 > > > --- a/doc/usage/index.rst > > > +++ b/doc/usage/index.rst > > > @@ -35,6 +35,7 @@ Shell commands > > > cmd/conitrace > > > cmd/dm > > > cmd/echo > > > + cmd/eficonfig > > > cmd/env > > > cmd/event > > > cmd/exception > > > -- > > > 2.17.1 > > >