[Qemu-commits] [qemu/qemu] 65c354: docs: Create new 'tools' manual

[Peter Maydell]

  Branch: refs/heads/master
  Home:   https://github.com/qemu/qemu
  Commit: 65c3542b1f4e6ad5648a6ee0f7ebc8bcc39035d3
      
https://github.com/qemu/qemu/commit/65c3542b1f4e6ad5648a6ee0f7ebc8bcc39035d3
  Author: Peter Maydell <address@hidden>
  Date:   2020-02-25 (Tue, 25 Feb 2020)

  Changed paths:
    M Makefile
    M docs/index.html.in
    M docs/index.rst
    A docs/tools/conf.py
    A docs/tools/index.rst

  Log Message:
  -----------
  docs: Create new 'tools' manual

Some of the documentation for QEMU "tools" which are standalone
binaries like qemu-img is an awkward fit in our current 5-manual
split. We've put it into "interop", but they're not really
about interoperability.

Create a new top level manual "tools" which will be a better
home for this documentation. This commit creates an empty
initial manual; we will move the relevant documentation
files in a subsequent commit.

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


  Commit: bb43ee6c4f32026d911cba2db570847fabbfa7a4
      
https://github.com/qemu/qemu/commit/bb43ee6c4f32026d911cba2db570847fabbfa7a4
  Author: Peter Maydell <address@hidden>
  Date:   2020-02-25 (Tue, 25 Feb 2020)

  Changed paths:
    M Makefile
    M docs/interop/qemu-img.rst
    M docs/interop/qemu-nbd.rst
    R docs/interop/qemu-option-trace.rst.inc
    A docs/qemu-option-trace.rst.inc

  Log Message:
  -----------
  docs: Move qemu-option-trace.rst.inc to docs/

The qemu-option-trace.rst.inc file contains a rST documentation
fragment which describes trace options common to qemu-nbd and
qemu-img.  We put this file into interop/, but we'd like to move the
qemu-nbd and qemu-img files into the tools/ manual.  We could move
the .rst.inc file along with them, but we're eventually going to want
to use it for the main QEMU binary options documentation too, and
that will be in system/.  So move qemu-option-trace.rst.inc to the
top-level docs/ directory, where all these files can include it via

   .. include:: ../qemu-option-trace.rst.inc

This does have the slight downside that we now need to explicitly
tell Make which manuals use this file rather than relying on
a wildcard for all .rst.inc in the manual.

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


  Commit: a08b4a9fe6cb3c23755db764c9a40510a40a8731
      
https://github.com/qemu/qemu/commit/a08b4a9fe6cb3c23755db764c9a40510a40a8731
  Author: Peter Maydell <address@hidden>
  Date:   2020-02-25 (Tue, 25 Feb 2020)

  Changed paths:
    M Makefile
    M docs/interop/conf.py
    M docs/interop/index.rst
    R docs/interop/qemu-img.rst
    R docs/interop/qemu-nbd.rst
    R docs/interop/qemu-trace-stap.rst
    R docs/interop/virtfs-proxy-helper.rst
    R docs/interop/virtiofsd.rst
    M docs/tools/conf.py
    M docs/tools/index.rst
    A docs/tools/qemu-img.rst
    A docs/tools/qemu-nbd.rst
    A docs/tools/qemu-trace-stap.rst
    A docs/tools/virtfs-proxy-helper.rst
    A docs/tools/virtiofsd.rst

  Log Message:
  -----------
  docs: Move tools documentation to tools manual

Move the following tools documentation files to the new tools manual:

 docs/interop/qemu-img.rst
 docs/interop/qemu-nbd.rst
 docs/interop/virtfs-proxy-helper.rst
 docs/interop/qemu-trace-stap.rst
 docs/interop/virtiofsd.rst

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


  Commit: 9a8abceb5f01d1066d3a1ac5a33aabcbaeec1860
      
https://github.com/qemu/qemu/commit/9a8abceb5f01d1066d3a1ac5a33aabcbaeec1860
  Author: Peter Maydell <address@hidden>
  Date:   2020-02-25 (Tue, 25 Feb 2020)

  Changed paths:
    M Makefile
    M docs/index.html.in
    M docs/index.rst
    M docs/interop/conf.py
    M docs/interop/index.rst
    R docs/interop/qemu-img.rst
    R docs/interop/qemu-nbd.rst
    R docs/interop/qemu-option-trace.rst.inc
    R docs/interop/qemu-trace-stap.rst
    R docs/interop/virtfs-proxy-helper.rst
    R docs/interop/virtiofsd.rst
    A docs/qemu-option-trace.rst.inc
    A docs/tools/conf.py
    A docs/tools/index.rst
    A docs/tools/qemu-img.rst
    A docs/tools/qemu-nbd.rst
    A docs/tools/qemu-trace-stap.rst
    A docs/tools/virtfs-proxy-helper.rst
    A docs/tools/virtiofsd.rst

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

 * create a new 'tools' manual, and move the documentation for
   qemu-img, qemu-nbd, virtfs-proxy-helper, qemu-trace-stap and
   virtiofsd to it

# gpg: Signature made Tue 25 Feb 2020 11:00:16 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-20200225:
  docs: Move tools documentation to tools manual
  docs: Move qemu-option-trace.rst.inc to docs/
  docs: Create new 'tools' manual

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


Compare: https://github.com/qemu/qemu/compare/c1e667d2598b...9a8abceb5f01