[Concept,01/22] doc: sandbox: Update command-line options documentation

Message ID 20251003165525.440173-2-sjg@u-boot.org
State New
Headers
Series video: Enhancements to support a pointer |

Commit Message

Simon Glass Oct. 3, 2025, 4:54 p.m. UTC
  From: Simon Glass <sjg@chromium.org>

Some recent flags don't have documentation included. Before adding more
flags, fix these:

   -A, --no_term_present: For pager testing
   -k, --select_unittests: Select specific unit tests
   -P, --pager_bypass: Enable pager-bypass mode
   -W, --title: Set window title

Also fix the documentation for --double_lcd which uses -K not -k

Co-developed-by: Claude <noreply@anthropic.com>
Signed-off-by: Simon Glass <sjg@chromium.org>
---

 doc/arch/sandbox/sandbox.rst | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)
  

Patch

diff --git a/doc/arch/sandbox/sandbox.rst b/doc/arch/sandbox/sandbox.rst
index 89255cb14dd..31a670ce2ab 100644
--- a/doc/arch/sandbox/sandbox.rst
+++ b/doc/arch/sandbox/sandbox.rst
@@ -103,6 +103,9 @@  available options. Some of these are described below:
   even if CONFIG_AUTOBOOT_KEYED is enabled, since it interfers with tests and
   normal usage
 
+-A, --no_term_present
+  Assume no terminal is present. This is used for pager testing.
+
 -b. boot
   The distro boot feature doesn't run by default on sandbox, since it normally
   not vert useful. For the distro_bootcmds to succeed, quite a bit of setup is
@@ -162,7 +165,10 @@  available options. Some of these are described below:
   writes an elf file containing the extracted portion, then execs it. This
   argument provides the filename, so it can be removed before U-Boot exits.
 
--k, --double_lcd
+-k, --select_unittests <arg>
+  Select specific unit tests to run. This is only used with SPL.
+
+-K, --double_lcd
   Doubles the size of the emulated LCD, so that it appears bigger. This can be
   useful on large or high-resolution displays.
 
@@ -199,6 +205,9 @@  available options. Some of these are described below:
   each program is extracted from the original image and executed (see -j), this
   is the only way that subsequent phases can locate the full image.
 
+-P, --pager_bypass
+  Enable pager bypass mode for testing.
+
 -r, --read
   Read driver state from a dtb file. In conjunction with `-w`, this allows
   sandbox to save and restore emulated hardware state (such as a TPM) across
@@ -248,6 +257,9 @@  available options. Some of these are described below:
   sandbox to save and restore emulated hardware state (such as a TPM) across
   each U-Boot phase.
 
+-W, --title <title>
+  Set the window title for the sandbox display.
+
 
 Environment Variables
 ---------------------