[Qemu-devel] [PATCH] qemu-doc: Add missing "@c man end" statements

[Qemu-devel] [PATCH] qemu-doc: Add missing "@c man end" statements

[Thomas Huth]

Since commit 3f2ce724f1f1 ("Move the qemu-ga description into a
separate chapter"), the qemu.1 man page looks pretty much screwed
up, e.g. the title was "qemu-ga - QEMU Guest Agent" instead of
"qemu-doc - QEMU Emulator User Documentation". However, that movement
of the gemu-ga chapter is not the real problem, it just triggered
another bug in the qemu-doc.texi: There are some parts in the file
which introduce a "@c man begin OPTIONS" section, but never close
it again with "@c man end". After adding the proper end tags here,
the title of the man page is right again and the previously wrongly
tagged sections now also show up correctly in the man page, too.

Reported-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-doc.texi | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 965ba59..d23c796 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -2565,6 +2565,8 @@ so should only be used with trusted guest OS.
 
 @end table
 
+@c man end
+
 @node ColdFire System emulator
 @section ColdFire System emulator
 @cindex system emulation (ColdFire)
@@ -2609,6 +2611,8 @@ so should only be used with trusted guest OS.
 
 @end table
 
+@c man end
+
 @node Cris System emulator
 @section Cris System emulator
 @cindex system emulation (Cris)
@@ -2681,6 +2685,8 @@ so should only be used with trusted guest OS.
 
 @end table
 
+@c man end
+
 @node QEMU Guest Agent
 @chapter QEMU Guest Agent invocation
 
-- 
1.8.3.1

Re: [Qemu-devel] [PATCH] qemu-doc: Add missing "@c man end" statements

[Kevin Wolf]

Am 19.06.2017 um 11:16 hat Thomas Huth geschrieben:
> Since commit 3f2ce724f1f1 ("Move the qemu-ga description into a
> separate chapter"), the qemu.1 man page looks pretty much screwed
> up, e.g. the title was "qemu-ga - QEMU Guest Agent" instead of
> "qemu-doc - QEMU Emulator User Documentation". However, that movement
> of the gemu-ga chapter is not the real problem, it just triggered
> another bug in the qemu-doc.texi: There are some parts in the file
> which introduce a "@c man begin OPTIONS" section, but never close
> it again with "@c man end". After adding the proper end tags here,
> the title of the man page is right again and the previously wrongly
> tagged sections now also show up correctly in the man page, too.
> 
> Reported-by: Kevin Wolf <kwolf@redhat.com>
> Signed-off-by: Thomas Huth <thuth@redhat.com>

Michael, do you want to take this through qemu-trivial?

Kevin

Re: [Qemu-devel] [PATCH] qemu-doc: Add missing "@c man end" statements

[Paolo Bonzini]

On 04/07/2017 16:46, Kevin Wolf wrote:
> Am 19.06.2017 um 11:16 hat Thomas Huth geschrieben:
>> Since commit 3f2ce724f1f1 ("Move the qemu-ga description into a
>> separate chapter"), the qemu.1 man page looks pretty much screwed
>> up, e.g. the title was "qemu-ga - QEMU Guest Agent" instead of
>> "qemu-doc - QEMU Emulator User Documentation". However, that movement
>> of the gemu-ga chapter is not the real problem, it just triggered
>> another bug in the qemu-doc.texi: There are some parts in the file
>> which introduce a "@c man begin OPTIONS" section, but never close
>> it again with "@c man end". After adding the proper end tags here,
>> the title of the man page is right again and the previously wrongly
>> tagged sections now also show up correctly in the man page, too.
>>
>> Reported-by: Kevin Wolf <kwolf@redhat.com>
>> Signed-off-by: Thomas Huth <thuth@redhat.com>
> 
> Michael, do you want to take this through qemu-trivial?

FWIW, I'm sending it out tomorrow.  Already tested the pull request, but
I'd like Richard to take another look at the final version of the
TCG-disabling patches and not rush them out.

Paolo