diff options
| author | Peter Maydell | 2020-02-25 11:45:13 +0100 |
|---|---|---|
| committer | Peter Maydell | 2020-02-25 11:48:05 +0100 |
| commit | bb43ee6c4f32026d911cba2db570847fabbfa7a4 (patch) | |
| tree | 362e47eca473d079f54bf2890f68f86da8f2587e /docs/interop | |
| parent | docs: Create new 'tools' manual (diff) | |
| download | qemu-bb43ee6c4f32026d911cba2db570847fabbfa7a4.tar.gz qemu-bb43ee6c4f32026d911cba2db570847fabbfa7a4.tar.xz qemu-bb43ee6c4f32026d911cba2db570847fabbfa7a4.zip | |
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 <peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Acked-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20200217155415.30949-3-peter.maydell@linaro.org
Diffstat (limited to 'docs/interop')
| -rw-r--r-- | docs/interop/qemu-img.rst | 2 | ||||
| -rw-r--r-- | docs/interop/qemu-nbd.rst | 2 | ||||
| -rw-r--r-- | docs/interop/qemu-option-trace.rst.inc | 30 |
3 files changed, 2 insertions, 32 deletions
diff --git a/docs/interop/qemu-img.rst b/docs/interop/qemu-img.rst index 5f40137c10..0080f83a76 100644 --- a/docs/interop/qemu-img.rst +++ b/docs/interop/qemu-img.rst @@ -34,7 +34,7 @@ Standard options: .. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE] - .. include:: qemu-option-trace.rst.inc + .. include:: ../qemu-option-trace.rst.inc The following commands are supported: diff --git a/docs/interop/qemu-nbd.rst b/docs/interop/qemu-nbd.rst index e548403100..667861cb22 100644 --- a/docs/interop/qemu-nbd.rst +++ b/docs/interop/qemu-nbd.rst @@ -188,7 +188,7 @@ driver options if ``--image-opts`` is specified. .. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE] - .. include:: qemu-option-trace.rst.inc + .. include:: ../qemu-option-trace.rst.inc Examples -------- diff --git a/docs/interop/qemu-option-trace.rst.inc b/docs/interop/qemu-option-trace.rst.inc deleted file mode 100644 index 23cfcb4853..0000000000 --- a/docs/interop/qemu-option-trace.rst.inc +++ /dev/null @@ -1,30 +0,0 @@ -.. - The contents of this file must be kept in sync with qemu-option-trace.texi - until all the users of the texi file have been converted to rst and - the texi file can be removed. - -Specify tracing options. - -.. option:: [enable=]PATTERN - - Immediately enable events matching *PATTERN* - (either event name or a globbing pattern). This option is only - available if QEMU has been compiled with the ``simple``, ``log`` - or ``ftrace`` tracing backend. To specify multiple events or patterns, - specify the :option:`-trace` option multiple times. - - Use :option:`-trace help` to print a list of names of trace points. - -.. option:: events=FILE - - Immediately enable events listed in *FILE*. - The file must contain one event name (as listed in the ``trace-events-all`` - file) per line; globbing patterns are accepted too. This option is only - available if QEMU has been compiled with the ``simple``, ``log`` or - ``ftrace`` tracing backend. - -.. option:: file=FILE - - Log output traces to *FILE*. - This option is only available if QEMU has been compiled with - the ``simple`` tracing backend. |