[PATCH v5 0/4] fix -Werror issues

Mauro Carvalho Chehab posted 4 patches 3 weeks ago
scripts/kernel-doc.py                | 79 ++++++++++++++++++----------
tools/lib/python/kdoc/kdoc_parser.py | 35 +++++++++---
2 files changed, 78 insertions(+), 36 deletions(-)
[PATCH v5 0/4] fix -Werror issues
Posted by Mauro Carvalho Chehab 3 weeks ago
Hi Jon,

As pointed by Jani, and previously by Randy, several warnings
are currently not considered as errors. The issue is related
to changeset 469c1c9eb6c9 ("kernel-doc: Issue warnings that were silently
discarded"), which was using directly a low-level interface.

Patch 1 fix that.
Patch 2 fixes a related issue: when there are more than 255
errors, the return code with -Werror can be 0 even on errors,
because of glibc behavior: programs can only use 8 bits for
error codes.

Patches 3 and 4 are not directly related, and touches only
on comments inside python-doc.py script itself:

- patch 3 is just a coding style change to match the comment
  style we agreed;

- patch 4 fixes some English issues on comments. The issues
  were pointed by LLM, which was used as any other spelling
  tool: I picked just the relevant changes, ignoring the ones
  that were false positives. I also didn't agree with one of
  the changes, replacing it by something else.

  I wrote it more as an experiment about how to properly use
  LLM. IMO, it could be useful to use LLM to review spelling
  on docs, provided that the one using the tool will filter
  out LLM-generated trash - just like one does when using any
  other spelling tool. Yet, based on Jani feedback, extra
  care is needed with regards to LLM abuse of UTF-8 chars.

---

v5:
  - fixed some kernel-doc docstrings on patch 2 and 4.

v4:
  - improved description on patch 4;
  - fixed some typos and problems at patch2 comments;
  - fixed a potential sphinx.ext.autodoc issue.

v3:
  - did some cleanups at patch 1, placing the code on a new
    function;
  - removed extra blank line after comments

v2:
  - on patch 2, I changed the -Werror return code to "3". This
    way, it is easier for a script to identify what happened;
  - removed UTF-8 unbreakable whitespaces from patch 4.
    Heh, it seems that LLM-produced stuff can suffer with
    unwanted UTF-8 chars... On one of the strings it replaced
    0x20 with 0xa0...

Mauro Carvalho Chehab (4):
  scripts/kernel-doc: fix logic to handle unissued warnings
  scripts/kernel-doc: avoid error_count overflows
  scripts/kernel-doc: ensure that comments are using our coding style
  scripts/kernel-doc: some fixes to kernel-doc comments

 scripts/kernel-doc.py                | 79 ++++++++++++++++++----------
 tools/lib/python/kdoc/kdoc_parser.py | 35 +++++++++---
 2 files changed, 78 insertions(+), 36 deletions(-)

-- 
2.52.0