diff options
| author | Simon Glass <sjg@chromium.org> | 2023-06-01 19:23:02 +0300 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2023-07-14 19:54:51 +0300 |
| commit | a0874dc4ac7153f49f72c3fb818422d940ecbfea (patch) | |
| tree | 301951243204c9654b3c85dc4b85db985d1e2e28 /doc | |
| parent | 82cafee133ee5c087449761988c096fc26a17cf6 (diff) | |
| download | u-boot-a0874dc4ac7153f49f72c3fb818422d940ecbfea.tar.xz | |
expo: Add a configuration editor
Add a new 'cedit' command which allows editing configuration using an
expo. The configuration items appear as menus on the display.
This is extremely basic, only supporting menus and not providing any way
to load or save the configuration.
Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/develop/expo.rst | 8 | ||||
| -rw-r--r-- | doc/usage/cmd/cedit.rst | 31 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
3 files changed, 37 insertions, 3 deletions
diff --git a/doc/develop/expo.rst b/doc/develop/expo.rst index f5caadbfd9..2ac4af232d 100644 --- a/doc/develop/expo.rst +++ b/doc/develop/expo.rst @@ -171,8 +171,6 @@ menu-inset menuitem-gap-y Number of pixels between menu items -.. _expo_format: - Pop-up mode ----------- @@ -202,6 +200,8 @@ just as its title and label, as with the `CPU Speed` and `AC Power` menus here:: UP and DOWN to choose, ENTER to select +.. _expo_format: + Expo Format ----------- @@ -211,7 +211,8 @@ makes it easier and faster to create and edit the description. An expo builder is provided to convert this format into an expo structure. Layout of the expo scenes is handled automatically, based on a set of simple -rules. +rules. The :doc:`../usage/cmd/cedit` can be used to load a configuration +and create an expo from it. Top-level node ~~~~~~~~~~~~~~ @@ -464,6 +465,7 @@ Some ideas for future work: - Support unicode - Support curses for proper serial-terminal menus - Add support for large menus which need to scroll +- Add support for reading and writing configuration settings with cedit .. Simon Glass <sjg@chromium.org> .. 7-Oct-22 diff --git a/doc/usage/cmd/cedit.rst b/doc/usage/cmd/cedit.rst new file mode 100644 index 0000000000..8e1110c7c7 --- /dev/null +++ b/doc/usage/cmd/cedit.rst @@ -0,0 +1,31 @@ +.. SPDX-License-Identifier: GPL-2.0+: + +cedit command +============= + +Synopis +------- + +:: + + cedit load <interface> <dev[:part]> <filename> + cedit run + +Description +----------- + +The *cedit* command is used to load a configuration-editor description and allow +the user to interact with it. + +It makes use of the expo subsystem. + +The description is in the form of a devicetree file, as documented at +:ref:`expo_format`. + +Example +------- + +:: + + => cedit load hostfs - fred.dtb + => cedit run diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 388e59f173..f2ffd2787a 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -39,6 +39,7 @@ Shell commands cmd/bootz cmd/cat cmd/cbsysinfo + cmd/cedit cmd/cls cmd/cmp cmd/coninfo |