[PATCH 1/1] doc: update font man-page
Heinrich Schuchardt
heinrich.schuchardt at canonical.com
Sat Jan 21 17:22:32 CET 2023
* add return values
* move configuration to separate section to match other man-pages
* fix typo
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
doc/usage/cmd/font.rst | 19 ++++++++++++-------
1 file changed, 12 insertions(+), 7 deletions(-)
diff --git a/doc/usage/cmd/font.rst b/doc/usage/cmd/font.rst
index 6fb0823270..0974b2dcc1 100644
--- a/doc/usage/cmd/font.rst
+++ b/doc/usage/cmd/font.rst
@@ -12,33 +12,27 @@ Synopis
font select <name> [<size>]
font size <size>
-
Description
-----------
The *font* command allows selection of the font to use on the video console.
-This is available when the Truetype console is in use. This is the case when
-`CONFIG_CONSOLE_TRUETYPE` is enabled.
-
+This is available when the TrueType console is in use.
font list
~~~~~~~~~
This lists the available fonts, using the name of the font file in the build.
-
font select
~~~~~~~~~~~
This selects a new font and optionally changes the size.
-
font size
~~~~~~~~~
This changes the font size only.
-
Examples
--------
@@ -50,3 +44,14 @@ Examples
=> font size 40
=> font select cantoraone_regular 20
=>
+
+Configuration
+-------------
+
+The command is only available if CONFIG_CONSOLE_TRUETYPE=y.
+
+Return value
+------------
+
+The return value $? is 0 (true) if the command completes.
+The return value is 1 (false) if the command fails.
--
2.38.1
More information about the U-Boot
mailing list