|WARNING| pw134399-134400 [PATCH] [v1,2/2] dts: add doc generation

[dpdklab at iol.unh.edu]

Test-Label: iol-testing
Test-Status: WARNING
http://dpdk.org/patch/134399

_apply patch failure_

Submitter: Juraj Linkes <juraj.linkes at pantheon.tech>
Date: Wednesday, November 15 2023 13:36:06 
Applied on: CommitID:fbafb3676c482dab60c0b5465b47f2ea33893a36
Apply patch set 134399-134400 failed:

Checking patch dts/poetry.lock...
error: while searching for:
[metadata]
lock-version = "2.0"
python-versions = "^3.10"
content-hash = "3501e97b3dadc19fe8ae179fe21b1edd2488001da9a8e86ff2bca0b86b99b89b"

error: patch failed: dts/poetry.lock:837
Checking patch dts/pyproject.toml...
Hunk #1 succeeded at 34 (offset -1 lines).
Applying patch dts/poetry.lock with 1 reject...
Hunk #1 applied cleanly.
Hunk #2 applied cleanly.
Hunk #3 applied cleanly.
Hunk #4 applied cleanly.
Hunk #5 applied cleanly.
Hunk #6 applied cleanly.
Hunk #7 applied cleanly.
Hunk #8 applied cleanly.
Hunk #9 applied cleanly.
Hunk #10 applied cleanly.
Hunk #11 applied cleanly.
Hunk #12 applied cleanly.
Hunk #13 applied cleanly.
Hunk #14 applied cleanly.
Rejected hunk #15.
Applied patch dts/pyproject.toml cleanly.
hint: Use 'git am --show-current-patch' to see the failed patch
diff a/dts/poetry.lock b/dts/poetry.lock	(rejected hunks)
@@ -837,4 +1334,4 @@ jsonschema = ">=4,<5"
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.10"
-content-hash = "3501e97b3dadc19fe8ae179fe21b1edd2488001da9a8e86ff2bca0b86b99b89b"
+content-hash = "44c0fd4ebd7a1630ad104d55a25ef85d361abc968157254e757d44e340bca06f"
Checking patch buildtools/call-sphinx-build.py...
Checking patch doc/api/meson.build...
Checking patch doc/guides/conf.py...
Checking patch doc/guides/meson.build...
Checking patch doc/guides/tools/dts.rst...
error: while searching for:
and try not to divert much from it. The :ref:`DTS developer tools <dts_dev_tools>` will issue
warnings when some of the basics are not met.

The code must be properly documented with docstrings. The style must conform to
the `Google style <https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings>`_.
See an example of the style
`here <https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html>`_.

error: patch failed: doc/guides/tools/dts.rst:283
Hunk #2 succeeded at 335 (offset -76 lines).
Checking patch dts/doc/conf_yaml_schema.json...
Checking patch dts/doc/index.rst...
Checking patch dts/doc/meson.build...
Checking patch dts/meson.build...
Checking patch meson.build...
Applied patch buildtools/call-sphinx-build.py cleanly.
Applied patch doc/api/meson.build cleanly.
Applied patch doc/guides/conf.py cleanly.
Applied patch doc/guides/meson.build cleanly.
Applying patch doc/guides/tools/dts.rst with 1 reject...
Rejected hunk #1.
Hunk #2 applied cleanly.
Applied patch dts/doc/conf_yaml_schema.json cleanly.
Applied patch dts/doc/index.rst cleanly.
Applied patch dts/doc/meson.build cleanly.
Applied patch dts/meson.build cleanly.
Applied patch meson.build cleanly.
hint: Use 'git am --show-current-patch' to see the failed patch
diff a/doc/guides/tools/dts.rst b/doc/guides/tools/dts.rst	(rejected hunks)
@@ -283,7 +283,10 @@ When adding code to the DTS framework, pay attention to the rest of the code
 and try not to divert much from it. The :ref:`DTS developer tools <dts_dev_tools>` will issue
 warnings when some of the basics are not met.
 
-The code must be properly documented with docstrings. The style must conform to
+The API documentation, which is a helpful reference when developing, may be accessed
+in the code directly or generated with the `API docs build steps <building_api_docs>`_.
+
+Speaking of which, the code must be properly documented with docstrings. The style must conform to
 the `Google style <https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings>`_.
 See an example of the style
 `here <https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html>`_.

https://lab.dpdk.org/results/dashboard/patchsets/28387/

UNH-IOL DPDK Community Lab