Skip to content

Commit 1a75870

Browse files
[CLI][Help string] Changed the show command help text to be more consistent with each other.
1 parent 818dcbf commit 1a75870

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

config/muxcable.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def get_value_for_key_in_config_tbl(config_db, port, key, table):
203203

204204
@click.group(name='muxcable', cls=clicommon.AliasedGroup)
205205
def muxcable():
206-
"""SONiC command line - 'show muxcable' command"""
206+
"""Show muxcable information"""
207207

208208
if os.geteuid() != 0:
209209
click.echo("Root privileges are required for this operation")

doc/Command-Reference.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ This command displays the full list of show commands available in the software;
381381
ipv6 Show IPv6 commands
382382
kubernetes Show kubernetes commands
383383
line Show all /dev/ttyUSB lines and their info
384-
lldp LLDP (Link Layer Discovery Protocol)...
384+
lldp Show LLDP information
385385
logging Show system log
386386
mac Show MAC (FDB) entries
387387
mirror_session Show existing everflow sessions
@@ -393,10 +393,10 @@ This command displays the full list of show commands available in the software;
393393
pfc Show details of the priority-flow-control...
394394
platform Show platform-specific hardware info
395395
priority-group Show details of the PGs
396-
processes Display process information
396+
processes Show process information
397397
queue Show details of the queues
398398
reboot-cause Show cause of most recent reboot
399-
route-map show route-map
399+
route-map Show route-map
400400
runningconfiguration Show current running configuration...
401401
services Show all daemon services
402402
startupconfiguration Show startup configuration information

show/main.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -955,7 +955,7 @@ def link_local_mode(verbose):
955955

956956
@cli.group(cls=clicommon.AliasedGroup)
957957
def lldp():
958-
"""LLDP (Link Layer Discovery Protocol) information"""
958+
"""Show LLDP information"""
959959
pass
960960

961961
# Default 'lldp' command (called if no subcommands or their aliases were passed)

show/processes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
@click.group(cls=clicommon.AliasedGroup)
1010
def processes():
11-
"""Display process information"""
11+
"""Show process information"""
1212
pass
1313

1414

show/system_health.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#
1111
@click.group(name='system-health', cls=clicommon.AliasedGroup)
1212
def system_health():
13-
"""SONiC command line - 'show system-health' command"""
13+
"""Show system-health information"""
1414
return
1515

1616
@system_health.command()

utilities_common/cli.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ def is_port_vlan_member(config_db, port, vlan):
270270
return False
271271

272272
def interface_is_in_vlan(vlan_member_table, interface_name):
273-
""" Check if an interface is in a vlan """
273+
""" Check if an interface is in a vlan """
274274
for _,intf in vlan_member_table:
275275
if intf == interface_name:
276276
return True
@@ -437,12 +437,12 @@ def run_command_in_alias_mode(command):
437437
print_output_in_alias_mode(output, index)
438438

439439
elif (command.startswith("sudo sfputil show eeprom")):
440-
"""show interface transceiver eeprom"""
440+
"""Show interface transceiver eeprom"""
441441
index = 0
442442
print_output_in_alias_mode(raw_output, index)
443443

444444
elif (command.startswith("sudo sfputil show")):
445-
"""show interface transceiver lpmode,
445+
"""Show interface transceiver lpmode,
446446
presence
447447
"""
448448
index = 0
@@ -452,23 +452,23 @@ def run_command_in_alias_mode(command):
452452
print_output_in_alias_mode(output, index)
453453

454454
elif command == "sudo lldpshow":
455-
"""show lldp table"""
455+
"""Show lldp table"""
456456
index = 0
457457
if output.startswith("LocalPort"):
458458
output = output.replace("LocalPort", "LocalPort".rjust(
459459
iface_alias_converter.alias_max_length))
460460
print_output_in_alias_mode(output, index)
461461

462462
elif command.startswith("queuestat"):
463-
"""show queue counters"""
463+
"""Show queue counters"""
464464
index = 0
465465
if output.startswith("Port"):
466466
output = output.replace("Port", "Port".rjust(
467467
iface_alias_converter.alias_max_length))
468468
print_output_in_alias_mode(output, index)
469469

470470
elif command == "fdbshow":
471-
"""show mac"""
471+
"""Show mac"""
472472
index = 3
473473
if output.startswith("No."):
474474
output = " " + output
@@ -479,13 +479,13 @@ def run_command_in_alias_mode(command):
479479
print_output_in_alias_mode(output, index)
480480

481481
elif command.startswith("nbrshow"):
482-
"""show arp"""
482+
"""Show arp"""
483483
index = 2
484484
if "Vlan" in output:
485485
output = output.replace('Vlan', ' Vlan')
486486
print_output_in_alias_mode(output, index)
487487
elif command.startswith("sudo ipintutil"):
488-
"""show ip(v6) int"""
488+
"""Show ip(v6) int"""
489489
index = 0
490490
if output.startswith("Interface"):
491491
output = output.replace("Interface", "Interface".rjust(

0 commit comments

Comments
 (0)