From: Trey Aspelund <taspelund@nvidia.com>
Date: Fri, 3 Feb 2023 21:11:48 +0000 (+0000)
Subject: doc: prefix match for advertised/received-routes
X-Git-Tag: base_9.0~410^2~1
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=bda4a61288e87376dcc08180a3b81242a212b2e6;p=matthieu%2Ffrr.git

doc: prefix match for advertised/received-routes

Doc changes for new prefix matching.

Signed-off-by: Trey Aspelund <taspelund@nvidia.com>
---

diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst
index 9c69848258..eaa675edd9 100644
--- a/doc/user/bgp.rst
+++ b/doc/user/bgp.rst
@@ -3916,7 +3916,7 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`.
    The ``terse`` option can be used in combination with the remote-as, neighbor,
    failed and established filters, and with the ``wide`` option as well.
 
-.. clicmd:: show bgp [afi] [safi] [neighbor [PEER] [routes|advertised-routes|received-routes] [detail] [json]
+.. clicmd:: show bgp [afi] [safi] [neighbor [PEER] [routes|advertised-routes|received-routes] [<A.B.C.D/M|X:X::X:X/M> | detail] [json]
 
    This command shows information on a specific BGP peer of the relevant
    afi and safi selected.
@@ -3931,6 +3931,9 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`.
    The ``received-routes`` keyword displays all routes belonging to this
    address-family (prior to inbound policy) that were received by this peer.
 
+   If a specific prefix is specified, the detailed version of that prefix will
+   be displayed.
+
    If ``detail`` option is specified, the detailed version of all routes
    will be displayed. The same format as ``show [ip] bgp [afi] [safi] PREFIX``
    will be used, but for the whole table of received, advertised or filtered
@@ -4030,7 +4033,7 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`.
 
    If the ``json`` option is specified, output is displayed in JSON format.
 
-.. clicmd:: show [ip] bgp [afi] [safi] [all] neighbors A.B.C.D [advertised-routes|received-routes|filtered-routes] [detail] [json|wide]
+.. clicmd:: show [ip] bgp [afi] [safi] [all] neighbors A.B.C.D [advertised-routes|received-routes|filtered-routes] [<A.B.C.D/M|X:X::X:X/M> | detail] [json|wide]
 
    Display the routes advertised to a BGP neighbor or received routes
    from neighbor or filtered routes received from neighbor based on the
@@ -4047,6 +4050,9 @@ structure is extended with :clicmd:`show bgp [afi] [safi]`.
    if afi is specified, with ``all`` option, routes will be displayed for
    each SAFI in the selcted AFI
 
+   If a specific prefix is specified, the detailed version of that prefix will
+   be displayed.
+
    If ``detail`` option is specified, the detailed version of all routes
    will be displayed. The same format as ``show [ip] bgp [afi] [safi] PREFIX``
    will be used, but for the whole table of received, advertised or filtered