qemu-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-commits] [qemu/qemu] 290e48: qapi: Improve error message for descr


From: Richard Henderson
Subject: [Qemu-commits] [qemu/qemu] 290e48: qapi: Improve error message for description follow...
Date: Mon, 22 May 2023 20:04:00 -0700

  Branch: refs/heads/master
  Home:   https://github.com/qemu/qemu
  Commit: 290e48e8f1ec975c100520fb697b0ae7300d0fb3
      
https://github.com/qemu/qemu/commit/290e48e8f1ec975c100520fb697b0ae7300d0fb3
  Author: Markus Armbruster <armbru@redhat.com>
  Date:   2023-05-22 (Mon, 22 May 2023)

  Changed paths:
    M scripts/qapi/parser.py
    M tests/qapi-schema/doc-interleaved-section.err

  Log Message:
  -----------
  qapi: Improve error message for description following section

The error message is bad when the section is untagged.  For instance,
test case doc-interleaved-section produces "'@foobar:' can't follow
'Note' section", which is okay, but if we drop the "Note:" tag, we get
"'@foobar:' can't follow 'None' section, which is bad.

Change the error message to "description of '@foobar:' follows a
section".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230510141637.3685080-1-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
[Conflict with commit 3e32dca3f0d resolved]


  Commit: d56572584d9a5414c6a55c3f6b7ecce4b098926b
      
https://github.com/qemu/qemu/commit/d56572584d9a5414c6a55c3f6b7ecce4b098926b
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2023-05-22 (Mon, 22 May 2023)

  Changed paths:
    M docs/devel/qapi-code-gen.rst
    M docs/interop/index.rst
    A docs/interop/qmp-spec.rst
    R docs/interop/qmp-spec.txt
    M python/qemu/qmp/models.py
    M python/qemu/qmp/qmp_client.py
    M qapi/control.json
    M qapi/qapi-schema.json
    M qobject/json-lexer.c

  Log Message:
  -----------
  docs/interop: Convert qmp-spec.txt to rST

Convert the qmp-spec.txt document to restructuredText.
Notable points about the conversion:
 * numbers at the start of section headings are removed, to match
   the style of the rest of the manual
 * cross-references to other sections or documents are hyperlinked
 * various formatting tweaks (notably the examples, which need the
   -> and <- prefixed so the QMP code-block lexer will accept them)
 * English prose fixed in a few places

Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230515162245.3964307-2-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
[.. code-block:: dumbed down to :: to work around CI failure]


  Commit: 8a85b8ec3da7f6b5edddb4e142807785044c748e
      
https://github.com/qemu/qemu/commit/8a85b8ec3da7f6b5edddb4e142807785044c748e
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2023-05-22 (Mon, 22 May 2023)

  Changed paths:
    M docs/interop/qmp-spec.rst

  Log Message:
  -----------
  docs/interop/qmp-spec: Update error description for parsing errors

The description text for a parsing error has changed since the
spec doc was first written; update the example in the docs.

Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230515162245.3964307-3-peter.maydell@linaro.org>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>


  Commit: 0ec4468f233c53eb854f204d105d965455deec51
      
https://github.com/qemu/qemu/commit/0ec4468f233c53eb854f204d105d965455deec51
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2023-05-22 (Mon, 22 May 2023)

  Changed paths:
    R docs/interop/qmp-intro.txt
    M qemu-options.hx

  Log Message:
  -----------
  docs/interop: Delete qmp-intro.txt

qmp-intro.txt is quite small and provides very little information
that isn't already in the documentation elsewhere.  Fold the example
command lines into qemu-options.hx, and delete the now-unneeded plain
text document.

While we're touching the qemu-options.hx documentation text,
wordsmith it a little bit and improve the rST formatting.

Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230515162245.3964307-4-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>


  Commit: 886c0453cbf10eebd42a9ccf89c3e46eb389c357
      
