Files
qemu/scripts
Vladimir Sementsov-Ogievskiy 8107ba47fd qapi: Add documentation format validation
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 and literal :: blocks (seldom case) are excluded, we
don't require them to be <= 70, that would be too restrictive. Anyway,
they share common 80-columns recommendations (not requirements).

Add two simple tests, illustrating the change.

Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Message-ID: <20251031183129.246814-1-vsementsov@yandex-team.ru>

The detection of example and literal blocks isn't quite correct, but
it works well enough, and we can improve on top.

Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Comments, error messages, and test file names tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2025-11-04 13:55:27 +01:00
..
2023-09-08 13:08:52 +03:00
2025-10-09 09:48:35 +02:00
2023-09-08 13:08:52 +03:00
2025-10-03 15:14:48 +02:00
2025-09-22 17:17:18 +02:00
2025-04-13 13:45:41 +03:00