From: Markus Armbruster <armbru@redhat.com>
To: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Cc: michael.roth@amd.com, qemu-devel@nongnu.org
Subject: Re: [PATCH v3] qapi: Add documentation format validation
Date: Thu, 30 Oct 2025 19:11:10 +0100 [thread overview]
Message-ID: <87v7jwdzup.fsf@pond.sub.org> (raw)
In-Reply-To: <87ms58fpyn.fsf@pond.sub.org> (Markus Armbruster's message of "Thu, 30 Oct 2025 15:01:52 +0100")
Markus Armbruster <armbru@redhat.com> writes:
> Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> writes:
>
>> 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 <vsementsov@yandex-team.ru>
>> ---
>>
>> Hi all!
>>
>> This substitutes my previous attempt
>> "[PATCH v2 00/33] qapi: docs: width=70 and two spaces between sentences"
>> Supersedes: <20251011140441.297246-1-vsementsov@yandex-team.ru>
>>
>> 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.
>
> I'll post this today.
Make that tomorrow: docs/interop/firmware.json needs cleanup, or else
"make check" fails. Going to throw in docs/interop/vhost-user.json for
good measure.
[...]
next prev parent reply other threads:[~2025-10-30 18:12 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-29 17:30 [PATCH v3] qapi: Add documentation format validation Vladimir Sementsov-Ogievskiy
2025-10-30 14:01 ` Markus Armbruster
2025-10-30 18:11 ` Markus Armbruster [this message]
2025-10-31 9:42 ` Vladimir Sementsov-Ogievskiy
2025-10-31 10:00 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87v7jwdzup.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=michael.roth@amd.com \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@yandex-team.ru \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.