[PATCH v1] cmd/dma: documentation

Sune Brian briansune at gmail.com
Wed Oct 8 21:11:02 CEST 2025


Tom Rini <trini at konsulko.com> 於 2025年10月9日 週四 上午3:07寫道:
>
> On Thu, Oct 09, 2025 at 01:44:08AM +0800, Brian Sune wrote:
> > This explains how
> > to use the new U-Boot command 'dmareset'.
> >
> > Signed-off-by: Brian Sune <briansune at gmail.com>
> > ---
> >  doc/usage/cmd/dmareset.rst | 55 ++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 55 insertions(+)
> >  create mode 100644 doc/usage/cmd/dmareset.rst
>
> This needs to be included in doc/usage/index.rst (alphabetically sorted
> still) in the shell commands section. Also please do "make htmldocs
> KDOC_WERROR=1" and make sure there's no complains for v2, I see some
> style issues it will trigger. To build the docs a python venv is

I used the the checkpatch

$ ./scripts/checkpatch.pl v1-0001-cmd-dma-documentation.patch
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#16:
new file mode 100644

total: 0 errors, 1 warnings, 0 checks, 55 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

v1-0001-cmd-dma-documentation.patch has style problems, please review.

NOTE: Ignored message types: COMPLEX_MACRO CONSIDER_KSTRTO ENOSYS
MINMAX MULTISTATEMENT_MACRO_USE_DO_WHILE
NETWORKING_BLOCK_COMMENT_STYLE PREFER_ETHER_ADDR_COPY USLEEP_RANGE

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.


> suggested and you'll need to pip install -r doc/sphinx/requirements.txt
> -r test/py/requirements.txt.  Thanks!
>
> --
> Tom

The doc uses another checking tools?

Brian


More information about the U-Boot mailing list