Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the example for pfcwd start command #1984

Merged
merged 2 commits into from
Jan 5, 2022

Conversation

ZhaohuiS
Copy link
Contributor

@ZhaohuiS ZhaohuiS commented Dec 23, 2021

… it says invalid options. Update it with a correct command

Signed-off-by: Zhaohui Sun [email protected]

What I did

The example of pfcwd start command in start function comments is a little confused, after execution, it says invalid options.
Update it with a correct command.
The output of the current example is:
admin@vlab-01:~$ sudo pfcwd start --action drop ports all detection-time 400 --restoration-time 400
Failed to run command, invalid options:
ports
detection-time

How I did it

Update the example with a correct one in pfcwd start function comments which is also usage info for pfcwd start command.

How to verify it

Enter SONiC DUT, input the following command:
sudo pfcwd start --help
sudo pfcwd start --action drop all 400 --restoration-time 400

Previous command output (if the output of a command-line utility has changed)

admin@vlab-01:~$ sudo pfcwd start --help
Usage: pfcwd start [OPTIONS] [PORTS]... DETECTION_TIME

Start PFC watchdog on port(s). To config all ports, use all as input.

Example:

sudo pfcwd start --action drop ports all detection-time 400 --restoration-
time 400

Options:
-a, --action [drop|forward|alert]
-r, --restoration-time INTEGER RANGE
--help Show this message and exit.

New command output (if the output of a command-line utility has changed)

admin@vlab-01:~$ sudo pfcwd start --help
Usage: pfcwd start [OPTIONS] [PORTS]... DETECTION_TIME

Start PFC watchdog on port(s). To config all ports, use all as input.

Example:

start --action drop all 400 --restoration-time 400

Options:
-a, --action [drop|forward|alert]
-r, --restoration-time INTEGER RANGE
--help Show this message and exit.

… it says invalid options. Update it with a correct command

Signed-off-by: Zhaohui Sun <[email protected]>
@ZhaohuiS ZhaohuiS requested a review from smaheshm December 23, 2021 06:01
@ZhaohuiS ZhaohuiS changed the title example of pfcwd start command is a little confused, after execution,… Update the example for pfcwd start command Dec 23, 2021
@yxieca yxieca requested a review from neethajohn December 27, 2021 17:36
@smaheshm
Copy link
Contributor

smaheshm commented Jan 3, 2022

Looks good. Thanks for making the correction.
Can you also update:
https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md#pfc-watchdog-commands

@ZhaohuiS
Copy link
Contributor Author

ZhaohuiS commented Jan 4, 2022

@smaheshm Thanks for the review. I have updated other related examples for pfcwd start command.

@smaheshm
Copy link
Contributor

smaheshm commented Jan 4, 2022

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@ZhaohuiS ZhaohuiS merged commit 30f5dd6 into sonic-net:master Jan 5, 2022
stepanblyschak pushed a commit to stepanblyschak/sonic-utilities that referenced this pull request Apr 18, 2022
Commits:
f147d9e - 2021-10-27 : [Mux orch] Handle setting unknown mux state (sonic-net#1984) [Prince Sunny]
4618b2b - 2021-10-28 : Change tunnel orch order (sonic-net#1990) [Prince Sunny]
505d52d - 2021-10-20 : Fix the option missing in kernel config issue (sonic-net#1973) [xumia]
7bf4dfb - 2021-10-18 : SAI_REDIS_SWITCH_ATTR_CONTEXT shouldbe the last attribute. This is what sairedis library expects (sonic-net#1935) [judyjoseph]
c58919e - 2021-10-08 : [logfile][202012]: Add option to specify swss rec file name (sonic-net#1946) [judyjoseph]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants