[Qemu-commits] [qemu/qemu] d1055e: Makefile: Remove redundant Texinfo related code

[Peter Maydell]

  Branch: refs/heads/master
  Home:   https://github.com/qemu/qemu
  Commit: d1055e3a2a8c78b0326eb7520c8b33d27a2a23ed
      
https://github.com/qemu/qemu/commit/d1055e3a2a8c78b0326eb7520c8b33d27a2a23ed
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M Makefile

  Log Message:
  -----------
  Makefile: Remove redundant Texinfo related code

The recent conversion of qemu-doc.texi to rST forgot a few stray bits
of makefile code that are now redundant. Remove them.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: 3c95fdef948df90f5b41266b78b5947ea7c8fc27
      
https://github.com/qemu/qemu/commit/3c95fdef948df90f5b41266b78b5947ea7c8fc27
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M hmp-commands-info.hx
    M hmp-commands.hx
    M qemu-options.hx

  Log Message:
  -----------
  Update comments in .hx files that mention Texinfo

Update the header comments in .hx files that mention STEXI/ETEXI
markup; this is now SRST/ERST as all these files have been
converted to rST.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: 3885e2c25c892cf985b5b189920b9da2df42a40b
      
https://github.com/qemu/qemu/commit/3885e2c25c892cf985b5b189920b9da2df42a40b
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M scripts/hxtool

  Log Message:
  -----------
  hxtool: Remove Texinfo generation support

All the STEXI/ETEXI blocks and the Makfile rules that use them have now
been removed from the codebase. We can remove the code from the hxtool
script which handles the STEXI/ETEXI directives and the '-t' option.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: 80a046c51a274907252e8f3e7f6831c963a57fde
      
https://github.com/qemu/qemu/commit/80a046c51a274907252e8f3e7f6831c963a57fde
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M docs/sphinx/hxtool.py

  Log Message:
  -----------
  docs/sphinx/hxtool.py: Remove STEXI/ETEXI support

Now that none of our input .hx files have STEXI/ETEXI blocks,
we can remove the code in the Sphinx hxtool extension that
supported parsing them.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: 9165d323b0b3d347892323ce899cd60b0abffb60
      
https://github.com/qemu/qemu/commit/9165d323b0b3d347892323ce899cd60b0abffb60
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M Makefile

  Log Message:
  -----------
  Makefile: Make all Sphinx documentation depend on the extensions

Add the Python source files of our Sphinx extensions to the
dependencies of the Sphinx manuals, so that if we edit the
extension source code the manuals get rebuilt.

Adding this dependency unconditionally means that we'll rebuild
a manual even if it happens to not use the extension whose
source file was changed, but this is simpler and less error
prone, and it's unlikely that we'll be making frequent changes
to the extensions.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: b29a59fb66b79e19f650b28b52aa017b8d8ab5c3
      
https://github.com/qemu/qemu/commit/b29a59fb66b79e19f650b28b52aa017b8d8ab5c3
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M docs/index.html.in
    M docs/index.rst

  Log Message:
  -----------
  docs/index.rst, docs/index.html.in: Reorder manuals

Now that qemu-doc.html is no longer present, the ordering of manuals
within the top-level index page looks a bit odd. Reshuffle so that
the manuals the user is most likely to be interested in are at the
top of the list, and the reference material is at the bottom.

Similarly, we reorder the index.rst file used as the base of
the "all manuals in one" documentation for readthedocs.

The new order is:
 * system
 * user
 * tools
 * interop
 * specs
 * QMP reference (if present)
 * Guest agent protocol reference (if present)
 * devel (if present)

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: 3290e12d6c0297c5c24ac576e680bb431356d156
      
https://github.com/qemu/qemu/commit/3290e12d6c0297c5c24ac576e680bb431356d156
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M docs/qemu-option-trace.rst.inc

  Log Message:
  -----------
  docs/qemu-option-trace.rst.inc: Remove redundant comment

The Texinfo version of the tracing options documentation has now
been deleted, so we can remove the now-redundant comment at the top
of the rST version that was reminding us that the two should be
kept in sync.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: 814e068fb2324173a29cdfd890bb8c86af5e3032
      
https://github.com/qemu/qemu/commit/814e068fb2324173a29cdfd890bb8c86af5e3032
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M Makefile

  Log Message:
  -----------
  Makefile: Allow for subdirectories in Sphinx manual dependencies

Currently we put 'docs/foo/*.rst' in the Make list of dependencies
for the Sphinx 'foo' manual, which means all the files must be
in the top level of that manual's directory. We'd like to be
able to have subdirectories inside some of the manuals, so add
'docs/foo/*/*.rst' to the dependencies too.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Niek Linnenbank <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
Message-id: address@hidden


  Commit: c11a8e890c4a74f58c605f793a46a9094729776a
      
https://github.com/qemu/qemu/commit/c11a8e890c4a74f58c605f793a46a9094729776a
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M MAINTAINERS
    A docs/system/arm/integratorcp.rst
    A docs/system/arm/musicpal.rst
    A docs/system/arm/nseries.rst
    A docs/system/arm/palm.rst
    A docs/system/arm/realview.rst
    A docs/system/arm/stellaris.rst
    A docs/system/arm/sx1.rst
    A docs/system/arm/versatile.rst
    A docs/system/arm/xscale.rst
    M docs/system/target-arm.rst

  Log Message:
  -----------
  docs/system: Split target-arm.rst into sub-documents

Currently the documentation for Arm system emulator targets is in a
single target-arm.rst.  This describes only some of the boards and
often in a fairly abbreviated fashion. Restructure it so that each
board has its own documentation file in the docs/system/arm/
subdirectory.

This will hopefully encourage us to write board documentation that
describes the board in detail, rather than a few brief paragraphs
in a single long page. The table of contents should also help users
to find the board they care about faster.

Once the structure is in place we'll be able to move microvm.rst
from the top-level docs/ directory.

