summaryrefslogtreecommitdiffstats
path: root/bgpd
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@cumulusnetworks.com>2016-11-30 00:07:11 +0100
committerQuentin Young <qlyoung@cumulusnetworks.com>2016-11-30 00:07:11 +0100
commit3a2d747c2e229f47f5dc32c774ba4e2a07275022 (patch)
tree9c44b94025384d94b4b2d314c9ceb40cc6f850b4 /bgpd
parentlib: allow all characters in WORD tokens (diff)
downloadfrr-3a2d747c2e229f47f5dc32c774ba4e2a07275022.tar.xz
frr-3a2d747c2e229f47f5dc32c774ba4e2a07275022.zip
all: Fix all underfull doc strings
Additionally: * Add [ip] to a couple bgp show commands * Quick refactor of a couple ISIS commands * Quick refactor of a couple OSPF6 commands Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'bgpd')
-rw-r--r--bgpd/bgp_bfd.c3
-rw-r--r--bgpd/bgp_dump.c4
-rw-r--r--bgpd/bgp_mplsvpn.c16
-rw-r--r--bgpd/bgp_nexthop.c3
-rw-r--r--bgpd/bgp_route.c4
-rw-r--r--bgpd/bgp_routemap.c6
-rw-r--r--bgpd/bgp_vty.c66
7 files changed, 67 insertions, 35 deletions
diff --git a/bgpd/bgp_bfd.c b/bgpd/bgp_bfd.c
index 670d959fe..f2393dedd 100644
--- a/bgpd/bgp_bfd.c
+++ b/bgpd/bgp_bfd.c
@@ -680,7 +680,8 @@ DEFUN_HIDDEN (no_neighbor_bfd_type,
NEIGHBOR_STR
NEIGHBOR_ADDR_STR2
"Disables BFD support\n"
- "Session type\n")
+ "Multihop session\n"
+ "Singlehop session\n")
{
int idx_peer = 2;
struct peer *peer;
diff --git a/bgpd/bgp_dump.c b/bgpd/bgp_dump.c
index 511eb3402..add653193 100644
--- a/bgpd/bgp_dump.c
+++ b/bgpd/bgp_dump.c
@@ -792,7 +792,9 @@ DEFUN (no_dump_bgp_all,
"Stop dump process all-et\n"
"Stop dump process updates\n"
"Stop dump process updates-et\n"
- "Stop dump process route-mrt\n")
+ "Stop dump process route-mrt\n"
+ "Output filename\n"
+ "Interval of output\n")
{
int idx_dump_routes = 3;
int bgp_dump_type = 0;
diff --git a/bgpd/bgp_mplsvpn.c b/bgpd/bgp_mplsvpn.c
index 312a9f372..f3a4eebfd 100644
--- a/bgpd/bgp_mplsvpn.c
+++ b/bgpd/bgp_mplsvpn.c
@@ -901,7 +901,8 @@ DEFUN (show_bgp_ivp4_vpn,
SHOW_STR
BGP_STR
"Address Family\n"
- "Display VPN NLRI specific information\n")
+ "Display VPN NLRI specific information\n"
+ JSON_STR)
{
return bgp_show_mpls_vpn (vty, AFI_IP, NULL, bgp_show_type_normal, NULL, 0, use_json (argc, argv));
}
@@ -912,7 +913,8 @@ DEFUN (show_bgp_ipv6_vpn,
SHOW_STR
BGP_STR
"Address Family\n"
- "Display VPN NLRI specific information\n")
+ "Display VPN NLRI specific information\n"
+ JSON_STR)
{
return bgp_show_mpls_vpn (vty, AFI_IP6, NULL, bgp_show_type_normal, NULL, 0, use_json (argc, argv));
}
@@ -968,7 +970,7 @@ DEFUN (show_bgp_ipv6_vpn_rd,
DEFUN (show_ip_bgp_vpnv4_all,
show_ip_bgp_vpnv4_all_cmd,
- "show ip bgp vpnv4 all",
+ "show [ip] bgp vpnv4 all",
SHOW_STR
IP_STR
BGP_STR
@@ -980,7 +982,7 @@ DEFUN (show_ip_bgp_vpnv4_all,
DEFUN (show_ip_bgp_vpnv4_rd,
show_ip_bgp_vpnv4_rd_cmd,
- "show ip bgp vpnv4 rd ASN:nn_or_IP-address:nn",
+ "show [ip] bgp vpnv4 rd ASN:nn_or_IP-address:nn",
SHOW_STR
IP_STR
BGP_STR
@@ -1003,7 +1005,7 @@ DEFUN (show_ip_bgp_vpnv4_rd,
DEFUN (show_ip_bgp_vpnv4_all_tags,
show_ip_bgp_vpnv4_all_tags_cmd,
- "show ip bgp vpnv4 all tags",
+ "show [ip] bgp vpnv4 all tags",
SHOW_STR
IP_STR
BGP_STR
@@ -1040,7 +1042,7 @@ DEFUN (show_ip_bgp_vpnv4_rd_tags,
DEFUN (show_ip_bgp_vpnv4_all_neighbor_routes,
show_ip_bgp_vpnv4_all_neighbor_routes_cmd,
- "show ip bgp vpnv4 all neighbors A.B.C.D routes [json]",
+ "show [ip] bgp vpnv4 all neighbors A.B.C.D routes [json]",
SHOW_STR
IP_STR
BGP_STR
@@ -1167,7 +1169,7 @@ DEFUN (show_ip_bgp_vpnv4_rd_neighbor_routes,
DEFUN (show_ip_bgp_vpnv4_all_neighbor_advertised_routes,
show_ip_bgp_vpnv4_all_neighbor_advertised_routes_cmd,
- "show ip bgp vpnv4 all neighbors A.B.C.D advertised-routes [json]",
+ "show [ip] bgp vpnv4 all neighbors A.B.C.D advertised-routes [json]",
SHOW_STR
IP_STR
BGP_STR
diff --git a/bgpd/bgp_nexthop.c b/bgpd/bgp_nexthop.c
index 493655d7f..57168a460 100644
--- a/bgpd/bgp_nexthop.c
+++ b/bgpd/bgp_nexthop.c
@@ -499,7 +499,8 @@ DEFUN (show_ip_bgp_nexthop,
IP_STR
BGP_STR
BGP_INSTANCE_HELP_STR
- "BGP nexthop table\n")
+ "BGP nexthop table\n"
+ "Show detailed information\n")
{
int idx = 0;
char *vrf = argv_find (argv, argc, "VRFNAME", &idx) ? argv[idx]->arg : NULL;
diff --git a/bgpd/bgp_route.c b/bgpd/bgp_route.c
index f03b5a54b..821111ade 100644
--- a/bgpd/bgp_route.c
+++ b/bgpd/bgp_route.c
@@ -4489,6 +4489,7 @@ DEFUN (bgp_table_map,
DEFUN (no_bgp_table_map,
no_bgp_table_map_cmd,
"no table-map WORD",
+ NO_STR
"BGP table to RIB route download filter\n"
"Name of the route map\n")
{
@@ -9180,7 +9181,7 @@ DEFUN (show_ip_bgp_ipv4_neighbor_prefix_counts,
DEFUN (show_ip_bgp_vpnv4_neighbor_prefix_counts,
show_ip_bgp_vpnv4_neighbor_prefix_counts_cmd,
- "show ip bgp vpnv4 all neighbors <A.B.C.D|X:X::X:X|WORD> prefix-counts [json]",
+ "show [ip] bgp vpnv4 all neighbors <A.B.C.D|X:X::X:X|WORD> prefix-counts [json]",
SHOW_STR
IP_STR
BGP_STR
@@ -9213,6 +9214,7 @@ DEFUN (show_ip_bgp_vpnv4_all_route_prefix,
"Address Family\n"
"Display information about all VPNv4 NLRIs\n"
"Network in the BGP routing table to display\n"
+ "Network in the BGP routing table to display\n"
"JavaScript Object Notation\n")
{
int idx = 0;
diff --git a/bgpd/bgp_routemap.c b/bgpd/bgp_routemap.c
index 070141514..41c9155e4 100644
--- a/bgpd/bgp_routemap.c
+++ b/bgpd/bgp_routemap.c
@@ -3561,7 +3561,8 @@ DEFUN (no_set_ecommunity_rt,
NO_STR
SET_STR
"BGP extended community attribute\n"
- "Route Target extended community\n")
+ "Route Target extended community\n"
+ "VPN extended community\n")
{
return generic_set_delete (vty, vty->index, "extcommunity rt", NULL);
}
@@ -3592,7 +3593,8 @@ DEFUN (no_set_ecommunity_soo,
NO_STR
SET_STR
"BGP extended community attribute\n"
- "Site-of-Origin extended community\n")
+ "Site-of-Origin extended community\n"
+ "VPN extended community\n")
{
return generic_set_delete (vty, vty->index, "extcommunity soo", NULL);
}
diff --git a/bgpd/bgp_vty.c b/bgpd/bgp_vty.c
index 39eb6171c..7a72ab090 100644
--- a/bgpd/bgp_vty.c
+++ b/bgpd/bgp_vty.c
@@ -931,7 +931,8 @@ DEFUN (no_bgp_confederation_identifier,
NO_STR
"BGP specific commands\n"
"AS confederation parameters\n"
- "AS number\n")
+ "AS number\n"
+ "Set routing domain confederation AS\n")
{
struct bgp *bgp;
@@ -1358,6 +1359,7 @@ DEFUN (bgp_coalesce_time,
DEFUN (no_bgp_coalesce_time,
no_bgp_coalesce_time_cmd,
"no coalesce-time (0-4294967295)",
+ NO_STR
"Subgroup coalesce timer\n"
"Subgroup coalesce timer value (in ms)\n")
{
@@ -2020,7 +2022,9 @@ DEFUN (no_bgp_bestpath_med,
"Change the default bestpath selection\n"
"MED attribute\n"
"Compare MED among confederation paths\n"
- "Treat missing MED as the least preferred one\n")
+ "Treat missing MED as the least preferred one\n"
+ "Treat missing MED as the least preferred one\n"
+ "Compare MED among confederation paths\n")
{
struct bgp *bgp = vty->index;
@@ -2607,13 +2611,13 @@ peer_remote_as_vty (struct vty *vty, const char *peer_str,
DEFUN (neighbor_remote_as,
neighbor_remote_as_cmd,
- "neighbor <A.B.C.D|X:X::X:X|WORD> remote-as <(1-4294967295)|external|internal>",
+ "neighbor <A.B.C.D|X:X::X:X|WORD> remote-as <(1-4294967295)|internal|external>",
NEIGHBOR_STR
NEIGHBOR_ADDR_STR2
"Specify a BGP neighbor\n"
AS_STR
- "External BGP peer\n"
- "Internal BGP peer\n")
+ "Internal BGP peer\n"
+ "External BGP peer\n")
{
int idx_peer = 1;
int idx_remote_as = 3;
@@ -2766,13 +2770,14 @@ DEFUN (neighbor_interface_config_v6only,
DEFUN (neighbor_interface_config_remote_as,
neighbor_interface_config_remote_as_cmd,
- "neighbor WORD interface remote-as <(1-4294967295)|external|internal>",
+ "neighbor WORD interface remote-as <(1-4294967295)|internal|external>",
NEIGHBOR_STR
"Interface name or neighbor tag\n"
"Enable BGP on interface\n"
+ "Specify a BGP neighbor\n"
AS_STR
- "External BGP peer\n"
- "Internal BGP peer\n")
+ "Internal BGP peer\n"
+ "External BGP peer\n")
{
int idx_word = 1;
int idx_remote_as = 4;
@@ -2782,13 +2787,15 @@ DEFUN (neighbor_interface_config_remote_as,
DEFUN (neighbor_interface_v6only_config_remote_as,
neighbor_interface_v6only_config_remote_as_cmd,
- "neighbor WORD interface v6only remote-as <(1-4294967295)|external|internal>",
+ "neighbor WORD interface v6only remote-as <(1-4294967295)|internal|external>",
NEIGHBOR_STR
"Interface name or neighbor tag\n"
+ "Enable BGP with v6 link-local only\n"
"Enable BGP on interface\n"
+ "Specify a BGP neighbor\n"
AS_STR
- "External BGP peer\n"
- "Internal BGP peer\n")
+ "Internal BGP peer\n"
+ "External BGP peer\n")
{
int idx_word = 1;
int idx_remote_as = 5;
@@ -2828,7 +2835,11 @@ DEFUN (no_neighbor,
"no neighbor <A.B.C.D|X:X::X:X|WORD> [remote-as <(1-4294967295)|internal|external>]",
NO_STR
NEIGHBOR_STR
- NEIGHBOR_ADDR_STR2)
+ NEIGHBOR_ADDR_STR2
+ "Specify a BGP neighbor\n"
+ AS_STR
+ "Internal BGP peer\n"
+ "External BGP peer\n")
{
int idx_peer = 2;
int ret;
@@ -2892,8 +2903,10 @@ DEFUN (no_neighbor_interface_config,
"Enable BGP with v6 link-local only\n"
"Member of the peer-group\n"
"Peer-group name\n"
- "Specify remote AS\n"
- AS_STR)
+ "Specify a BGP neighbor\n"
+ AS_STR
+ "Internal BGP peer\n"
+ "External BGP peer\n")
{
int idx_word = 2;
struct peer *peer;
@@ -2944,7 +2957,9 @@ DEFUN (no_neighbor_interface_peer_group_remote_as,
NEIGHBOR_STR
"Interface name or neighbor tag\n"
"Specify a BGP neighbor\n"
- AS_STR)
+ AS_STR
+ "Internal BGP peer\n"
+ "External BGP peer\n")
{
int idx_word = 2;
struct peer_group *group;
@@ -4720,6 +4735,7 @@ DEFUN (no_bgp_set_route_map_delay_timer,
no_bgp_set_route_map_delay_timer_cmd,
"no bgp route-map delay-timer [(0-600)]",
NO_STR
+ BGP_STR
"Default BGP route-map delay timer\n"
"Reset to default time to wait for processing route-map changes\n"
"0 disables the timer, no route updates happen when route-maps change\n")
@@ -5440,7 +5456,8 @@ DEFUN (no_neighbor_ttl_security,
NEIGHBOR_STR
NEIGHBOR_ADDR_STR2
"BGP ttl-security parameters\n"
- "Specify the maximum number of hops to the BGP peer\n")
+ "Specify the maximum number of hops to the BGP peer\n"
+ "Number of hops to BGP peer\n")
{
int idx_peer = 2;
struct peer *peer;
@@ -5579,7 +5596,7 @@ DEFUN (address_family_vpnv4,
"address-family vpnv4 [unicast]",
"Enter Address Family command mode\n"
"Address Family\n"
- "Address Family Modifier\n")
+ "Address Family modifier\n")
{
vty->node = BGP_VPNV4_NODE;
return CMD_SUCCESS;
@@ -5590,7 +5607,7 @@ DEFUN (address_family_vpnv6,
"address-family vpnv6 [unicast]",
"Enter Address Family command mode\n"
"Address Family\n"
- "Address Family Modifier\n")
+ "Address Family modifier\n")
{
vty->node = BGP_VPNV6_NODE;
return CMD_SUCCESS;
@@ -5881,10 +5898,11 @@ DEFUN (clear_bgp_ipv6_safi_prefix,
clear_bgp_ipv6_safi_prefix_cmd,
"clear [ip] bgp ipv6 <unicast|multicast> prefix X:X::X:X/M",
CLEAR_STR
+ IP_STR
BGP_STR
"Address Family\n"
- "Address Family Modifier\n"
- "Address Family Modifier\n"
+ "Address Family modifier\n"
+ "Address Family modifier\n"
"Clear bestpath and re-advertise\n"
"IPv6 prefix\n")
{
@@ -5900,11 +5918,12 @@ DEFUN (clear_bgp_instance_ipv6_safi_prefix,
clear_bgp_instance_ipv6_safi_prefix_cmd,
"clear [ip] bgp <view|vrf> WORD ipv6 <unicast|multicast> prefix X:X::X:X/M",
CLEAR_STR
+ IP_STR
BGP_STR
BGP_INSTANCE_HELP_STR
"Address Family\n"
- "Address Family Modifier\n"
- "Address Family Modifier\n"
+ "Address Family modifier\n"
+ "Address Family modifier\n"
"Clear bestpath and re-advertise\n"
"IPv6 prefix\n")
{
@@ -6062,6 +6081,7 @@ DEFUN (show_bgp_memory,
show_bgp_memory_cmd,
"show [ip] bgp memory",
SHOW_STR
+ IP_STR
BGP_STR
"Global BGP memory statistics\n")
{
@@ -8573,6 +8593,8 @@ DEFUN (show_ip_bgp_paths,
SHOW_STR
IP_STR
BGP_STR
+ "Address Family modifier\n"
+ "Address Family modifier\n"
"Path information\n")
{
vty_out (vty, "Address Refcnt Path%s", VTY_NEWLINE);