[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH] docs: add qemu-block-drivers(7) man page
|
From: |
Paolo Bonzini |
|
Subject: |
Re: [Qemu-devel] [PATCH] docs: add qemu-block-drivers(7) man page |
|
Date: |
Mon, 10 Jul 2017 12:00:25 +0200 |
|
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.2.0 |
On 10/07/2017 11:52, Stefan Hajnoczi wrote:
> On Wed, Jul 05, 2017 at 06:08:58PM +0200, Paolo Bonzini wrote:
>> On 22/06/2017 14:17, Stefan Hajnoczi wrote:
>>> address@hidden man begin SYNOPSIS
>>> +QEMU block driver reference manual
>>> address@hidden man end
>>> +
>>
>> I think this should be wrapped with @ignore / @end ignore. Otherwise
>> looks like a great idea.
>
> Why is @ignore needed here? qemu-doc.texi doesn't use it around @c man
> begin SYNOPSIS either.
>
> I've checked both the qemu-doc and qemu-block-drivers output to confirm
> that it appears correct in both man and txt formats.
In the qemu-doc manual, for example, the synopsys of qemu.1 appears at
the beginning of the "invocation" section:
2.3 Invocation
qemu-system-i386 [options] [disk_image]
disk_image is a raw hard disk image for IDE hard disk 0. Some targets
do not need a disk image.
2.3.1 Standard options
...
In your case, "QEMU block driver reference manual" should not appear at
the top of the "Disk image file formats" section, so you need to hide it
from Texinfo.
Paolo
signature.asc
Description: OpenPGP digital signature