Skip to content

Commit

Permalink
Fix markup issue in qvm-create.rst: *NAME*=*VALUE*
Browse files Browse the repository at this point in the history
The used technique is described in reStructuredText Markup Specification, chapter Character-Level Inline Markup: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#character-level-inline-markup-1
Note, that according to docs this solution should be used only when absolutely necessary.  I think it is exactly our case, because, it seems, there is no other proper way to separate equal sign out of emphasis of the NAME and VALUE.
Github preview of `qvm-create.rst` file is now correct, too.
Alternative solutions would be to use `*NAME=VALUE*` or NAME=VALUE instead, but the result will not be completely right.
  • Loading branch information
jamke committed Aug 7, 2023
1 parent e03298c commit 6163757
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/manpages/qvm-create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Synopsis
--------

:command:`qvm-create` [-h] [--verbose] [--quiet] [--force-root] [--class *CLS*] [--property *NAME*=*VALUE*] [--pool *POOL_NAME:VOLUME_NAME*] [--template *VALUE*] --label *VALUE* [--root-copy-from *FILENAME* | --root-move-from *FILENAME*] *VMNAME*
:command:`qvm-create` [-h] [--verbose] [--quiet] [--force-root] [--class *CLS*] [--property *NAME*\ =\ *VALUE*] [--pool *POOL_NAME:VOLUME_NAME*] [--template *VALUE*] --label *VALUE* [--root-copy-from *FILENAME* | --root-move-from *FILENAME*] *VMNAME*
:command:`qvm-create` --help-classes

Options
Expand Down

0 comments on commit 6163757

Please sign in to comment.