[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v2 2/2] doc: Use @code rather than @var for options
From: |
David Edmondson |
Subject: |
Re: [PATCH v2 2/2] doc: Use @code rather than @var for options |
Date: |
Tue, 28 Jan 2020 07:39:11 +0000 |
Eric Blake <address@hidden> writes:
> On 1/24/20 4:34 AM, David Edmondson wrote:
>> Texinfo defines @var for metasyntactic variables and such terms are
>> shown in upper-case or italics in the output of makeinfo. When
>> considering an option to a command, such as "-n", upper-casing is
>> undesirable as it may confuse the reader or be in conflict with the
>> equivalent upper-case option.
>>
>> Replace the use of @var for options with @code to avoid this.
>>
>> Signed-off-by: David Edmondson <address@hidden>
>> ---
>> qemu-img.texi | 16 ++++++++--------
>> 1 file changed, 8 insertions(+), 8 deletions(-)
>
> Is this patch still needed given Peter's recent push to move to rST
> documentation?
No, it would be obviated by those changes.
>>
>> diff --git a/qemu-img.texi b/qemu-img.texi
>> index 3b6dfd8682..6b4a1ac961 100644
>> --- a/qemu-img.texi
>> +++ b/qemu-img.texi
>> @@ -74,13 +74,13 @@ keys.
>> @item --image-opts
>> Indicates that the source @var{filename} parameter is to be interpreted as
>> a
>> full option string, not a plain filename. This parameter is mutually
>> -exclusive with the @var{-f} parameter.
>> +exclusive with the @code{-f} parameter.
>>
>
>
> --
> Eric Blake, Principal Software Engineer
> Red Hat, Inc. +1-919-301-3226
> Virtualization: qemu.org | libvirt.org
dme.
--
Don't you know you're never going to get to France.