diff mbox series

[RESEND,v9,9/9] doc:eficonfig: add documentation for eficonfig command

Message ID 20220715144749.30564-10-masahisa.kojima@linaro.org
State New
Headers show
Series enable menu-driven UEFI variable maintenance | expand

Commit Message

Masahisa Kojima July 15, 2022, 2:47 p.m. UTC 
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

Comments

Ilias Apalodimas July 19, 2022, 8:03 a.m. UTC | #1 
Hello Kojima-san

On Fri, 15 Jul 2022 at 17:45, Masahisa Kojima
<masahisa.kojima@linaro.org> wrote:
>
> 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 +

[...]

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

Can't we just set it as the default bootcmd? Does it have to be a
preboot command?

Thanks
/Ilias
> +
> +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
>
Masahisa Kojima July 19, 2022, 10:15 a.m. UTC | #2 
Hi Ilias,

On Tue, 19 Jul 2022 at 17:03, Ilias Apalodimas
<ilias.apalodimas@linaro.org> wrote:
>
> Hello Kojima-san
>
> On Fri, 15 Jul 2022 at 17:45, Masahisa Kojima
> <masahisa.kojima@linaro.org> wrote:
> >
> > 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 +
>
> [...]
>
> > +
> > +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"
>
> Can't we just set it as the default bootcmd? Does it have to be a
> preboot command?

"eficonfig" command is for updating UEFI variables(BOOT#### and
BootOrder, etc.) only.
User can not boot the system with "eficonfig" command, so I think it
is not the desired
option to set it as default bootcmd.

Thanks,
Masahisa Kojima

>
> Thanks
> /Ilias
> > +
> > +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
> >
Ilias Apalodimas July 19, 2022, 12:52 p.m. UTC | #3 
On Tue, 19 Jul 2022 at 13:15, Masahisa Kojima
<masahisa.kojima@linaro.org> wrote:
>
> Hi Ilias,
>
> On Tue, 19 Jul 2022 at 17:03, Ilias Apalodimas
> <ilias.apalodimas@linaro.org> wrote:
> >
> > Hello Kojima-san
> >
> > On Fri, 15 Jul 2022 at 17:45, Masahisa Kojima
> > <masahisa.kojima@linaro.org> wrote:
> > >
> > > 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 +
> >
> > [...]
> >
> > > +
> > > +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"
> >
> > Can't we just set it as the default bootcmd? Does it have to be a
> > preboot command?
>
> "eficonfig" command is for updating UEFI variables(BOOT#### and
> BootOrder, etc.) only.
> User can not boot the system with "eficonfig" command, so I think it
> is not the desired
> option to set it as default bootcmd.

Ok then we should describe a bit what functionality it offers.
The user can now configure eficonfig as a preboot command and that
will pop up on each boot.  If the U-Boot timeout expires (which is
unaffected by the eficonfig) the board will boot with whatever
configuration it already has.  If the user starts editing options
though he has to hit the 'exit' button for the board to boot.

Thanks
/Ilias
>
> Thanks,
> Masahisa Kojima
>
> >
> > Thanks
> > /Ilias
> > > +
> > > +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
> > >
Masahisa Kojima July 22, 2022, 2:03 a.m. UTC | #4 
On Tue, 19 Jul 2022 at 21:52, Ilias Apalodimas
<ilias.apalodimas@linaro.org> wrote:
>
> On Tue, 19 Jul 2022 at 13:15, Masahisa Kojima
> <masahisa.kojima@linaro.org> wrote:
> >
> > Hi Ilias,
> >
> > On Tue, 19 Jul 2022 at 17:03, Ilias Apalodimas
> > <ilias.apalodimas@linaro.org> wrote:
> > >
> > > Hello Kojima-san
> > >
> > > On Fri, 15 Jul 2022 at 17:45, Masahisa Kojima
> > > <masahisa.kojima@linaro.org> wrote:
> > > >
> > > > 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 +
> > >
> > > [...]
> > >
> > > > +
> > > > +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"
> > >
> > > Can't we just set it as the default bootcmd? Does it have to be a
> > > preboot command?
> >
> > "eficonfig" command is for updating UEFI variables(BOOT#### and
> > BootOrder, etc.) only.
> > User can not boot the system with "eficonfig" command, so I think it
> > is not the desired
> > option to set it as default bootcmd.
>
> Ok then we should describe a bit what functionality it offers.
> The user can now configure eficonfig as a preboot command and that
> will pop up on each boot.  If the U-Boot timeout expires (which is
> unaffected by the eficonfig) the board will boot with whatever
> configuration it already has.  If the user starts editing options
> though he has to hit the 'exit' button for the board to boot.

OK, I will describe further.

Thanks,
Masahisa Kojima

>
> Thanks
> /Ilias
> >
> > Thanks,
> > Masahisa Kojima
> >
> > >
> > > Thanks
> > > /Ilias
> > > > +
> > > > +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
> > > >
diff mbox series

Patch

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