]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
doc: document 'config' command
authorRasmus Villemoes <rv@rasmusvillemoes.dk>
Wed, 8 Jul 2026 20:37:10 +0000 (22:37 +0200)
committerTom Rini <trini@konsulko.com>
Tue, 21 Jul 2026 19:51:07 +0000 (13:51 -0600)
Add a little documentation for the config command and its new ability
to filter the output.

Signed-off-by: Rasmus Villemoes <rv@rasmusvillemoes.dk>
Reviewed-by: Simon Glass <sjg@chromium.org>
doc/usage/cmd/config.rst [new file with mode: 0644]

diff --git a/doc/usage/cmd/config.rst b/doc/usage/cmd/config.rst
new file mode 100644 (file)
index 0000000..bd8aa65
--- /dev/null
@@ -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