Re: [PATCH v2 2/2] doc: Use @code rather than @var for options

[Peter Maydell]

On Tue, 28 Jan 2020 at 07:39, David Edmondson <address@hidden> wrote:
>
> 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.

Yeah; in particular the rST formatting corrects this minor
inconsistency. (I noticed it because my emacs find-and-replace
operations which turn @var{foo} into *FOO* were incorrectly
turning the @var{-s} into *-S*, which they wouldn't have done
if it were @code{-s}...)

thanks
-- PMM