Add explicit validation for QAPI documentation formatting rules: 1. Lines must not exceed 70 columns in width (including '# ' prefix) 2. Sentences must be separated by two spaces
Example sections are excluded, we don't require them to be <= 70, that would be too restrictive. Example sections share common 80-columns recommendations (not requirements). Signed-off-by: Vladimir Sementsov-Ogievskiy <[email protected]> --- Hi all! This substitutes my previous attempt "[PATCH v2 00/33] qapi: docs: width=70 and two spaces between sentences" Supersedes: <[email protected]> v3: 01: ignore example sections other commits: dropped :) Of course, this _does not_ build on top of current master. v3 is to be based on top of coming soon doc-cleanup series by Markus. scripts/qapi/parser.py | 46 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 9fbf80a541..b9d76fff39 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -108,6 +108,9 @@ def __init__(self, self.exprs: List[QAPIExpression] = [] self.docs: List[QAPIDoc] = [] + # State for tracking qmp-example blocks + self._in_qmp_example = False + # Showtime! self._parse() @@ -423,12 +426,53 @@ def get_doc_line(self) -> Optional[str]: if self.val != '##': raise QAPIParseError( self, "junk after '##' at end of documentation comment") + self._in_qmp_example = False return None if self.val == '#': return '' if self.val[1] != ' ': raise QAPIParseError(self, "missing space after #") - return self.val[2:].rstrip() + + line = self.val[2:].rstrip() + + if line.startswith('.. qmp-example::'): + self._in_qmp_example = True + + if not self._in_qmp_example: + self._validate_doc_line_format(line) + + return line + + def _validate_doc_line_format(self, line: str) -> None: + """ + Validate documentation format rules for a single line: + 1. Lines should not exceed 70 columns + 2. Sentences should be separated by two spaces + """ + full_line_length = len(line) + 2 # "# " = 2 characters + if full_line_length > 70: + # Skip URL lines - they can't be broken + stripped_line = line.strip() + if (stripped_line.startswith(('http://', 'https://', 'ftp://')) and + ' ' not in stripped_line): + pass + else: + raise QAPIParseError( + self, f"documentation line exceeds 70 columns " + f"({full_line_length} columns): {line[:50]}..." + ) + + single_space_pattern = r'[.!?] [A-Z0-9]' + for m in list(re.finditer(single_space_pattern, line)): + left = line[0:m.start() + 1] + # Ignore abbreviations and numbered lists + if left.endswith('e.g.') or re.fullmatch(r' *\d\.', left): + continue + raise QAPIParseError( + self, f"documentation has single space after sentence " + f"ending. Use two spaces between sentences: " + f"...{line[m.start()-5:m.end()+5]}..." + ) @staticmethod def _match_at_name_colon(string: str) -> Optional[Match[str]]: -- 2.48.1