All the text from the old page is retained, except for the final
paragraph ("A Linux 2.6 test image is available on the QEMU web site.
More information is available in the QEMU mailing-list archive."),
which is deleted. The git history shows this was originally added
in reference to the integratorcp board (at that time the only
Arm board that was supported), and has subsequently gradually been
further and further separated from the integratorcp documentation
by the insertion of other board documentation sections. It's
extremely out of date and no longer accurate, since AFAICT there
isn't an integratorcp kernel on the website any more; so better
deleted than retained.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Niek Linnenbank <address@hidden>
Message-id: address@hidden


  Commit: d3149c590da27793e3ae279aa5fb63ab13bc0bde
      
https://github.com/qemu/qemu/commit/d3149c590da27793e3ae279aa5fb63ab13bc0bde
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M docs/system/target-arm.rst

  Log Message:
  -----------
  docs/system/target-arm.rst: Add some introductory text

Now we've moved the various bits of per-board documentation into
their own files, the top level document is a little bare. Add
some introductory information, including a note that many
of the board models we support are currently undocumented.

(Most sections of this new text were originally written by me
for the wiki page https://wiki.qemu.org/Documentation/Platforms/ARM)

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Niek Linnenbank <address@hidden>
Message-id: address@hidden


  Commit: 34f18ab14d7197d13d7e93300e3b9a3853c7efc8
      
https://github.com/qemu/qemu/commit/34f18ab14d7197d13d7e93300e3b9a3853c7efc8
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    R docs/arm-cpu-features.rst
    A docs/system/arm/cpu-features.rst
    M docs/system/target-arm.rst

  Log Message:
  -----------
  docs: Move arm-cpu-features.rst into the system manual

Now we have somewhere to put arm-specific rst documentation,
we can move arm-cpu-features.rst from the docs/ top level
directory into docs/system/arm/.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Niek Linnenbank <address@hidden>
Message-id: address@hidden


  Commit: 6fe6d6c9a953901251e1a85088f0a61ff5caf648
      
https://github.com/qemu/qemu/commit/6fe6d6c9a953901251e1a85088f0a61ff5caf648
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M docs/can.txt
    M docs/devel/atomics.txt
    M docs/devel/kconfig.rst
    M docs/devel/loads-stores.rst
    M docs/devel/multi-thread-tcg.txt
    M docs/devel/tcg.rst
    M docs/replay.txt
    M docs/specs/fw_cfg.txt
    M docs/specs/tpm.rst
    M docs/system/arm/cpu-features.rst
    M docs/system/arm/integratorcp.rst
    M docs/system/arm/musicpal.rst
    M docs/system/arm/nseries.rst
    M docs/system/arm/palm.rst
    M docs/system/arm/realview.rst
    M docs/system/arm/sx1.rst
    M docs/system/arm/versatile.rst
    M docs/system/arm/xscale.rst
    M docs/user/main.rst

  Log Message:
  -----------
  docs: Be consistent about capitalization of 'Arm'

The company 'Arm' went through a rebranding some years back
involving a recapitalization from 'ARM' to 'Arm'. As a result
our documentation is a bit inconsistent between the two forms.
It's not worth trying to update everywhere in QEMU, but it's
easy enough to make docs/ consistent.

Note that "ARMv8" and similar architecture names, and
older CPU names like "ARM926" still retain all-caps.

Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Niek Linnenbank <address@hidden>
Message-id: address@hidden


  Commit: 67d9ef7d541c3d21a25796c51c26da096a433565
      
https://github.com/qemu/qemu/commit/67d9ef7d541c3d21a25796c51c26da096a433565
  Author: Peter Maydell <address@hidden>
  Date:   2020-03-12 (Thu, 12 Mar 2020)

  Changed paths:
    M MAINTAINERS
    M Makefile
    R docs/arm-cpu-features.rst
    M docs/can.txt
    M docs/devel/atomics.txt
    M docs/devel/kconfig.rst
    M docs/devel/loads-stores.rst
    M docs/devel/multi-thread-tcg.txt
    M docs/devel/tcg.rst
    M docs/index.html.in
    M docs/index.rst
    M docs/qemu-option-trace.rst.inc
    M docs/replay.txt
    M docs/specs/fw_cfg.txt
    M docs/specs/tpm.rst
    M docs/sphinx/hxtool.py
    A docs/system/arm/cpu-features.rst
    A docs/system/arm/integratorcp.rst
    A docs/system/arm/musicpal.rst
    A docs/system/arm/nseries.rst
    A docs/system/arm/palm.rst
    A docs/system/arm/realview.rst
    A docs/system/arm/stellaris.rst
    A docs/system/arm/sx1.rst
    A docs/system/arm/versatile.rst
    A docs/system/arm/xscale.rst
    M docs/system/target-arm.rst
    M docs/user/main.rst
    M hmp-commands-info.hx
    M hmp-commands.hx
    M qemu-options.hx
    M scripts/hxtool

  Log Message:
  -----------
  Merge remote-tracking branch 'remotes/pmaydell/tags/pull-docs-20200312' into 
staging

docs queue:
 * Remove some no longer needed texinfo infrastructure
 * Reorder the top level index docs to put most useful manuals first
 * Split the Arm target-specific info into sub-pages
 * Improve the Arm documentation a bit with info previously
   only on the wiki page

# gpg: Signature made Thu 12 Mar 2020 11:42:10 GMT
# gpg:                using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE
# gpg:                issuer "address@hidden"
# gpg: Good signature from "Peter Maydell <address@hidden>" [ultimate]
# gpg:                 aka "Peter Maydell <address@hidden>" [ultimate]
# gpg:                 aka "Peter Maydell <address@hidden>" [ultimate]
# Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83  15CF 3C25 25ED 1436 0CDE

* remotes/pmaydell/tags/pull-docs-20200312:
  docs: Be consistent about capitalization of 'Arm'
  docs: Move arm-cpu-features.rst into the system manual
  docs/system/target-arm.rst: Add some introductory text
  docs/system: Split target-arm.rst into sub-documents
  Makefile: Allow for subdirectories in Sphinx manual dependencies
  docs/qemu-option-trace.rst.inc: Remove redundant comment
  docs/index.rst, docs/index.html.in: Reorder manuals
  Makefile: Make all Sphinx documentation depend on the extensions
  docs/sphinx/hxtool.py: Remove STEXI/ETEXI support
  hxtool: Remove Texinfo generation support
  Update comments in .hx files that mention Texinfo
  Makefile: Remove redundant Texinfo related code

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


Compare: https://github.com/qemu/qemu/compare/474acbe05d6a...67d9ef7d541c