Files
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
..
2020-08-03 08:28:08 +02:00
2019-10-22 09:26:12 +02:00
2019-10-22 09:26:12 +02:00
2019-10-22 09:26:12 +02:00
2019-10-22 09:26:12 +02:00
2019-10-22 09:26:12 +02:00
2015-05-05 18:39:01 +02:00
2023-09-08 13:08:52 +03:00
2015-05-05 18:39:01 +02:00
2019-10-22 09:26:12 +02:00
2015-05-05 18:39:01 +02:00
2019-10-22 09:26:12 +02:00
2017-01-16 10:10:35 +01:00
2017-01-16 10:10:35 +01:00
2017-01-16 10:10:35 +01:00
2017-01-16 10:10:35 +01:00
2017-01-16 10:10:35 +01:00
2019-10-22 09:26:12 +02:00
2015-05-05 18:39:01 +02:00
2015-05-05 18:39:00 +02:00
2015-05-05 18:39:00 +02:00
2019-10-22 09:26:12 +02:00
2019-10-22 09:26:12 +02:00
2019-10-22 09:26:12 +02:00
2020-08-03 08:28:08 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2021-09-27 08:23:25 +02:00