| Simon Glass | a0874dc | 2023-06-01 10:23:02 -0600 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0+: |
| 2 | |
| 3 | cedit command |
| 4 | ============= |
| 5 | |
| 6 | Synopis |
| 7 | ------- |
| 8 | |
| 9 | :: |
| 10 | |
| 11 | cedit load <interface> <dev[:part]> <filename> |
| 12 | cedit run |
| 13 | |
| 14 | Description |
| 15 | ----------- |
| 16 | |
| 17 | The *cedit* command is used to load a configuration-editor description and allow |
| 18 | the user to interact with it. |
| 19 | |
| 20 | It makes use of the expo subsystem. |
| 21 | |
| 22 | The description is in the form of a devicetree file, as documented at |
| 23 | :ref:`expo_format`. |
| 24 | |
| Simon Glass | c5aacf5 | 2023-08-14 16:40:29 -0600 | [diff] [blame] | 25 | See :doc:`../../develop/cedit` for information about the configuration editor. |
| 26 | |
| Simon Glass | d65ccbb | 2023-08-14 16:40:31 -0600 | [diff] [blame^] | 27 | cedit load |
| 28 | ~~~~~~~~~~ |
| 29 | |
| 30 | Loads a configuration-editor description from a file. It creates a new cedit |
| 31 | structure ready for use. Initially no settings are read, so default values are |
| 32 | used for each object. |
| 33 | |
| 34 | cedit run |
| 35 | ~~~~~~~~~ |
| 36 | |
| 37 | Runs the default configuration-editor event loop. This is very simple, just |
| 38 | accepting character input and moving through the objects under user control. |
| 39 | The implementation is at `cedit_run()`. |
| 40 | |
| 41 | |
| Simon Glass | a0874dc | 2023-06-01 10:23:02 -0600 | [diff] [blame] | 42 | Example |
| 43 | ------- |
| 44 | |
| 45 | :: |
| 46 | |
| 47 | => cedit load hostfs - fred.dtb |
| 48 | => cedit run |