[v2] trace: convert docs to rST and feature "log" backend in quickstart

[PATCH v2 0/3] trace: convert docs to rST and feature "log" backend in quickstart

Stefan Hajnoczi posted 3 patches 3 years, 4 months ago

Diff against v1
Download series mbox

Test checkpatch passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20201216160923.722894-1-stefanha@redhat.com

docs/devel/index.rst                    |   1 +
docs/devel/{tracing.txt => tracing.rst} | 185 ++++++++++++++----------
2 files changed, 107 insertions(+), 79 deletions(-)
rename docs/devel/{tracing.txt => tracing.rst} (84%)

Expand all Fold all

[PATCH v2 0/3] trace: convert docs to rST and feature "log" backend in quickstart

Posted by Stefan Hajnoczi 3 years, 4 months ago

v2:
 * Simplify quickstart for the "log" trace backend that is enabled by default
   [Peter]
 * Don't show ./configure --enable-trace-backends=log example since it's built
   by default (changed to --enable-trace-backends=simple,dtrace) [Peter]

Convert tracing.txt to rST and add it to the generated developer documentation.

Peter Maydell suggested making the "log" backend the recommended backend in the
quickstart documentation. It's easier to use than the "simple" backend. The
final patch updates the documentation to do this.

Stefan Hajnoczi (3):
  trace: fix simpletrace doc mismerge
  tracing: convert documentation to rST
  trace: recommend "log" backend for getting started with tracing

 docs/devel/index.rst                    |   1 +
 docs/devel/{tracing.txt => tracing.rst} | 185 ++++++++++++++----------
 2 files changed, 107 insertions(+), 79 deletions(-)
 rename docs/devel/{tracing.txt => tracing.rst} (84%)

-- 
2.29.2

Re: [PATCH v2 0/3] trace: convert docs to rST and feature "log" backend in quickstart

Posted by Stefan Hajnoczi 3 years, 3 months ago

On Wed, Dec 16, 2020 at 04:09:20PM +0000, Stefan Hajnoczi wrote:
> v2:
>  * Simplify quickstart for the "log" trace backend that is enabled by default
>    [Peter]
>  * Don't show ./configure --enable-trace-backends=log example since it's built
>    by default (changed to --enable-trace-backends=simple,dtrace) [Peter]
> 
> Convert tracing.txt to rST and add it to the generated developer documentation.
> 
> Peter Maydell suggested making the "log" backend the recommended backend in the
> quickstart documentation. It's easier to use than the "simple" backend. The
> final patch updates the documentation to do this.
> 
> Stefan Hajnoczi (3):
>   trace: fix simpletrace doc mismerge
>   tracing: convert documentation to rST
>   trace: recommend "log" backend for getting started with tracing
> 
>  docs/devel/index.rst                    |   1 +
>  docs/devel/{tracing.txt => tracing.rst} | 185 ++++++++++++++----------
>  2 files changed, 107 insertions(+), 79 deletions(-)
>  rename docs/devel/{tracing.txt => tracing.rst} (84%)
> 
> -- 
> 2.29.2
> 

Thanks, applied to my tracing tree:
https://gitlab.com/stefanha/qemu/commits/tracing

Stefan