https://github.com/qemu/qemu/commit/886c0453cbf10eebd42a9ccf89c3e46eb389c357
  Author: Richard Henderson <richard.henderson@linaro.org>
  Date:   2023-05-22 (Mon, 22 May 2023)

  Changed paths:
    M docs/devel/qapi-code-gen.rst
    M docs/interop/index.rst
    R docs/interop/qmp-intro.txt
    A docs/interop/qmp-spec.rst
    R docs/interop/qmp-spec.txt
    M python/qemu/qmp/models.py
    M python/qemu/qmp/qmp_client.py
    M qapi/control.json
    M qapi/qapi-schema.json
    M qemu-options.hx
    M qobject/json-lexer.c
    M scripts/qapi/parser.py
    M tests/qapi-schema/doc-interleaved-section.err

  Log Message:
  -----------
  Merge tag 'pull-qapi-2023-05-17-v2' of https://repo.or.cz/qemu/armbru into 
staging

QAPI patches patches for 2023-05-17

# -----BEGIN PGP SIGNATURE-----
#
# iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmRrTcgSHGFybWJydUBy
# ZWRoYXQuY29tAAoJEDhwtADrkYZTMycP/3sP6/U4kwOKMGGcB+n2pHJeioQS4xgF
# 94NCW+KpewxApP0XzIC2nDGjUe/rPcUfQmBNUumvYbqHO91tq91wFwkllBv2UR0q
# 6qfRji+e8+9H9hMDeVzzSNjlZZg/tSdIJlhkJDw1u4/3fpjfAmzVx6DO3wepSQ9Q
# m5Af/+uhVZWyUXMZqcKr2Zq8qur6ZFEBNpXpPvT60Tvy2heuQ+vcoE3tl2ZRQbmj
# b/jhtCu+NPjgOHtg9Gr2BPXqQiZBR4vFA7WBsB8wCf2xxULfTwHJvFz/e0vx5fUC
# q0Fsyybf4USo2PRMsRFv2v4dEuVGHb3E1RIJY4NTAxQMqqm4zfOyK0BzOGNDkxCn
# owNP4vKly0e/CfYDY74FHaPId295xyeo6S4Cj5ib9W23AAWUNt6f6vbjlDOLCLON
# c7yXP/aJwhTb2w1t0mLTmsKum3DpLlrudPudTylVlmYfwchkvUGsWYbaxu6H6XWk
# 49Ox/QPVwqG6elXNn3kTY4QqTAppXhE7QcPbioX9WOThVPf6aJCLdZSHEHu4HXkZ
# 4FRu73Z2wcPNB789xOrQoXs24GdKmWXQ6K01KC4v7WNJQBXccec52yGxvktQRZBm
# GL3zYdOOJEL+Y/8JrXTIo26M8HP/4kxV2VqB6KOuaGygMsW9w9jbG+ygLyjqUDQg
# 3APV3hdmVOht
# =6anf
# -----END PGP SIGNATURE-----
# gpg: Signature made Mon 22 May 2023 04:11:04 AM PDT
# gpg:                using RSA key 354BC8B3D7EB2A6B68674E5F3870B400EB918653
# gpg:                issuer "armbru@redhat.com"
# gpg: Good signature from "Markus Armbruster <armbru@redhat.com>" [undefined]
# gpg:                 aka "Markus Armbruster <armbru@pond.sub.org>" [undefined]
# gpg: WARNING: This key is not certified with a trusted signature!
# gpg:          There is no indication that the signature belongs to the owner.
# Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867  4E5F 3870 B400 EB91 8653

* tag 'pull-qapi-2023-05-17-v2' of https://repo.or.cz/qemu/armbru:
  docs/interop: Delete qmp-intro.txt
  docs/interop/qmp-spec: Update error description for parsing errors
  docs/interop: Convert qmp-spec.txt to rST
  qapi: Improve error message for description following section

Signed-off-by: Richard Henderson <richard.henderson@linaro.org>


Compare: https://github.com/qemu/qemu/compare/37246d54d656...886c0453cbf1



reply via email to

[Prev in Thread] Current Thread [Next in Thread]