All of lore.kernel.org
 help / color / mirror / Atom feed
From: Masahisa Kojima <masahisa.kojima@linaro.org>
To: u-boot@lists.denx.de
Cc: "Heinrich Schuchardt" <xypron.glpk@gmx.de>,
	"Ilias Apalodimas" <ilias.apalodimas@linaro.org>,
	"Simon Glass" <sjg@chromium.org>,
	"Takahiro Akashi" <takahiro.akashi@linaro.org>,
	"Francois Ozog" <francois.ozog@linaro.org>,
	"Mark Kettenis" <mark.kettenis@xs4all.nl>,
	"Masahisa Kojima" <masahisa.kojima@linaro.org>,
	"Bin Meng" <bmeng.cn@gmail.com>,
	"Marek Behún" <marek.behun@nic.cz>,
	"Patrick Delaunay" <patrick.delaunay@foss.st.com>,
	"Roland Gaudig" <roland.gaudig@weidmueller.com>
Subject: [PATCH v8 9/9] doc:eficonfig: add documentation for eficonfig command
Date: Sun, 19 Jun 2022 13:56:07 +0900	[thread overview]
Message-ID: <20220619045607.1669-10-masahisa.kojima@linaro.org> (raw)
In-Reply-To: <20220619045607.1669-1-masahisa.kojima@linaro.org>

Add documentation for eficonfig command.

Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
---
Changes in v8:
- command name is changed from "efimenu" to "eficonfig"

Newly created in v7

 doc/usage/cmd/eficonfig.rst | 50 +++++++++++++++++++++++++++++++++++++
 doc/usage/index.rst         |  1 +
 2 files changed, 51 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..93b2df306d
--- /dev/null
+++ b/doc/usage/cmd/eficonfig.rst
@@ -0,0 +1,50 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. (C) Copyright 2022, Masahisa Kojima <masahisa.kojima@linaro.org>
+
+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"
+
+See also
+--------
+* :doc:`bootmenu<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 c03f4aef9e..106dbfa1b2 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -33,6 +33,7 @@ Shell commands
    cmd/cbsysinfo
    cmd/conitrace
    cmd/echo
+   cmd/eficonfig
    cmd/env
    cmd/event
    cmd/exception
-- 
2.17.1


  parent reply	other threads:[~2022-06-19  4:56 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-19  4:55 [PATCH v8 0/9] enable menu-driven UEFI variable maintenance Masahisa Kojima
2022-06-19  4:55 ` [PATCH v8 1/9] efi_loader: expose END device path node Masahisa Kojima
2022-07-10  9:10   ` Heinrich Schuchardt
2022-07-11 11:32     ` Ilias Apalodimas
2022-06-19  4:56 ` [PATCH v8 2/9] eficonfig: menu-driven addition of UEFI boot option Masahisa Kojima
2022-07-10  9:03   ` Heinrich Schuchardt
2022-07-12  1:55     ` Takahiro Akashi
2022-07-12  6:25       ` Heinrich Schuchardt
2022-07-12 10:59     ` Masahisa Kojima
2022-07-15 14:02       ` Masahisa Kojima
2022-07-14  2:07     ` Takahiro Akashi
2022-06-19  4:56 ` [PATCH v8 3/9] eficonfig: add "Edit Boot Option" menu entry Masahisa Kojima
2022-07-10  9:08   ` Heinrich Schuchardt
2022-07-12  7:04     ` Masahisa Kojima
2022-06-19  4:56 ` [PATCH v8 4/9] menu: add KEY_PLUS and KEY_MINUS handling Masahisa Kojima
2022-07-10  9:09   ` Heinrich Schuchardt
2022-06-19  4:56 ` [PATCH v8 5/9] eficonfig: add "Change Boot Order" menu entry Masahisa Kojima
2022-06-19  4:56 ` [PATCH v8 6/9] eficonfig: add "Delete Boot Option" " Masahisa Kojima
2022-06-19  4:56 ` [PATCH v8 7/9] bootmenu: add removable media entries Masahisa Kojima
2022-06-19  4:56 ` [PATCH v8 8/9] doc:bootmenu: add description for UEFI boot support Masahisa Kojima
2022-06-19  4:56 ` Masahisa Kojima [this message]
2022-06-20  4:14 ` [PATCH v8 0/9] enable menu-driven UEFI variable maintenance Takahiro Akashi

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=20220619045607.1669-10-masahisa.kojima@linaro.org \
    --to=masahisa.kojima@linaro.org \
    --cc=bmeng.cn@gmail.com \
    --cc=francois.ozog@linaro.org \
    --cc=ilias.apalodimas@linaro.org \
    --cc=marek.behun@nic.cz \
    --cc=mark.kettenis@xs4all.nl \
    --cc=patrick.delaunay@foss.st.com \
    --cc=roland.gaudig@weidmueller.com \
    --cc=sjg@chromium.org \
    --cc=takahiro.akashi@linaro.org \
    --cc=u-boot@lists.denx.de \
    --cc=xypron.glpk@gmx.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.