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

CR-1219148 Fix --pmode in xrt-smi configure help menu #8748

Merged
merged 2 commits into from
Feb 6, 2025

Conversation

rchane
Copy link
Collaborator

@rchane rchane commented Feb 5, 2025

Problem solved by the commit

https://jira.xilinx.com/browse/CR-1219148

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

During internal testing, found [--pmode] option in brackets for xrt-smi configure help menu was misleading, as it is a required option.

How problem was solved, alternative solutions (if any) and why they were rejected

Removed the square brackets from formatting string.

Risks (if any) associated the changes in the commit

N/A

What has been tested and how, request additional testing if necessary

Tested on Linux and STX/MCDM, verified that help menus for examine and validate were not broken in the process.

C:\Users\rchane\Desktop\xrt>xrt-smi configure --help

COMMAND: configure

DESCRIPTION: Device and host configuration.

USAGE: xrt-smi configure --pmode [-h] [-d arg]

OPTIONS:
  -d, --device       - The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest
  -h, --help         - Help to use this sub-command
  --pmode            - Modes: default, powersaver, balanced, performance, turbo


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation

Documentation impact (if any)

N/A

Signed-off-by: Ryan Chane <rchane@xilinx.com>
Signed-off-by: Ryan Chane <rchane@xilinx.com>
@stsoe stsoe merged commit d45a880 into Xilinx:master Feb 6, 2025
20 checks passed
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