mbox

[PULL,0/8] docs queue

Message ID 20200203111318.23378-1-peter.maydell@linaro.org (mailing list archive)
State New, archived
Headers show

Pull-request

https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-docs-20200203

Message

Peter Maydell Feb. 3, 2020, 11:13 a.m. UTC
This 'docs' pullrequest is just my 8-patch series
which adds hxtool doc fragment support for rST and
converts qemu-img/qemu-trace-stap/virtfs-proxy-helper.

It has small fixes squashed in to account for commit
cdd267749a3ab78 (which adds a new option to the qemu-img
docs) now being in master.

thanks
-- PMM

The following changes since commit 035b21977ce1791a630c5cbf46e482e54552e05b:

  Merge remote-tracking branch 'remotes/dgibson/tags/ppc-for-5.0-20200203' into staging (2020-02-03 09:52:43 +0000)

are available in the Git repository at:

  https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-docs-20200203

for you to fetch changes up to 78813586b04e89639754cfdcef23802dc9f54ff4:

  virtfs-proxy-helper: Convert documentation to rST (2020-02-03 11:02:23 +0000)

----------------------------------------------------------------
docs:
 * Fix Makefile concurrency bug where we could run Sphinx twice
   in parallel on the same manual (which makes it crash)
 * Support handling hxtool doc fragments for rST manuals
 * Convert qemu-img docs to rST
 * Convert qemu-trace-stap docs to rST
 * Convert virtfs-proxy-helper docs to rST

----------------------------------------------------------------
Peter Maydell (8):
      Makefile: Ensure we don't run Sphinx in parallel for manpages
      hxtool: Support SRST/ERST directives
      docs/sphinx: Add new hxtool Sphinx extension
      qemu-img-cmds.hx: Add rST documentation fragments
      qemu-img: Convert invocation documentation to rST
      qemu-img-cmds.hx: Remove texinfo document fragments
      scripts/qemu-trace-stap: Convert documentation to rST
      virtfs-proxy-helper: Convert documentation to rST

 Makefile                             |  46 +-
 MAINTAINERS                          |   3 +
 docs/conf.py                         |   3 +-
 docs/interop/conf.py                 |   9 +-
 docs/interop/index.rst               |   3 +
 docs/interop/qemu-img.rst            | 825 +++++++++++++++++++++++++++++++++++
 docs/interop/qemu-trace-stap.rst     | 124 ++++++
 docs/interop/virtfs-proxy-helper.rst |  72 +++
 docs/sphinx/hxtool.py                | 210 +++++++++
 fsdev/virtfs-proxy-helper.texi       |  63 ---
 qemu-doc.texi                        |  10 +-
 qemu-img-cmds.hx                     |  99 ++---
 qemu-img.texi                        | 798 ---------------------------------
 rules.mak                            |  36 ++
 scripts/hxtool                       |  33 +-
 scripts/qemu-trace-stap.texi         | 140 ------
 16 files changed, 1386 insertions(+), 1088 deletions(-)
 create mode 100644 docs/interop/qemu-img.rst
 create mode 100644 docs/interop/qemu-trace-stap.rst
 create mode 100644 docs/interop/virtfs-proxy-helper.rst
 create mode 100644 docs/sphinx/hxtool.py
 delete mode 100644 fsdev/virtfs-proxy-helper.texi
 delete mode 100644 qemu-img.texi
 delete mode 100644 scripts/qemu-trace-stap.texi

Comments

Peter Maydell Feb. 3, 2020, 1:04 p.m. UTC | #1
On Mon, 3 Feb 2020 at 11:13, Peter Maydell <peter.maydell@linaro.org> wrote:
>
> This 'docs' pullrequest is just my 8-patch series
> which adds hxtool doc fragment support for rST and
> converts qemu-img/qemu-trace-stap/virtfs-proxy-helper.
>
> It has small fixes squashed in to account for commit
> cdd267749a3ab78 (which adds a new option to the qemu-img
> docs) now being in master.
>
> thanks
> -- PMM
>
> The following changes since commit 035b21977ce1791a630c5cbf46e482e54552e05b:
>
>   Merge remote-tracking branch 'remotes/dgibson/tags/ppc-for-5.0-20200203' into staging (2020-02-03 09:52:43 +0000)
>
> are available in the Git repository at:
>
>   https://git.linaro.org/people/pmaydell/qemu-arm.git tags/pull-docs-20200203
>
> for you to fetch changes up to 78813586b04e89639754cfdcef23802dc9f54ff4:
>
>   virtfs-proxy-helper: Convert documentation to rST (2020-02-03 11:02:23 +0000)
>
> ----------------------------------------------------------------
> docs:
>  * Fix Makefile concurrency bug where we could run Sphinx twice
>    in parallel on the same manual (which makes it crash)
>  * Support handling hxtool doc fragments for rST manuals
>  * Convert qemu-img docs to rST
>  * Convert qemu-trace-stap docs to rST
>  * Convert virtfs-proxy-helper docs to rST
>


Applied, thanks.

Please update the changelog at https://wiki.qemu.org/ChangeLog/5.0
for any user-visible changes.

-- PMM