Skip to content
Snippets Groups Projects
  • Peter Maydell's avatar
    a69a6d4b
    scripts/qapi/parser.py: improve doc comment indent handling · a69a6d4b
    Peter Maydell authored
    
    Make the handling of indentation in doc comments more sophisticated,
    so that when we see a section like:
    
    Notes: some text
           some more text
              indented line 3
    
    we save it for the doc-comment processing code as:
    
    some text
    some more text
       indented line 3
    
    and when we see a section with the heading on its own line:
    
    Notes:
    
    some text
    some more text
       indented text
    
    we also accept that and save it in the same form.
    
    If we detect that the comment document text is not indented as much
    as we expect it to be, we throw a parse error.  (We don't complain
    about over-indented sections, because for rST this can be legitimate
    markup.)
    
    The golden reference for the doc comment text is updated to remove
    the two 'wrong' indents; these now form a test case that we correctly
    stripped leading whitespace from an indented multi-line argument
    definition.
    
    We update the documentation in docs/devel/qapi-code-gen.txt to
    describe the new indentation rules.
    
    Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
    Message-Id: <20200925162316.21205-6-peter.maydell@linaro.org>
    Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
    [Whitespace between sentences tweaked]
    Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
    a69a6d4b
    History
    scripts/qapi/parser.py: improve doc comment indent handling
    Peter Maydell authored
    
    Make the handling of indentation in doc comments more sophisticated,
    so that when we see a section like:
    
    Notes: some text
           some more text
              indented line 3
    
    we save it for the doc-comment processing code as:
    
    some text
    some more text
       indented line 3
    
    and when we see a section with the heading on its own line:
    
    Notes:
    
    some text
    some more text
       indented text
    
    we also accept that and save it in the same form.
    
    If we detect that the comment document text is not indented as much
    as we expect it to be, we throw a parse error.  (We don't complain
    about over-indented sections, because for rST this can be legitimate
    markup.)
    
    The golden reference for the doc comment text is updated to remove
    the two 'wrong' indents; these now form a test case that we correctly
    stripped leading whitespace from an indented multi-line argument
    definition.
    
    We update the documentation in docs/devel/qapi-code-gen.txt to
    describe the new indentation rules.
    
    Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
    Message-Id: <20200925162316.21205-6-peter.maydell@linaro.org>
    Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
    [Whitespace between sentences tweaked]
    Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>