Re: [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build

[no-reply]

Patchew URL: https://patchew.org/QEMU/address@hidden/



Hi,

This series seems to have some coding style problems. See output below for
more information:

Subject: [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build
Type: series
Message-id: address@hidden

=== TEST SCRIPT BEGIN ===
#!/bin/bash
git rev-parse base > /dev/null || exit 0
git config --local diff.renamelimit 0
git config --local diff.renames True
git config --local diff.algorithm histogram
./scripts/checkpatch.pl --mailback base..
=== TEST SCRIPT END ===

Switched to a new branch 'test'
b3ce185 docs: add memory API reference
de50eba memory.h: Silence kernel-doc complaints
0f0cc93 docs: Create bitops.rst as example of kernel-docs
7de419c bitops.h: Silence kernel-doc complaints
0ac6a81 Makefile: disable Sphinx nitpicking
0b3c7c9 docs/conf.py: Enable use of kerneldoc sphinx extension
10457ca docs: tweak kernel-doc for QEMU coding standards
f7a1036 docs: import Linux kernel-doc script and extension

=== OUTPUT BEGIN ===
1/8 Checking commit f7a103632856 (docs: import Linux kernel-doc script and 
extension)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#20: 
new file mode 100644

WARNING: line over 80 characters
#102: FILE: docs/sphinx/kerneldoc.py:78:
+        tab_width = self.options.get('tab-width', 
self.state.document.settings.tab_width)

WARNING: line over 80 characters
#132: FILE: docs/sphinx/kerneldoc.py:108:
+            p = subprocess.Popen(cmd, stdout=subprocess.PIPE, 
stderr=subprocess.PIPE)

ERROR: line over 90 characters
#141: FILE: docs/sphinx/kerneldoc.py:117:
+                               'kernel-doc \'%s\' failed with return code %d' 
% (" ".join(cmd), p.returncode))

WARNING: line over 80 characters
#142: FILE: docs/sphinx/kerneldoc.py:118:
+                return [nodes.error(None, nodes.paragraph(text = "kernel-doc 
missing"))]

WARNING: line over 80 characters
#146: FILE: docs/sphinx/kerneldoc.py:122:
+            lines = statemachine.string2lines(out, tab_width, 
convert_whitespace=True)

WARNING: line over 80 characters
#167: FILE: docs/sphinx/kerneldoc.py:143:
+            kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: 
%s' %

WARNING: line over 80 characters
#169: FILE: docs/sphinx/kerneldoc.py:145:
+            return [nodes.error(None, nodes.paragraph(text = "kernel-doc 
missing"))]

ERROR: line over 90 characters
#176: FILE: docs/sphinx/kerneldoc.py:152:
+            save = self.state.memo.title_styles, 
self.state.memo.section_level, self.state.memo.reporter

WARNING: line over 80 characters
#177: FILE: docs/sphinx/kerneldoc.py:153:
+            self.state.memo.reporter = AutodocReporter(result, 
self.state.memo.reporter)

ERROR: line over 90 characters
#182: FILE: docs/sphinx/kerneldoc.py:158:
+                self.state.memo.title_styles, self.state.memo.section_level, 
self.state.memo.reporter = save

total: 3 errors, 8 warnings, 2426 lines checked

Patch 1/8 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.

2/8 Checking commit 10457ca7be94 (docs: tweak kernel-doc for QEMU coding 
standards)
3/8 Checking commit 0b3c7c9f8788 (docs/conf.py: Enable use of kerneldoc sphinx 
extension)
4/8 Checking commit 0ac6a8162879 (Makefile: disable Sphinx nitpicking)
5/8 Checking commit 7de419c91dc7 (bitops.h: Silence kernel-doc complaints)
6/8 Checking commit 0f0cc9310e25 (docs: Create bitops.rst as example of 
kernel-docs)
WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
#18: 
new file mode 100644

total: 0 errors, 1 warnings, 12 lines checked

Patch 6/8 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
7/8 Checking commit de50ebaf7d96 (memory.h: Silence kernel-doc complaints)
WARNING: Block comments use a leading /* on a separate line
#21: FILE: include/exec/memory.h:363:
+/** MemoryRegion:

total: 0 errors, 1 warnings, 43 lines checked

Patch 7/8 has style problems, please review.  If any of these errors
are false positives report them to the maintainer, see
CHECKPATCH in MAINTAINERS.
8/8 Checking commit b3ce1857d7cb (docs: add memory API reference)
=== OUTPUT END ===

Test command exited with code: 1


The full log is available at
http://patchew.org/logs/address@hidden/testing.checkpatch/?type=message.
---
Email generated automatically by Patchew [https://patchew.org/].
Please send your feedback to address@hidden