[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 17/17] qapi: Reformat doc comments to conform to current conv
From: |
Juan Quintela |
Subject: |
Re: [PATCH 17/17] qapi: Reformat doc comments to conform to current conventions |
Date: |
Fri, 28 Apr 2023 19:51:41 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/28.2 (gnu/linux) |
Markus Armbruster <armbru@redhat.com> wrote:
> Change
>
> # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
> # do eiusmod tempor incididunt ut labore et dolore magna aliqua.
>
> to
>
> # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
> # do eiusmod tempor incididunt ut labore et dolore magna aliqua.
>
> See recent commit "qapi: Relax doc string @name: description
> indentation rules" for rationale.
>
> Reflow paragraphs to 70 columns width, and consistently use two spaces
> to separate sentences.
>
> To check the generated documentation does not change, I compared the
> generated HTML before and after this commit with "wdiff -3". Finds no
> differences. Comparing with diff is not useful, as the reflown
> paragraphs are visible there.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
I am really trusting your run of wdiff -3 O:-)
I haven't read the whole diff.
- Re: [PATCH 16/17] qga/qapi-schema: Reformat doc comments to conform to current conventions, (continued)
- [PATCH 12/17] qapi: Rewrite parsing of doc comment section symbols and tags, Markus Armbruster, 2023/04/28
- [PATCH 01/17] docs/devel/qapi-code-gen: Clean up use of quotes a bit, Markus Armbruster, 2023/04/28
- [PATCH 15/17] docs/devel/qapi-code-gen: Update doc comment conventions, Markus Armbruster, 2023/04/28
- [PATCH 05/17] Revert "qapi: BlockExportRemoveMode: move comments to TODO", Markus Armbruster, 2023/04/28
- [PATCH 17/17] qapi: Reformat doc comments to conform to current conventions, Markus Armbruster, 2023/04/28
- Re: [PATCH 00/17] qapi: Reformat doc comments, Markus Armbruster, 2023/04/28