| Message ID | 20200124103458.1525982-3-david.edmondson@oracle.com |
|---|---|
| State | New |
| Headers | show |
| Series | qemu-img: Add --target-is-zero to indicate that a target is blank | expand |
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 <david.edmondson@oracle.com> > --- > 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? > > 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 <eblake@redhat.com> 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 <david.edmondson@oracle.com> >> --- >> 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.
On Tue, 28 Jan 2020 at 07:39, David Edmondson <dme@dme.org> wrote: > > Eric Blake <eblake@redhat.com> 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 <david.edmondson@oracle.com> > >> --- > >> 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
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. @item --target-image-opts Indicates that the @var{output_filename} parameter(s) are to be interpreted as a full option string, not a plain filename. This parameter is mutually -exclusive with the @var{-O} parameters. It is currently required to also use -the @var{-n} parameter to skip image creation. This restriction may be relaxed +exclusive with the @code{-O} parameters. It is currently required to also use +the @code{-n} parameter to skip image creation. This restriction may be relaxed in a future release. @item --force-share (-U) @@ -103,13 +103,13 @@ with or without a command shows help and lists the supported formats @item -p display progress bar (compare, convert and rebase commands only). -If the @var{-p} option is not used for a command that supports it, the +If the @code{-p} option is not used for a command that supports it, the progress is reported when the process receives a @code{SIGUSR1} or @code{SIGINFO} signal. @item -q Quiet mode - do not print any output (except errors). There's no progress bar -in case both @var{-q} and @var{-p} options are used. +in case both @code{-q} and @code{-p} options are used. @item -S @var{size} indicates the consecutive number of bytes that must contain only zeros @@ -298,14 +298,14 @@ the top image stays valid). Check if two images have the same content. You can compare images with different format or settings. -The format is probed unless you specify it by @var{-f} (used for -@var{filename1}) and/or @var{-F} (used for @var{filename2}) option. +The format is probed unless you specify it by @code{-f} (used for +@var{filename1}) and/or @code{-F} (used for @var{filename2}) option. By default, images with different size are considered identical if the larger image contains only unallocated and/or zeroed sectors in the area after the end of the other image. In addition, if any sector is not allocated in one image and contains only zero bytes in the second one, it is evaluated as equal. You -can use Strict mode by specifying the @var{-s} option. When compare runs in +can use Strict mode by specifying the @code{-s} option. When compare runs in Strict mode, it fails in case image size differs or a sector is allocated in one image and is not allocated in the second one.
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 <david.edmondson@oracle.com> --- qemu-img.texi | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)