Hi Tom,
On 10/24/25 6:02 PM, Tom Rini wrote:
With the addition of general text about how the return value is handled,
reference that while retaining the additional information about setting
$seama_image_size
Reviewed-by: Quentin Schulz <[email protected]>
Signed-off-by: Tom Rini <[email protected]>
---
Cc: Heinrich Schuchardt <[email protected]>
---
doc/usage/cmd/seama.rst | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/doc/usage/cmd/seama.rst b/doc/usage/cmd/seama.rst
index 17fd559f4856..a6b00f32902e 100644
--- a/doc/usage/cmd/seama.rst
+++ b/doc/usage/cmd/seama.rst
@@ -56,8 +56,5 @@ The command is available if CONFIG_CMD_SEAMA=y.
Return value
------------
-The return value $? is set 0 (true) if the loading is succefull, and
-is set to 1 (false) in case of error.
-
-The environment variable $seama_image_size is set to the size of the
-loaded SEAMA image.
+Along with the general rules for setting $?, the environment variable
+$seama_image_size is set to the size of the loaded SEAMA image.
Maybe we could link to the general rules section.
Adding a cross-reference label above the text added in patch 01 and then
:ref:`the general rules for setting $? <the cross-reference link you'd add>`
should do the trick (note that we need to use a text for the reference
because the cross-reference in Sphinx cannot guess it for anything but a
section title, c.f.
https://www.sphinx-doc.org/en/master/usage/referencing.html#role-ref).
In any case,
Reviewed-by: Quentin Schulz <[email protected]>
Thanks!
Quentin
