[Qemu-devel] [PATCH] qemu-doc: Move the qemu-ga description into a separate chapter

[Qemu-devel] [PATCH] qemu-doc: Move the qemu-ga description into a separate chapter

[Thomas Huth]

The qemu-ga description is currently a subsection of the Disk Images
chapter - which does not make much sense since the qemu-ga is not
directly related to disk images. So let's move this information
into a separate chapter instead.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-doc.texi | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/qemu-doc.texi b/qemu-doc.texi
index b0bfd84..965ba59 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -34,6 +34,7 @@
 * Introduction::
 * QEMU PC System emulator::
 * QEMU System emulator for non PC targets::
+* QEMU Guest Agent::
 * QEMU User space emulator::
 * Implementation notes::
 * License::
@@ -396,7 +397,6 @@ snapshots.
 * vm_snapshots::              VM snapshots
 * qemu_img_invocation::       qemu-img Invocation
 * qemu_nbd_invocation::       qemu-nbd Invocation
-* qemu_ga_invocation::        qemu-ga Invocation
 * disk_images_formats::       Disk image file formats
 * host_drives::               Using host drives
 * disk_images_fat_images::    Virtual FAT disk images
@@ -490,11 +490,6 @@ state is not saved or restored properly (in particular USB).
 
 @include qemu-nbd.texi
 
-@node qemu_ga_invocation
-@subsection @code{qemu-ga} Invocation
-
-@include qemu-ga.texi
-
 @node disk_images_formats
 @subsection Disk image file formats
 
@@ -2685,6 +2680,12 @@ Note that this allows guest direct access to the host filesystem,
 so should only be used with trusted guest OS.
 
 @end table
+
+@node QEMU Guest Agent
+@chapter QEMU Guest Agent invocation
+
+@include qemu-ga.texi
+
 @node QEMU User space emulator
 @chapter QEMU User space emulator
 
-- 
1.8.3.1

Re: [Qemu-devel] [PATCH] qemu-doc: Move the qemu-ga description into a separate chapter

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 509 bytes --]

On Mon, May 22, 2017 at 10:53:29PM +0200, Thomas Huth wrote:
> The qemu-ga description is currently a subsection of the Disk Images
> chapter - which does not make much sense since the qemu-ga is not
> directly related to disk images. So let's move this information
> into a separate chapter instead.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  qemu-doc.texi | 13 +++++++------
>  1 file changed, 7 insertions(+), 6 deletions(-)

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 455 bytes --]

Re: [Qemu-devel] [PATCH] qemu-doc: Move the qemu-ga description into a separate chapter

[Michael Tokarev]

Applied to -trivial, thanks!

/mjt

Re: [Qemu-devel] [PATCH] qemu-doc: Move the qemu-ga description into a separate chapter

[Kevin Wolf]

Am 22.05.2017 um 22:53 hat Thomas Huth geschrieben:
> The qemu-ga description is currently a subsection of the Disk Images
> chapter - which does not make much sense since the qemu-ga is not
> directly related to disk images. So let's move this information
> into a separate chapter instead.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>

This patch messed up the start of the manpage (qemu.1).

It refers to "qemu-ga - QEMU Guest Agent" now and the synopsis section
includes the description of a part of the targets as well as some
literal texinfo code.

Kevin

Re: [Qemu-devel] [PATCH] qemu-doc: Move the qemu-ga description into a separate chapter

[Thomas Huth]

On 16.06.2017 18:19, Kevin Wolf wrote:
> Am 22.05.2017 um 22:53 hat Thomas Huth geschrieben:
>> The qemu-ga description is currently a subsection of the Disk Images
>> chapter - which does not make much sense since the qemu-ga is not
>> directly related to disk images. So let's move this information
>> into a separate chapter instead.
>>
>> Signed-off-by: Thomas Huth <thuth@redhat.com>
> 
> This patch messed up the start of the manpage (qemu.1).
> 
> It refers to "qemu-ga - QEMU Guest Agent" now and the synopsis section
> includes the description of a part of the targets as well as some
> literal texinfo code.

I just had a look at it, and the qemu-ga patch just triggered another
problem in qemu-doc.texi to become more obvious: There were some
sections opened with "@c man begin OPTIONS" but never closed again.
After closing them properly, the man page looks right again (and the
badly marked sections now also show up in the man page correctly). I
just sent a patch.
Maybe we should also add some logic to scripts/texi2pod.pl that emits a
warning when a "@c man" section is not closed properly? (Someone with
the right Perl-foo around here?)

 Thomas