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>,
"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>
Subject: [PATCH 9/9] doc:eficonfig: add documentation for eficonfig command
Date: Fri, 15 Jul 2022 23:27:43 +0900 [thread overview]
Message-ID: <20220715142743.30137-10-masahisa.kojima@linaro.org> (raw)
In-Reply-To: <20220715142743.30137-1-masahisa.kojima@linaro.org>
Add documentation for eficonfig command.
Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
---
No change sinch v8
Changes in v8:
- command name is changed from "efimenu" to "eficonfig"
Newly created in v7
doc/usage/cmd/eficonfig.rst | 49 +++++++++++++++++++++++++++++++++++++
doc/usage/index.rst | 1 +
2 files changed, 50 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..f150d7301c
--- /dev/null
+++ b/doc/usage/cmd/eficonfig.rst
@@ -0,0 +1,49 @@
+.. 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 8b98629d6b..1afbb6bc5d 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
prev parent reply other threads:[~2022-07-15 14:26 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-15 14:27 [PATCH 0/9] enable menu-driven UEFI variable maintenance Masahisa Kojima
2022-07-15 14:27 ` [PATCH 1/9] efi_loader: move udevice pointer into struct efi_object Masahisa Kojima
2022-07-15 14:27 ` [PATCH 2/9] eficonfig: menu-driven addition of UEFI boot option Masahisa Kojima
2022-07-15 14:27 ` [PATCH 3/9] eficonfig: add "Edit Boot Option" menu entry Masahisa Kojima
2022-07-15 14:27 ` [PATCH 4/9] menu: add KEY_PLUS and KEY_MINUS handling Masahisa Kojima
2022-07-15 14:27 ` [PATCH 5/9] eficonfig: add "Change Boot Order" menu entry Masahisa Kojima
2022-07-15 14:27 ` [PATCH 6/9] eficonfig: add "Delete Boot Option" " Masahisa Kojima
2022-07-15 14:27 ` [PATCH 7/9] bootmenu: add removable media entries Masahisa Kojima
2022-07-15 14:27 ` [PATCH 8/9] doc:bootmenu: add description for UEFI boot support Masahisa Kojima
2022-07-15 14:27 ` Masahisa Kojima [this message]
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=20220715142743.30137-10-masahisa.kojima@linaro.org \
--to=masahisa.kojima@linaro.org \
--cc=bmeng.cn@gmail.com \
--cc=ilias.apalodimas@linaro.org \
--cc=marek.behun@nic.cz \
--cc=mark.kettenis@xs4all.nl \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).