From patchwork Mon Aug 19 19:42:24 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ilya Maximets X-Patchwork-Id: 1973950 X-Patchwork-Delegate: i.maximets@samsung.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=2605:bc80:3010::138; helo=smtp1.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=patchwork.ozlabs.org) Received: from smtp1.osuosl.org (smtp1.osuosl.org [IPv6:2605:bc80:3010::138]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4Wnjgl3XCzz1yXf for ; Tue, 20 Aug 2024 05:43:15 +1000 (AEST) Received: from localhost (localhost [127.0.0.1]) by smtp1.osuosl.org (Postfix) with ESMTP id 3A8C280FB9; Mon, 19 Aug 2024 19:43:13 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp1.osuosl.org ([127.0.0.1]) by localhost (smtp1.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id tBgbv543KfNN; Mon, 19 Aug 2024 19:43:11 +0000 (UTC) X-Comment: SPF check N/A for local connections - client-ip=2605:bc80:3010:104::8cd3:938; helo=lists.linuxfoundation.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver= DKIM-Filter: OpenDKIM Filter v2.11.0 smtp1.osuosl.org EE72F80DE8 Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [IPv6:2605:bc80:3010:104::8cd3:938]) by smtp1.osuosl.org (Postfix) with ESMTPS id EE72F80DE8; Mon, 19 Aug 2024 19:43:10 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id D995CC000E; Mon, 19 Aug 2024 19:43:10 +0000 (UTC) X-Original-To: ovs-dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp3.osuosl.org (smtp3.osuosl.org [IPv6:2605:bc80:3010::136]) by lists.linuxfoundation.org (Postfix) with ESMTP id A8D5BC000D for ; Mon, 19 Aug 2024 19:43:09 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp3.osuosl.org (Postfix) with ESMTP id 8AD7E60662 for ; Mon, 19 Aug 2024 19:43:09 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp3.osuosl.org ([127.0.0.1]) by localhost (smtp3.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id FEC9L1lPUztZ for ; Mon, 19 Aug 2024 19:43:08 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=209.85.218.66; helo=mail-ej1-f66.google.com; envelope-from=i.maximets.ovn@gmail.com; receiver= DMARC-Filter: OpenDMARC Filter v1.4.2 smtp3.osuosl.org 76D87606D5 Authentication-Results: smtp3.osuosl.org; dmarc=none (p=none dis=none) header.from=ovn.org DKIM-Filter: OpenDKIM Filter v2.11.0 smtp3.osuosl.org 76D87606D5 Received: from mail-ej1-f66.google.com (mail-ej1-f66.google.com [209.85.218.66]) by smtp3.osuosl.org (Postfix) with ESMTPS id 76D87606D5 for ; Mon, 19 Aug 2024 19:43:07 +0000 (UTC) Received: by mail-ej1-f66.google.com with SMTP id a640c23a62f3a-a80ea7084e9so240982066b.0 for ; Mon, 19 Aug 2024 12:43:07 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724096585; x=1724701385; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=/YYiji/JRBYsqCPkpMDORCjN7Y/P70/4Enz2R2N7QI0=; b=rYQBFeNwTcGgYl+ZdA+qFuw5N9twEE2Yj24A++MTSXg11tWkgn5skJxkiHUub8Bdiy HL9EnCiRYkTSL6ZlOg1RntsKmHExyR8uQvgBQjv8r7H7LkQpuUta3Q2RlKQn5xZAvLaD HwzhnCTktn9rgeKJuJVk2HrpowD33ZCz+LG06gB3pSxcduUo5v9NFAmwFxdtT2Md4oPD lg9OWKdi9dqfW4T1OlHWGZthk8oyBuaDW8fqC10NHHYJRByzM4lD9MCHt9eWyO01ijkR j9trplyvFYRBhKAw8wwpp0MXWNEg/2o88NnKAd937koRDYLFsyhntZDihIzuyKpeQu1Q mHtQ== X-Gm-Message-State: AOJu0YwPptCz1Fz2KeQKa1L4OF7hn4WbmWJTOBmCeHt4as3bku7bQPlo ebQPAkpq9s2nmMhN35cis4KnPYy//K1u6UAy4SvCXZR77bfrxhptPdEDMC/poY0= X-Google-Smtp-Source: AGHT+IHXK9Ns8TlTiD4Dz0CC90ylV9mw1eGm3bA9lyNhwyMa3Le93lB0EdngIBYFUqvAMQzb9oiXyA== X-Received: by 2002:a05:6402:42c8:b0:5be:f363:633b with SMTP id 4fb4d7f45d1cf-5bef363654bmr4332646a12.1.1724096584575; Mon, 19 Aug 2024 12:43:04 -0700 (PDT) Received: from im-t490s.redhat.com (ip-86-49-44-151.bb.vodafone.cz. [86.49.44.151]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-5becf1f3442sm4471765a12.31.2024.08.19.12.43.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 19 Aug 2024 12:43:04 -0700 (PDT) From: Ilya Maximets To: ovs-dev@openvswitch.org Cc: Ilya Maximets Date: Mon, 19 Aug 2024 21:42:24 +0200 Message-ID: <20240819194301.1828180-1-i.maximets@ovn.org> X-Mailer: git-send-email 2.46.0 MIME-Version: 1.0 Subject: [ovs-dev] [PATCH] docs: Fix argument formatting in ovs-appctl(8) man page. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" 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. Signed-off-by: Ilya Maximets Acked-by: Simon Horman --- 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 7054cf559..e7c8b96d4 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