Skip to content
Snippets Groups Projects
  • Markus Armbruster's avatar
    a937b6aa
    qapi: Reformat doc comments to conform to current conventions · a937b6aa
    Markus Armbruster authored
    
    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: default avatarMarkus Armbruster <armbru@redhat.com>
    Message-Id: <20230428105429.1687850-18-armbru@redhat.com>
    Reviewed-by: default avatarJuan Quintela <quintela@redhat.com>
    Acked-by: default avatarLukas Straub <lukasstraub2@web.de>
    [Straightforward conflicts in qapi/audio.json qapi/misc-target.json
    qapi/run-state.json resolved]
    a937b6aa
    History
    qapi: Reformat doc comments to conform to current conventions
    Markus Armbruster authored
    
    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: default avatarMarkus Armbruster <armbru@redhat.com>
    Message-Id: <20230428105429.1687850-18-armbru@redhat.com>
    Reviewed-by: default avatarJuan Quintela <quintela@redhat.com>
    Acked-by: default avatarLukas Straub <lukasstraub2@web.de>
    [Straightforward conflicts in qapi/audio.json qapi/misc-target.json
    qapi/run-state.json resolved]