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

[Masahisa Kojima]

On Tue, 19 Jul 2022 at 21:52, Ilias Apalodimas
<ilias.apalodimas at linaro.org> wrote:
>
> On Tue, 19 Jul 2022 at 13:15, Masahisa Kojima
> <masahisa.kojima at linaro.org> wrote:
> >
> > Hi Ilias,
> >
> > On Tue, 19 Jul 2022 at 17:03, Ilias Apalodimas
> > <ilias.apalodimas at linaro.org> wrote:
> > >
> > > Hello Kojima-san
> > >
> > > On Fri, 15 Jul 2022 at 17:45, Masahisa Kojima
> > > <masahisa.kojima at linaro.org> wrote:
> > > >
> > > > Add documentation for eficonfig command.
> > > >
> > > > Signed-off-by: Masahisa Kojima <masahisa.kojima at 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
> > > >