Re: [Qemu-devel] [PATCH 3/3] monitor: added generation of documentation for hmp-commands-info.hx

[Peter Maydell]

On 28 August 2015 at 08:00, Pavel Butsykin <address@hidden> wrote:
>
>
> On 27.08.2015 20:39, Peter Maydell wrote:
>>
>> On 12 August 2015 at 12:50, Denis V. Lunev <address@hidden> wrote:
>>>
>>> From: Pavel Butsykin <address@hidden>
>>>
>>> It will be easier if you need to add info-commands to edit
>>> only hmp-commands-info.hx, before this had to edit monitor.c and
>>> hmp-commands.hx

>>> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
>>> index 9ccb33f..81ae9d7 100644
>>> --- a/hmp-commands-info.hx
>>> +++ b/hmp-commands-info.hx
>>> @@ -6,6 +6,9 @@ HXCOMM monitor info commands
>>>   HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>>>
>>>   STEXI
>>> address@hidden info @var{subcommand}
>>> address@hidden info
>>> +Show various information about the system state.
>>>   @table @option
>>>   ETEXI
>>>
>>> @@ -708,4 +711,5 @@ ETEXI
>>>
>>>   STEXI
>>>   @end table
>>> address@hidden table
>>>   ETEXI
>>
>> Where does this extra "@end table" come from?
>>
>> thanks
>> -- PMM
>
> This "@end table" come from hmp-commands.hx and it's necessary to close tag
> "@subsection Commands" from qemu-doc.texi

If the tag is opened in qemu-doc.texi then I think
qemu-doc.texi ought to be responsible for closing it.

This may be related to a bug in the docs (as they are
in master) where we close the table too early and so
the 'info trace-events' and rocker related info subcommands
aren't indented properly. (Also the rocker subcommands
don't say "info $subcommand" the way the others do.)

thanks
-- PMM