[Qemu-commits] [qemu/qemu] 575e62: docs/interop/bitmaps.rst: Fix typos

[Peter Maydell]

  Branch: refs/heads/master
  Home:   https://github.com/qemu/qemu
  Commit: 575e6226287072bd0d6eb85d9712d280eb29c392
      
https://github.com/qemu/qemu/commit/575e6226287072bd0d6eb85d9712d280eb29c392
  Author: John Snow <address@hidden>
  Date:   2019-07-10 (Wed, 10 Jul 2019)

  Changed paths:
    M docs/interop/bitmaps.rst

  Log Message:
  -----------
  docs/interop/bitmaps.rst: Fix typos

Pygments and Sphinx get pickier all the time; Sphinx 2.1+ now catches
these errors.

Signed-off-by: John Snow <address@hidden>
Reported-by: Aarushi Mehta <address@hidden>
Reviewed-by: Vladimir Sementsov-Ogievskiy <address@hidden>
Message-id: address@hidden
Signed-off-by: John Snow <address@hidden>


  Commit: cd231e13bdcb8d686b014bef940c7d19c6f1e769
      
https://github.com/qemu/qemu/commit/cd231e13bdcb8d686b014bef940c7d19c6f1e769
  Author: John Snow <address@hidden>
  Date:   2019-07-10 (Wed, 10 Jul 2019)

  Changed paths:
    M docs/conf.py
    A docs/sphinx/qmp_lexer.py

  Log Message:
  -----------
  sphinx: add qmp_lexer

Sphinx, through Pygments, does not like annotated json examples very
much. In some versions of Sphinx (1.7), it will render the non-json
portions of code blocks in red, but in newer versions (2.0) it will
throw an exception and not highlight the block at all. Though we can
suppress this warning, it doesn't bring back highlighting on non-strict
json blocks.

We can alleviate this by creating a custom lexer for QMP examples that
allows us to properly highlight these examples in a robust way, keeping
our directionality and elision notations.

Signed-off-by: Eduardo Habkost <address@hidden>
Signed-off-by: John Snow <address@hidden>
Reported-by: Aarushi Mehta <address@hidden>
Reviewed-by: Peter Maydell <address@hidden>
Message-id: address@hidden
Signed-off-by: John Snow <address@hidden>


  Commit: a7786bfb0effe0b4b0fc61d8a8cd307c0b739ed7
      
https://github.com/qemu/qemu/commit/a7786bfb0effe0b4b0fc61d8a8cd307c0b739ed7
  Author: John Snow <address@hidden>
  Date:   2019-07-10 (Wed, 10 Jul 2019)

  Changed paths:
    M docs/interop/bitmaps.rst

  Log Message:
  -----------
  docs/bitmaps: use QMP lexer instead of json

The annotated style json we use in QMP documentation is not strict json
and depending on the version of Sphinx (2.0+) or Pygments installed,
might cause the build to fail.

Use the new QMP lexer.

Further, some versions of Sphinx can not apply custom lexers to "code"
directives and require the use of "code-block" directives instead, so
make that change at this time as well.

Tested under:
- Sphinx 1.3.6 and Pygments 2.4
- Sphinx 1.7.6 and Pygments 2.2 (Fedora 29 packages)
- Sphinx 2.0.1 and Pygments 2.4
- Sphinx 3.0.0+/f396b3a783 and Pygments 2.4 (From Sphinx git c4f44bdd)

Reported-by: Aarushi Mehta <address@hidden>
Signed-off-by: John Snow <address@hidden>
Reviewed-by: Eduardo Habkost <address@hidden>
Message-id: address@hidden
Signed-off-by: John Snow <address@hidden>


  Commit: 9411db8f37c64b9adb3e4b393c623a5760bcb847
      
https://github.com/qemu/qemu/commit/9411db8f37c64b9adb3e4b393c623a5760bcb847
  Author: Peter Maydell <address@hidden>
  Date:   2019-07-11 (Thu, 11 Jul 2019)

  Changed paths:
    M docs/conf.py
    M docs/interop/bitmaps.rst
    A docs/sphinx/qmp_lexer.py

  Log Message:
  -----------
  Merge remote-tracking branch 'remotes/jnsnow/tags/bitmaps-pull-request' into 
staging

Pull request

# gpg: Signature made Wed 10 Jul 2019 20:21:58 BST
# gpg:                using RSA key F9B7ABDBBCACDF95BE76CBD07DEF8106AAFC390E
# gpg: Good signature from "John Snow (John Huston) <address@hidden>" [full]
# Primary key fingerprint: FAEB 9711 A12C F475 812F  18F2 88A9 064D 1835 61EB
#      Subkey fingerprint: F9B7 ABDB BCAC DF95 BE76  CBD0 7DEF 8106 AAFC 390E

* remotes/jnsnow/tags/bitmaps-pull-request:
  docs/bitmaps: use QMP lexer instead of json
  sphinx: add qmp_lexer
  docs/interop/bitmaps.rst: Fix typos

Signed-off-by: Peter Maydell <address@hidden>


Compare: https://github.com/qemu/qemu/compare/abd45ff0396c...9411db8f37c6