From nobody Fri Nov 14 21:05:01 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=yandex-team.ru ARC-Seal: i=1; a=rsa-sha256; t=1760192357; cv=none; d=zohomail.com; s=zohoarc; b=MixYoWTW0fqt152PYYyPmACeQ9ScP01h6YP/9Mp5O5G9GMix554twOlx7kFNUZxrETrifdLnOk6Y3AFDfU050+jwc4Ew8937Qlq7bcBAzSUSGUAfsnRXu5ePnYcecqjPOUJqbWlM8J+7DzLIsbVa112GJKp2nK0sq8Fd685r9oA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1760192357; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=sM4YrvUNO+2zghtH3aLu00wsMr94BOpnclkexE7YIug=; b=BEWZ4Rm1oFFsFGNmkgC+rj8edapzUaZj7Jl4fVdBBl7AwNY4Qt4z9cWYeUIBkbwmYqfuBfb2f4V+Z7WVew0RwxFiiHtPpxsj8mOcBKipjNfuzQktFikqNyvrv2m3MJB+nlLLPC95JogHbHdEK5zwyEDHN8zTxfNf81eMedsn6tg= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1760192357014761.796686256502; Sat, 11 Oct 2025 07:19:17 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1v7aDX-0004F6-6i; Sat, 11 Oct 2025 10:05:03 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1v7aDS-0003rY-K8 for qemu-devel@nongnu.org; Sat, 11 Oct 2025 10:04:58 -0400 Received: from forwardcorp1a.mail.yandex.net ([178.154.239.72]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1v7aDK-0005ON-Gp for qemu-devel@nongnu.org; Sat, 11 Oct 2025 10:04:58 -0400 Received: from mail-nwsmtp-smtp-corp-main-83.vla.yp-c.yandex.net (mail-nwsmtp-smtp-corp-main-83.vla.yp-c.yandex.net [IPv6:2a02:6b8:c2d:7394:0:640:5a8a:0]) by forwardcorp1a.mail.yandex.net (Yandex) with ESMTPS id C8A26C017C; Sat, 11 Oct 2025 17:04:44 +0300 (MSK) Received: from vsementsov-lin.. (unknown [2a02:6bf:8080:a4b::1:3c]) by mail-nwsmtp-smtp-corp-main-83.vla.yp-c.yandex.net (smtpcorp/Yandex) with ESMTPSA id h4NOTl1FrqM0-tNeMICsr; Sat, 11 Oct 2025 17:04:44 +0300 X-Yandex-Fwd: 1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yandex-team.ru; s=default; t=1760191484; bh=sM4YrvUNO+2zghtH3aLu00wsMr94BOpnclkexE7YIug=; h=Message-ID:Date:In-Reply-To:Cc:Subject:References:To:From; b=tayZjSpPjtHh/y+Sp/zElhjjk7vHr5rFWVqAEyNQ47fA7zoZRiRfUYhJudE1W3r8X voHQMz8+Uqw1Vseiufifd32HcODk/q8Jl9PnJEXHpb5XNeV87gJiu1X+d2pmuPRFas LUJlMlkqbwygZz5tMhKnDtg4Vxp9qP3ym3DwdTeo= Authentication-Results: mail-nwsmtp-smtp-corp-main-83.vla.yp-c.yandex.net; dkim=pass header.i=@yandex-team.ru From: Vladimir Sementsov-Ogievskiy To: armbru@redhat.com Cc: qemu-devel@nongnu.org, vsementsov@yandex-team.ru, eblake@redhat.com, Michael Roth Subject: [PATCH v2 01/33] qapi: Add documentation format validation Date: Sat, 11 Oct 2025 17:04:07 +0300 Message-ID: <20251011140441.297246-2-vsementsov@yandex-team.ru> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20251011140441.297246-1-vsementsov@yandex-team.ru> References: <20251011140441.297246-1-vsementsov@yandex-team.ru> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=178.154.239.72; envelope-from=vsementsov@yandex-team.ru; helo=forwardcorp1a.mail.yandex.net X-Spam_score_int: -16 X-Spam_score: -1.7 X-Spam_bar: - X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @yandex-team.ru) X-ZM-MESSAGEID: 1760192361803158500 Content-Type: text/plain; charset="utf-8" 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 Signed-off-by: Vladimir Sementsov-Ogievskiy --- scripts/qapi/parser.py | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 9fbf80a541..2c76686fc4 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -428,7 +428,44 @@ def get_doc_line(self) -> Optional[str]: return '' if self.val[1] !=3D ' ': raise QAPIParseError(self, "missing space after #") - return self.val[2:].rstrip() + + line =3D self.val[2:].rstrip() + + 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 + """ + # Check 70-column width rule + full_line_length =3D len(line) + 2 # "# " =3D 2 characters + if full_line_length > 70: + # Skip URL lines - they can't be broken + stripped_line =3D 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 =3D r'[.!?] [A-Z0-9]' + for m in list(re.finditer(single_space_pattern, line)): + left =3D 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]}..." + ) =20 @staticmethod def _match_at_name_colon(string: str) -> Optional[Match[str]]: --=20 2.48.1