[Qemu-commits] [qemu/qemu] 13b392: qapi: Improve error message for description follow...

[Richard Henderson]

  Branch: refs/heads/staging
  Home:   https://github.com/qemu/qemu
  Commit: 13b392c87a23abb987126c58b62694efe4b4f166
      
https://github.com/qemu/qemu/commit/13b392c87a23abb987126c58b62694efe4b4f166
  Author: Markus Armbruster <armbru@redhat.com>
  Date:   2023-05-17 (Wed, 17 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: a5392fa873014967192c409bf71a29bf732071d5
      
https://github.com/qemu/qemu/commit/a5392fa873014967192c409bf71a29bf732071d5
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2023-05-17 (Wed, 17 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>


  Commit: da91a50010db929ad16b0ee3e77666ff19ffe0ef
      
https://github.com/qemu/qemu/commit/da91a50010db929ad16b0ee3e77666ff19ffe0ef
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2023-05-17 (Wed, 17 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: a729c0c392735720895ad07c70316c17a1362adf
      
https://github.com/qemu/qemu/commit/a729c0c392735720895ad07c70316c17a1362adf
  Author: Peter Maydell <peter.maydell@linaro.org>
  Date:   2023-05-17 (Wed, 17 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: 28d2a4f620db2bc327dbd3443b777890d39a0bf6
      
https://github.com/qemu/qemu/commit/28d2a4f620db2bc327dbd3443b777890d39a0bf6
  Author: Markus Armbruster <armbru@redhat.com>
  Date:   2023-05-17 (Wed, 17 May 2023)

  Changed paths:
    M scripts/qapi/parser.py

  Log Message:
  -----------
  qapi/parser: Drop two bad type hints for now

Two type hints fail centos-stream-8-x86_64 CI.  They are actually
broken.  Changing them to Optional[re.Match[str]] fixes them locally
for me, but then CI fails differently.  Drop them for now.

Fixes: 3e32dca3f0d1 (qapi: Rewrite parsing of doc comment section symbols and 
tags)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230517061600.1782455-1-armbru@redhat.com>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Tested-by: Igor Mammedov <imammedo@redhat.com>


  Commit: c7d0bdda21c38538658966308b39e494302717d6
      
https://github.com/qemu/qemu/commit/c7d0bdda21c38538658966308b39e494302717d6
  Author: Richard Henderson <richard.henderson@linaro.org>
  Date:   2023-05-17 (Wed, 17 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' of https://repo.or.cz/qemu/armbru into 
staging

QAPI patches patches for 2023-05-17

# -----BEGIN PGP SIGNATURE-----
#
# iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmRk24kSHGFybWJydUBy
# ZWRoYXQuY29tAAoJEDhwtADrkYZTFKMP/isne+7NXJHeiXktbODgegKlshzaT2eq
# K+NUh0UDWVpV2h46c7PjZmwBO2iTwLZPReI1TY8Jghf9fmzrW0d0+oz9+L1ZxzrY
# ScKq0ThnjMJqXifxeIe4hExfHCDcSu8WHOHwNVRVy4Kqrn1fEivilYigTOGFljCb
# H7nuszJTGPcM80ncA5JY+R3+tng54YpMjOLaM8kXpy8PHPs3dSVq9bYtWuiHBPVl
# htYPix8QK0rMAzPquLHm7bBse9IWHowrzZuoKvMgBoeAUKXBJYkyo9MoDBNOI2+x
# 8PkEjFRJYkr+RM6LF4niM+bvTypbSwF8Y6vUqJtc0jkCTzAnkRh9YXVPbhr6OgS0
# fdOQz/ag4LJ6jyeATTLuxm3xa+yp4dv+if6G2Bgw3RCCuzStZvdGqYJ0/oENpHf6
# +MqDgWf1Df75VjOSdnj7jfDLGCZopNYkXz0arS8jv0TMNfunEj44v3wzJK2duVLP
# lkM86falSdbgct/KEn1ceIXG3gX21yIlpRpLTTFERyoVYVGAP2ac83djjsV/02Vk
# 8psixHWlj/aVAgVOn2ljo5yuoO5Xj5L6XUeObavRMmDtHj83X4emDEfHtxQRU6Ug
# EWTt7sA/7Z2I0MdDvgOOYRyAT1jMnTqZV/r7nPhwOxd5sFXso3IkCvQ3wqPvgzje
# H7d6sCaoZd9N
# =np3P
# -----END PGP SIGNATURE-----
# gpg: Signature made Wed 17 May 2023 06:50:01 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' of https://repo.or.cz/qemu/armbru:
  qapi/parser: Drop two bad type hints for now
  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/19200a0edf67...c7d0bdda21c3