From: Igor Ryzhov Date: Wed, 2 Jun 2021 23:19:36 +0000 (+0300) Subject: doc: remove varnames from command descriptions X-Git-Tag: base_8.1~464^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=cc2a89dba094bdf9fcfa171fcc1316709dee626f;p=mirror%2Ffrr.git doc: remove varnames from command descriptions Signed-off-by: Igor Ryzhov --- diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst index 99c024d118..4e5674e736 100644 --- a/doc/user/bfd.rst +++ b/doc/user/bfd.rst @@ -124,7 +124,7 @@ BFDd Commands Show all configured BFD peers information and current status. -.. clicmd:: show bfd [vrf NAME$vrf_name] peer $peer [{multihop|local-address $local|interface IFNAME$ifname}]> [json] +.. clicmd:: show bfd [vrf NAME] peer [{multihop|local-address |interface IFNAME}]> [json] Show status for a specific BFD peer. diff --git a/doc/user/sharp.rst b/doc/user/sharp.rst index 0542a593ae..aa0ad6a102 100644 --- a/doc/user/sharp.rst +++ b/doc/user/sharp.rst @@ -108,14 +108,14 @@ keyword. At present, no sharp commands will be preserved in the config. Send opaque ZAPI messages with subtype ``type``. Sharpd will send a stream of messages if the count is greater than one. -.. clicmd:: sharp send opaque unicast type (1-255) $proto_str [{instance (0-1000) | session (1-1000)}] (1-1000) +.. clicmd:: sharp send opaque unicast type (1-255) PROTOCOL [{instance (0-1000) | session (1-1000)}] (1-1000) Send unicast opaque ZAPI messages with subtype ``type``. The protocol, instance, and session_id identify a single target zapi client. Sharpd will send a stream of messages if the count is greater than one. -.. clicmd:: sharp send opaque $proto_str [{instance (0-1000) | session (1-1000)}] type (1-1000) +.. clicmd:: sharp send opaque PROTOCOL [{instance (0-1000) | session (1-1000)}] type (1-1000) Send opaque ZAPI registration and unregistration messages for a single subtype. The messages must specify a protocol daemon by