summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRasmus Villemoes <[email protected]>2026-07-08 22:37:10 +0200
committerTom Rini <[email protected]>2026-07-21 13:51:07 -0600
commita2daa32913e6e96d47930e408d9b4f3b844bdfb7 (patch)
tree86d2d52b3cbbbf9e2a64f088a783e01d8b573896
parent304e18c9437550096e667adaa60acb6c4423d1f8 (diff)
doc: document 'config' command
Add a little documentation for the config command and its new ability to filter the output. Signed-off-by: Rasmus Villemoes <[email protected]> Reviewed-by: Simon Glass <[email protected]>
-rw-r--r--doc/usage/cmd/config.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/usage/cmd/config.rst b/doc/usage/cmd/config.rst
new file mode 100644
index 00000000000..bd8aa65ddbc
--- /dev/null
+++ b/doc/usage/cmd/config.rst
@@ -0,0 +1,40 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. index::
+ single: config (command)
+
+config command
+==============
+
+Synopsis
+--------
+
+::
+
+ config [<str>]
+
+Description
+-----------
+
+The config command prints the `.config` file used when building U-Boot
+to the console. Note that the `.config` file is usually several 1000
+lines long.
+
+If the optional argument is given, only lines containing that string
+(case insensitively) are printed. That can be useful if one wants to
+check whether a specific option is enabled, or just to limit the
+output to the subsystem of interest.
+
+The `.config` file is stored inside the U-Boot binary in
+gzip-compressed format.
+
+Examples
+--------
+
+.. code-block:: bash
+
+ # Print the entire .config
+ config
+
+ # Print all lines related to pinctrl
+ config pinctrl