Re: [PATCH 09/13] qapi: convert "Note" sections to plain rST

[Markus Armbruster]

Markus Armbruster <armbru@redhat.com> writes:

> John Snow <jsnow@redhat.com> writes:

[...]

>> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
>> index b3de1fb6b3a..57598331c5c 100644
>> --- a/qga/qapi-schema.json
>> +++ b/qga/qapi-schema.json

[...]

>> @@ -631,8 +632,8 @@
>>  # Errors:
>>  #     - If hybrid suspend is not supported, Unsupported
>>  #
>> -# Notes: It's strongly recommended to issue the guest-sync command
>> -#     before sending commands when the guest resumes
>> +# .. note:: It's strongly recommended to issue the guest-sync command
>> +#    before sending commands when the guest resumes.
>>  #
>>  # Since: 1.1
>>  ##
>> @@ -1461,16 +1462,15 @@
>>  #     * POSIX: as defined by os-release(5)
>>  #     * Windows: contains string "server" or "client"
>>  #
>> -# Notes: On POSIX systems the fields @id, @name, @pretty-name,
>> -#     @version, @version-id, @variant and @variant-id follow the
>> -#     definition specified in os-release(5). Refer to the manual page
>> -#     for exact description of the fields.  Their values are taken
>> -#     from the os-release file.  If the file is not present in the
>> -#     system, or the values are not present in the file, the fields
>> -#     are not included.
>> +# .. note:: On POSIX systems the fields @id, @name, @pretty-name,
>> +#    @version, @version-id, @variant and @variant-id follow the
>> +#    definition specified in os-release(5). Refer to the manual page for
>> +#    exact description of the fields.  Their values are taken from the
>> +#    os-release file.  If the file is not present in the system, or the
>> +#    values are not present in the file, the fields are not included.
>>  #
>> -#     On Windows the values are filled from information gathered from
>> -#     the system.
>> +#    On Windows the values are filled from information gathered from
>> +#    the system.
>
> Please don't change the indentation here.  I get the same output with
>
>   @@ -1461,7 +1462,7 @@
>    #     * POSIX: as defined by os-release(5)
>    #     * Windows: contains string "server" or "client"
>    #
>   -# Notes: On POSIX systems the fields @id, @name, @pretty-name,
>   +# .. note:: On POSIX systems the fields @id, @name, @pretty-name,
>    #     @version, @version-id, @variant and @variant-id follow the
>    #     definition specified in os-release(5). Refer to the manual page
>    #     for exact description of the fields.  Their values are taken

I'm blind.  Actually, you change indentation of subsequent lines from 4
to 3 *everywhere*.  I guess you do that to make subsequent lines line up
with the directive, here "note".

Everywhere else, we indent such lines by 4.  Hmm.  How terrible would it
be not to mess with the alignment?

If we want to use 3 for directives, is it worth pointing out in the
commit message?

[...]