* [PATCH v1] cmd/dma: documentation
@ 2025-10-08 17:44 Brian Sune
2025-10-08 19:07 ` Tom Rini
0 siblings, 1 reply; 9+ messages in thread
From: Brian Sune @ 2025-10-08 17:44 UTC (permalink / raw)
To: Tom Rini, u-boot
This explains how
to use the new U-Boot command 'dmareset'.
Signed-off-by: Brian Sune <briansune@gmail.com>
---
doc/usage/cmd/dmareset.rst | 55 ++++++++++++++++++++++++++++++++++++++
1 file changed, 55 insertions(+)
create mode 100644 doc/usage/cmd/dmareset.rst
diff --git a/doc/usage/cmd/dmareset.rst b/doc/usage/cmd/dmareset.rst
new file mode 100644
index 00000000000..cf48ad91c5c
--- /dev/null
+++ b/doc/usage/cmd/dmareset.rst
@@ -0,0 +1,55 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+.. index::
+ single: dmareset (command)
+
+ command
+===========
+
+Synopsis
+--------
+
+::
+
+ Usage: dmareset <channel 0-7> [<channel 0-7> ...]
+ dmareset - Release PL330 DMA channel reset(s) for SoCFPGA
+
+ Usage:
+ dmareset <channel 0-7> [<channel 0-7> ...] - release reset for one or more DMA channels
+
+dmareset channel
+----------------
+
+Release the DMA channel reset *channel*.
+
+Parameters
+----------
+
+channel
+ DMA channel number
+
+Example
+-------
+
+Release DMA channel(s)::
+
+ => dmareset 0
+ PL330 DMA channel 0 reset released
+ => dmareset 1
+ PL330 DMA channel 1 reset released
+ => dmareset 0 1
+ PL330 DMA channel 0 reset released
+ PL330 DMA channel 1 reset released
+
+
+Configuration
+-------------
+
+The dmareset command is only available if CONFIG_CMD_C5_PL330_DMA=y in
+"Shell scripting commands".
+
+Return value
+------------
+
+If the command succeds the return PL330 DMA channel $? reset released.
+If an error occurs, the return Error: channel must be 0-7.
--
2.47.1.windows.1
^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 17:44 [PATCH v1] cmd/dma: documentation Brian Sune
@ 2025-10-08 19:07 ` Tom Rini
2025-10-08 19:11 ` Sune Brian
0 siblings, 1 reply; 9+ messages in thread
From: Tom Rini @ 2025-10-08 19:07 UTC (permalink / raw)
To: Brian Sune; +Cc: u-boot
[-- Attachment #1: Type: text/plain, Size: 755 bytes --]
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@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
suggested and you'll need to pip install -r doc/sphinx/requirements.txt
-r test/py/requirements.txt. Thanks!
--
Tom
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 19:07 ` Tom Rini
@ 2025-10-08 19:11 ` Sune Brian
2025-10-08 19:33 ` Tom Rini
0 siblings, 1 reply; 9+ messages in thread
From: Sune Brian @ 2025-10-08 19:11 UTC (permalink / raw)
To: Tom Rini; +Cc: u-boot
Tom Rini <trini@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@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
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 19:11 ` Sune Brian
@ 2025-10-08 19:33 ` Tom Rini
2025-10-08 19:35 ` Sune Brian
0 siblings, 1 reply; 9+ messages in thread
From: Tom Rini @ 2025-10-08 19:33 UTC (permalink / raw)
To: Sune Brian; +Cc: u-boot
[-- Attachment #1: Type: text/plain, Size: 2175 bytes --]
On Thu, Oct 09, 2025 at 03:11:02AM +0800, Sune Brian wrote:
> Tom Rini <trini@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@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?
We have an outstanding update to checkpatch.pl that may or may not be
better for rST (as the kernel has been using it more and more), but this
is analogous to compiler warnings when building code, checkpatch.pl
won't catch that (but I manually enabled this driver in a build to check
it before pushing).
--
Tom
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 19:33 ` Tom Rini
@ 2025-10-08 19:35 ` Sune Brian
2025-10-08 19:46 ` Tom Rini
0 siblings, 1 reply; 9+ messages in thread
From: Sune Brian @ 2025-10-08 19:35 UTC (permalink / raw)
To: Tom Rini; +Cc: u-boot
Tom Rini <trini@konsulko.com> 於 2025年10月9日 週四 上午3:33寫道:
> > > 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
There is an issue I am not sure it is ok.
My system is old python 3.10 is not allowed.
Could I downgrade pip library version to make the require documents?
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 19:35 ` Sune Brian
@ 2025-10-08 19:46 ` Tom Rini
2025-10-08 20:16 ` Sune Brian
0 siblings, 1 reply; 9+ messages in thread
From: Tom Rini @ 2025-10-08 19:46 UTC (permalink / raw)
To: Sune Brian; +Cc: u-boot
[-- Attachment #1: Type: text/plain, Size: 1004 bytes --]
On Thu, Oct 09, 2025 at 03:35:21AM +0800, Sune Brian wrote:
> Tom Rini <trini@konsulko.com> 於 2025年10月9日 週四 上午3:33寫道:
>
> > > > 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
>
> There is an issue I am not sure it is ok.
> My system is old python 3.10 is not allowed.
> Could I downgrade pip library version to make the require documents?
Probably so, yes. Most of the style issues are things like:
These two lines must be the same length
=======================================
And then the new file not being included in any other file and so an
orphan. If you pushed things through CI before, it will run a test to
catch all of this:
https://docs.u-boot.org/en/latest/develop/ci_testing.html
--
Tom
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 19:46 ` Tom Rini
@ 2025-10-08 20:16 ` Sune Brian
2025-10-08 20:24 ` Tom Rini
0 siblings, 1 reply; 9+ messages in thread
From: Sune Brian @ 2025-10-08 20:16 UTC (permalink / raw)
To: Tom Rini; +Cc: u-boot
Tom Rini <trini@konsulko.com> 於 2025年10月9日 週四 上午3:46寫道:
> > > > > 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
without adding any rst
make htmldocs KDOC_WERROR=1
HOSTCC scripts/basic/fixdep
SPHINX htmldocs --> file:///media/sf_shared/u-boot/doc/output
PARSE include/linker_lists.h
Running Sphinx v8.1.3
enabling CJK for LaTeX builder
loading translations [en]... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst':
'restructuredtext'}`.
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 694 source files that are out of date
updating environment: [new config] 694 added, 0 changed, 0 removed
reading sources... [100%] usage/fit/kernel_fdt .. usage/upl
looking for now-outdated files... none found
pickling environment... done
checking consistency...
/media/sf_shared/u-boot/doc/develop/package/bintools.rst: WARNING:
document isn't included in any toctree
/media/sf_shared/u-boot/doc/develop/package/entries.rst: WARNING:
document isn't included in any toctree
done
preparing documents... done
copying assets...
copying downloadable files... [100%] ../Licenses/README
copying static files...
Writing evaluated template result to
/media/sf_shared/u-boot/doc/output/_static/basic.css
Writing evaluated template result to
/media/sf_shared/u-boot/doc/output/_static/language_data.js
Writing evaluated template result to
/media/sf_shared/u-boot/doc/output/_static/documentation_options.js
Writing evaluated template result to
/media/sf_shared/u-boot/doc/output/_static/js/versions.js
copying static files: done
copying extra files...
copying extra files: done
copying assets: done
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/package/index.rst:16: WARNING:
toctree contains reference to document 'develop/package/binman' that
doesn't have a title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/package/index.rst:16: WARNING:
toctree contains reference to document 'develop/package/binman' that
doesn't have a title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/uefi/uefi.rst:379: WARNING:
undefined label: 'etype_efi_capsule' [ref.ref]
/media/sf_shared/u-boot/doc/build/index.rst:6: WARNING: toctree
contains reference to document 'build/buildman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/package/index.rst:16: WARNING:
toctree contains reference to document 'develop/package/binman' that
doesn't have a title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/package/index.rst:16: WARNING:
toctree contains reference to document 'develop/package/binman' that
doesn't have a title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/package/index.rst:16: WARNING:
toctree contains reference to document 'develop/package/binman' that
doesn't have a title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
/media/sf_shared/u-boot/doc/develop/index.rst:9: WARNING: toctree
contains reference to document 'develop/patman' that doesn't have a
title: no link will be generated [toc.no_title]
writing output... [100%] usage/fit/x86-fit-boot .. usage/upl
generating indices... genindex py-modindex done
Creating redirect 'develop/py_testing.html' to 'pytest/usage.html'.
writing additional pages... search done
copying images... [100%] develop/pics/flamegraph_timing.png
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 125 warnings (with warnings treated as errors).
doc/Makefile:70: recipe for target 'htmldocs' failed
make[1]: *** [htmldocs] Error 1
Makefile:2687: recipe for target 'htmldocs' failed
make: *** [htmldocs] Error 2
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 20:16 ` Sune Brian
@ 2025-10-08 20:24 ` Tom Rini
2025-10-08 20:31 ` Sune Brian
0 siblings, 1 reply; 9+ messages in thread
From: Tom Rini @ 2025-10-08 20:24 UTC (permalink / raw)
To: Sune Brian; +Cc: u-boot
[-- Attachment #1: Type: text/plain, Size: 1458 bytes --]
On Thu, Oct 09, 2025 at 04:16:51AM +0800, Sune Brian wrote:
> Tom Rini <trini@konsulko.com> 於 2025年10月9日 週四 上午3:46寫道:
>
> > > > > > 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
>
> without adding any rst
>
> make htmldocs KDOC_WERROR=1
> HOSTCC scripts/basic/fixdep
> SPHINX htmldocs --> file:///media/sf_shared/u-boot/doc/output
> PARSE include/linker_lists.h
> Running Sphinx v8.1.3
> enabling CJK for LaTeX builder
> loading translations [en]... done
> Converting `source_suffix = '.rst'` to `source_suffix = {'.rst':
> 'restructuredtext'}`.
> building [mo]: targets for 0 po files that are out of date
> writing output...
> building [html]: targets for 694 source files that are out of date
> updating environment: [new config] 694 added, 0 changed, 0 removed
> reading sources... [100%] usage/fit/kernel_fdt .. usage/upl
> looking for now-outdated files... none found
> pickling environment... done
> checking consistency...
> /media/sf_shared/u-boot/doc/develop/package/bintools.rst: WARNING:
> document isn't included in any toctree
I'm not sure what's going on with your environment, sorry, you might
have to just push things to CI. All of those errors don't make any
sense. Docs are build that way as part of every CI run, so they aren't
generally speaking broken.
--
Tom
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [PATCH v1] cmd/dma: documentation
2025-10-08 20:24 ` Tom Rini
@ 2025-10-08 20:31 ` Sune Brian
0 siblings, 0 replies; 9+ messages in thread
From: Sune Brian @ 2025-10-08 20:31 UTC (permalink / raw)
To: Tom Rini; +Cc: u-boot
Tom Rini <trini@konsulko.com> 於 2025年10月9日 週四 上午4:24寫道:
> I'm not sure what's going on with your environment, sorry, you might
> have to just push things to CI. All of those errors don't make any
> sense. Docs are build that way as part of every CI run, so they aren't
> generally speaking broken.
Aaaa. Python sometime is very touchy. So unless there are a general
env that can be shared to test this is no good as well.
I do see a warning on the previous .rst so I fixed it and no warning related
to the new .rst file.
I just patch as such can't do much no this.
As for the built I had already use another system with 3.10 python.
Yet still returns those thing on dry run. Very puzzling.
Brian
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2025-10-08 20:31 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-08 17:44 [PATCH v1] cmd/dma: documentation Brian Sune
2025-10-08 19:07 ` Tom Rini
2025-10-08 19:11 ` Sune Brian
2025-10-08 19:33 ` Tom Rini
2025-10-08 19:35 ` Sune Brian
2025-10-08 19:46 ` Tom Rini
2025-10-08 20:16 ` Sune Brian
2025-10-08 20:24 ` Tom Rini
2025-10-08 20:31 ` Sune Brian
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.