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
..
2022-04-21 10:11:25 +02:00
2022-04-21 10:11:25 +02:00
2024-09-10 13:22:47 +02:00
2021-08-26 13:53:56 +02:00
2021-03-23 22:31:53 +01:00
2021-03-23 22:31:53 +01:00
2022-04-21 10:11:25 +02:00
2022-04-21 10:11:25 +02:00
2022-04-21 10:11:25 +02:00
2021-04-30 12:59:54 +02:00
2021-04-30 12:59:54 +02:00
2021-04-30 12:59:54 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2021-03-23 22:31:05 +01:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2023-04-24 15:21:39 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-09-03 17:09:10 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-09-03 17:09:10 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-09-08 15:30:30 +02:00
2023-09-08 13:08:52 +03:00
2021-09-08 15:30:10 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2024-09-10 13:22:47 +02:00
2024-02-26 10:43:56 +01:00
2024-02-12 10:04:31 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2023-05-10 10:00:40 +02:00
2023-05-10 10:00:40 +02:00
2020-09-29 17:55:39 +02:00
2025-11-04 13:55:27 +01:00
2025-11-04 13:55:27 +01:00
2025-11-04 13:55:27 +01:00
2024-02-26 10:43:56 +01:00
2021-03-23 22:31:05 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-02-26 10:43:56 +01:00
2024-07-06 08:58:24 +02:00
2024-07-06 08:58:24 +02:00
2021-10-02 07:33:42 +02:00
2025-07-14 10:08:27 +02:00
2025-07-14 10:08:27 +02:00
2020-09-29 17:55:39 +02:00
2025-07-14 10:08:23 +02:00
2023-05-22 10:03:26 +02:00
2024-07-06 08:58:24 +02:00
2024-03-04 07:12:40 +01:00
2024-03-04 07:12:40 +01:00
2024-03-04 07:12:40 +01:00
2024-03-04 07:12:40 +01:00
2024-02-26 10:43:56 +01:00
2025-11-04 13:55:27 +01:00
2025-11-04 13:55:27 +01:00
2025-11-04 13:55:27 +01:00
2021-09-03 17:09:10 +02:00
2021-03-23 22:31:05 +01:00
2024-09-10 13:22:47 +02:00
2021-03-23 22:31:43 +01:00
2021-03-23 22:31:43 +01:00
2021-10-27 17:18:55 +02:00
2021-07-15 12:56:41 +02:00
2021-07-15 12:56:41 +02:00
2021-07-15 12:56:41 +02:00
2021-09-03 17:09:10 +02:00
2021-09-25 06:55:54 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +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-03-23 21:38:39 +01:00
2021-03-23 21:38:39 +01:00
2023-04-24 15:21:39 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2025-02-10 15:45:04 +01:00
2025-02-10 15:45:04 +01:00
2025-02-10 15:45:04 +01:00
2024-09-10 13:22:47 +02:00
2024-09-10 13:22:47 +02:00
2024-09-10 13:22:47 +02:00
2021-03-05 15:40:50 +01:00
2025-11-04 13:55:27 +01:00
2021-05-20 11:28:28 +02:00
2021-05-20 11:28:28 +02:00
2021-05-20 11:28:28 +02:00
2021-05-20 11:28:28 +02:00
2021-05-20 11:28:28 +02:00
2021-05-20 11:28:28 +02:00
2021-05-20 11:28:27 +02:00
2021-05-20 11:28:27 +02:00
2021-09-03 17:09:10 +02:00
2021-03-23 21:38:39 +01:00
2021-03-23 21:38:39 +01:00
2023-04-24 15:21:39 +02:00
2021-03-23 21:38:39 +01:00
2021-05-20 11:28:28 +02:00
2020-10-09 07:08:19 +02:00
2020-10-09 07:08:19 +02:00
2020-10-09 07:08:19 +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-03-23 22:31:05 +01: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-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2024-09-10 13:22:47 +02:00
2024-09-10 13:22:47 +02:00
2021-05-20 11:28:28 +02:00
2021-08-26 13:53:56 +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-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:29:37 +01:00
2021-09-27 08:23:25 +02:00
2021-03-23 22:29:37 +01: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
2023-04-24 15:21:39 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2021-08-26 13:53:56 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00
2023-04-24 15:21:39 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:43 +01:00
2021-03-23 22:31:43 +01:00
2021-03-23 22:31:31 +01:00
2025-09-16 13:31:40 -04:00
2021-03-05 15:40:50 +01: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
2023-04-24 15:21:39 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-08-26 13:53:56 +02:00
2021-08-26 13:53:56 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-04-30 12:59:54 +02:00
2021-04-30 12:59:54 +02:00
2021-04-30 12:59:54 +02:00
2023-04-24 15:21:39 +02:00
2023-04-24 15:21:39 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2023-04-26 07:52:45 +02:00
2023-04-26 07:52:45 +02:00
2023-04-26 07:52:45 +02:00
2023-04-26 07:52:45 +02:00
2023-04-26 07:52:45 +02:00
2023-04-26 07:52:45 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-09-27 08:23:25 +02:00
2021-03-23 22:31:05 +01:00
2021-03-23 22:31:05 +01:00