| Message ID | 20221114093058.2443702-1-heinrich.schuchardt@canonical.com |
|---|---|
| State | Accepted, archived |
| Commit | 5727f922ca26b94db38c498935b0b3b75e3cbc4c |
| Delegated to: | Heinrich Schuchardt |
| Headers | show |
| Series | [1/1] Documentation: man-page for command bootd | expand |
On Mon, 14 Nov 2022 at 02:31, Heinrich Schuchardt <heinrich.schuchardt@canonical.com> wrote: > > Provide a man-page for the bootd command. > > Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> > --- > doc/usage/cmd/bootd.rst | 38 ++++++++++++++++++++++++++++++++++++++ > doc/usage/index.rst | 1 + > 2 files changed, 39 insertions(+) > create mode 100644 doc/usage/cmd/bootd.rst Reviewed-by: Simon Glass <sjg@chromium.org>
diff --git a/doc/usage/cmd/bootd.rst b/doc/usage/cmd/bootd.rst new file mode 100644 index 0000000000..380ef15283 --- /dev/null +++ b/doc/usage/cmd/bootd.rst @@ -0,0 +1,38 @@ +.. SPDX-License-Identifier: GPL-2.0+: + +bootd command +============= + +Synopsis +-------- + +:: + + bootd + +Description +----------- + +The bootd command executes the command stored in the environment variable +*bootcmd*, i.e. it does the same thing as *run bootcmd*. + +Example +------- + +:: + + => setenv bootcmd 'echo Hello World' + => bootd + Hello World + => setenv bootcmd true + => bootd; echo $? + 0 + => setenv bootcmd false + => bootd; echo $? + 1 + +Return value +------------ + +The return value $? of the bootd command is the return value of the command in +the environment variable *bootcmd*. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index f7f03aeac1..815b032247 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -23,6 +23,7 @@ Shell commands cmd/addrmap cmd/askenv cmd/base + cmd/bootd cmd/bootdev cmd/bootefi cmd/bootflow
Provide a man-page for the bootd command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> --- doc/usage/cmd/bootd.rst | 38 ++++++++++++++++++++++++++++++++++++++ doc/usage/index.rst | 1 + 2 files changed, 39 insertions(+) create mode 100644 doc/usage/cmd/bootd.rst