[PATCH v2 3/3] doc: seama: Reword return value section

[Tom Rini]

On Fri, Oct 24, 2025 at 07:03:55PM +0200, Quentin Schulz wrote:
> 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 <quentin.schulz at cherry.de>
> > Signed-off-by: Tom Rini <trini at konsulko.com>
> > ---
> > Cc: Heinrich Schuchardt <xypron.glpk at gmx.de>
> > ---
> >   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).

One of my goals is to reduce the work needed for every command doc that
we add. I want to simplify doc/usage/index.rst as well (I think we can
glob), and then maybe add a note to the start of that section? I'll play
around...

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20251024/cf6e6283/attachment.sig>