[PATCH] doc: replace @return by Return:

Simon Glass sjg at chromium.org
Wed Jan 26 17:10:11 CET 2022


Hi,

I'm ambivalent about this patch.

Pro:
- we can make everything use the correct @return in one go
- we have a lot of other churn so this is no different

Con:
it changes things that may not appear in the docs for a long time, if ever.
It is less effective without a checkpatch rule
The ordering of text within the comment is still not right in many cases
Sphinx is very simplistic and it would be nice to make it smarter

So I'd say if this can come with a checkpatch rule then I'm for it.
Otherwise we might be better off to fix files manually (@return and
ordering) as we add them to the docs.
Regards,
Simon


More information about the U-Boot mailing list