From 32ff65ac6fda5d292c405718387d73e5ae130141 Mon Sep 17 00:00:00 2001 From: Ilya Maximets Date: Mon, 19 Aug 2024 21:42:24 +0200 Subject: [PATCH] docs: Fix argument formatting in ovs-appctl(8) man page. The synopsis is not printed out correctly, because "``" is not spaced out from the text correctly. Use the "\ " to separate. This symbol will not be rendered, but allows to separate the formatting inside rST. Also, arguments in man pages are typically underlined instead of being normal text in triangular brackets. Fixing a couple other minor issues along the way. Acked-by: Simon Horman Signed-off-by: Ilya Maximets --- Documentation/ref/ovs-appctl.8.rst | 91 +++++++++++++++--------------- 1 file changed, 46 insertions(+), 45 deletions(-) diff --git a/Documentation/ref/ovs-appctl.8.rst b/Documentation/ref/ovs-appctl.8.rst index 7054cf559e5..e7c8b96d491 100644 --- a/Documentation/ref/ovs-appctl.8.rst +++ b/Documentation/ref/ovs-appctl.8.rst @@ -6,11 +6,11 @@ Synopsis ======== ``ovs-appctl`` -[``--target=`` | ``-t`` ] -[``--timeout=`` | ``-T`` ] -[``--format=`` | ``-f`` ] +[``--target=``\ *target* | ``-t`` *target*] +[``--timeout=``\ *secs* | ``-T`` *secs*] +[``--format=``\ *format* | ``-f`` *format*] [``--pretty``] - [...] +*command* [*arg* ``...``] ``ovs-appctl --help`` @@ -33,11 +33,11 @@ command and prints the daemon's response on standard output. In normal use only a single option is accepted: -* ``-t`` or ``--target`` +* ``-t`` *target* or ``--target=``\ *target* Tells ``ovs-appctl`` which daemon to contact. - If begins with ``/`` it must name a Unix domain socket on + If *target* begins with ``/`` it must name a Unix domain socket on which an Open vSwitch daemon is listening for control channel connections. By default, each daemon listens on a Unix domain socket in the rundir (e.g. ``/run``) named ``..ctl``, where @@ -47,33 +47,33 @@ In normal use only a single option is accepted: Otherwise, ``ovs-appctl`` looks in the rundir for a pidfile, that is, a file whose contents are the process ID of a running process as a - decimal number, named ``.pid``. (The ``--pidfile`` option + decimal number, named *target*\ ``.pid``. (The ``--pidfile`` option makes an Open vSwitch daemon create a pidfile.) ``ovs-appctl`` reads the pidfile, then looks in the rundir for a Unix socket named - ``..ctl``, where is replaced by the process ID read + *target*\ ``..ctl``, where is replaced by the process ID read from the pidfile, and uses that file as if it had been specified directly as the target. - On Windows, can be an absolute path to a file that contains a + On Windows, *target* can be an absolute path to a file that contains a localhost TCP port on which an Open vSwitch daemon is listening for control channel connections. By default, each daemon writes the TCP port on which it is listening for control connection into the file - ``.ctl`` located inside the rundir. If is not an + ``.ctl`` located inside the rundir. If *target* is not an absolute path, ``ovs-appctl`` looks in the rundir for a file named - ``.ctl``. The default target is ``ovs-vswitchd``. + *target*\ ``.ctl``. The default *target* is ``ovs-vswitchd``. -* ``-T `` or ``--timeout=`` +* ``-T`` *secs* or ``--timeout=``\ *secs* - By default, or with a of ``0``, ``ovs-appctl`` waits forever to + By default, or with a *secs* of ``0``, ``ovs-appctl`` waits forever to connect to the daemon and receive a response. This option limits - runtime to approximately seconds. If the timeout expires, + runtime to approximately *secs* seconds. If the timeout expires, ``ovs-appctl`` exits with a ``SIGALRM`` signal. -* ``-f `` or ``--format=`` +* ``-f`` *format* or ``--format=``\ *format* Tells ``ovs-appctl`` which output format to use. By default, or with a - of ``text``, ``ovs-appctl`` will print plain-text for humans. - When is ``json``, ``ovs-appctl`` will return a JSON document. + *format* of ``text``, ``ovs-appctl`` will print plain-text for humans. + When *format* is ``json``, ``ovs-appctl`` will return a JSON document. When ``json`` is requested, but a command has not implemented JSON output, the plain-text output will be wrapped in a provisional JSON document with the following structure:: @@ -158,10 +158,10 @@ and adjusting log levels: Lists logging pattern used for each destination. -* ``vlog/set`` [] +* ``vlog/set`` [*spec*] - Sets logging levels. Without any , sets the log level for - every module and destination to ``dbg``. Otherwise, is a + Sets logging levels. Without any *spec*, sets the log level for + every module and destination to ``dbg``. Otherwise, *spec* is a list of words separated by spaces or commas or colons, up to one from each category below: @@ -173,7 +173,7 @@ and adjusting log levels: change to only to the system log, to the console, or to a file, respectively. - On Windows platform, ``syslog`` is only useful if was + On Windows platform, ``syslog`` is only useful if *target* was started with the ``--syslog-target`` option (it has no effect otherwise). @@ -182,20 +182,20 @@ and adjusting log levels: will be logged, and messages of lower severity will be filtered out. ``off`` filters out all messages. - Case is not significant within . + Case is not significant within *spec*. Regardless of the log levels set for ``file``, logging to a file will not take place unless the target application was invoked with the ``--log-file`` option. For compatibility with older versions of OVS, ``any`` is accepted - within but it has no effect. + within *spec* but it has no effect. -* ``vlog/set PATTERN::`` +* ``vlog/set PATTERN:``\ *destination*:*pattern* - Sets the log pattern for to . Each time a - message is logged to , determines the - message's formatting. Most characters in are copied + Sets the log pattern for *destination* to *pattern*. Each time a + message is logged to *destination*, *pattern* determines the + message's formatting. Most characters in *pattern* are copied literally to the log, but special escapes beginning with ``%`` are expanded as follows: @@ -214,13 +214,13 @@ and adjusting log levels: * ``%d`` - The current date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS). + The current date and time in ISO 8601 format (``YYYY-MM-DD HH:MM:SS``). - * ``%d{}`` + * ``%d{``\ *format*\ ``}`` - The current date and time in the specified , which takes - the same format as the