[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists
From: |
Markus Armbruster |
Subject: |
Re: [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists |
Date: |
Fri, 07 Feb 2020 13:07:56 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) |
Peter Maydell <address@hidden> writes:
> A JSON block comment like this:
> Returns: nothing on success
> If @node is not a valid block device, DeviceNotFound
> If @name is not found, GenericError with an explanation
>
> renders in the HTML and manpage like this:
>
> Returns: nothing on success If node is not a valid block device,
> DeviceNotFound If name is not found, GenericError with an explanation
>
> because whitespace is not significant.
Pretty much the same in plain text and PDF. Unsurprising, as all are
generated from the same, flawed TexInfo. Suggest "renders like this".
>
> Use an actual bulleted list, so that the formatting is correct.
>
> Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
- [PATCH 15/29] qapi/ui.json: Use explicit bulleted lists, (continued)
- [PATCH 20/29] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/06
- [PATCH 21/29] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/06
- [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- Re: [PATCH 14/29] qapi/block-core.json: Use explicit bulleted lists,
Markus Armbruster <=
- [PATCH 16/29] qapi/{block, misc, tmp}.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
- [PATCH 19/29] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/06
[PATCH 09/29] qapi: Fix indent level on doc comments in json files, Peter Maydell, 2020/02/06
[PATCH 27/29] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/02/06