diff mbox series

[v11,8/9] doc:eficonfig: add documentation for eficonfig command

Message ID 20220817093614.32266-9-masahisa.kojima@linaro.org
State Superseded
Headers show
Series enable menu-driven UEFI variable maintenance | expand

Commit Message

Masahisa Kojima Aug. 17, 2022, 9:36 a.m. UTC 
Add documentation for eficonfig command.

Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
---
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

Comments

AKASHI Takahiro Aug. 19, 2022, 5:57 a.m. UTC | #1 
On Wed, Aug 17, 2022 at 06:36:13PM +0900, Masahisa Kojima wrote:
> Add documentation for eficonfig command.
> 
> Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
> ---
> 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 <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"
> +
> +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.)

-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<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
>
Masahisa Kojima Aug. 19, 2022, 6:15 a.m. UTC | #2 
Hi Akashi-san,

On Fri, 19 Aug 2022 at 14:57, Takahiro Akashi
<takahiro.akashi@linaro.org> wrote:
>
> On Wed, Aug 17, 2022 at 06:36:13PM +0900, Masahisa Kojima wrote:
> > Add documentation for eficonfig command.
> >
> > Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
> > ---
> > 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 <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"
> > +
> > +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.
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<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
> >
AKASHI Takahiro Aug. 19, 2022, 6:34 a.m. UTC | #3 
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
> <takahiro.akashi@linaro.org> wrote:
> >
> > On Wed, Aug 17, 2022 at 06:36:13PM +0900, Masahisa Kojima wrote:
> > > Add documentation for eficonfig command.
> > >
> > > Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
> > > ---
> > > 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 <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"
> > > +
> > > +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<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
> > >
Masahisa Kojima Aug. 19, 2022, 7:32 a.m. UTC | #4 
On Fri, 19 Aug 2022 at 15:34, Takahiro Akashi
<takahiro.akashi@linaro.org> wrote:
>
> 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
> > <takahiro.akashi@linaro.org> wrote:
> > >
> > > On Wed, Aug 17, 2022 at 06:36:13PM +0900, Masahisa Kojima wrote:
> > > > Add documentation for eficonfig command.
> > > >
> > > > Signed-off-by: Masahisa Kojima <masahisa.kojima@linaro.org>
> > > > ---
> > > > 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 <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"
> > > > +
> > > > +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?

Current behavior is bootmenu default behavior and I don't want
to change the existing bootmenu user experience.

Thanks,
Masahisa Kojima

>
> -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<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
> > > >
diff mbox series

Patch

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 <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"
+
+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.
+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<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