XRT icon indicating copy to clipboard operation
XRT copied to clipboard

Various Cleanup of xbutil with xrt-smi, Help Menu Fix

Open rchane opened this issue 1 year ago • 2 comments

Problem solved by the commit

There were some mentions of xbutil in xrt-smi still, including in the help menu program description. In addition, xrt-smi and xrt-smi --help were throwing errors after printing the help menu.

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

Discovered while testing

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

The aforementioned commands now only print the help menu without the error. Mentions of xbutil in output and some comments/scripts were replaced with xrt-smi, including xball script and nagios_plugin.sh.

Risks (if any) associated the changes in the commit

N/A

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

Tested on STX\MCDM.

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

DESCRIPTION: The Xilinx (R) Run Time - System Management Interface (xrt-smi) is a standalone
             command line utility that is included with the Xilinx Run Time (XRT) installation
             package. It includes multiple commands to identify and validate the installed card(s).

              This information can be used for both card administration and application debugging.

USAGE: xrt-smi[--help] [--version] [--verbose] [--batch] [--force] [command [commandArgs]]

AVAILABLE COMMANDS:
  configure  - Device and host configuration
  examine    - Status of the system and device
  validate   - Validates the basic shell acceleration functionality

OPTIONS:
  --help             - Help to use this application
  --version          - Report the version of XRT and its drivers
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation

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

DESCRIPTION: The Xilinx (R) Run Time - System Management Interface (xrt-smi) is a standalone
             command line utility that is included with the Xilinx Run Time (XRT) installation
             package. It includes multiple commands to identify and validate the installed card(s).

              This information can be used for both card administration and application debugging.

USAGE: xrt-smi[--help] [--version] [--verbose] [--batch] [--force] [command [commandArgs]]

AVAILABLE COMMANDS:
  configure  - Device and host configuration
  examine    - Status of the system and device
  validate   - Validates the basic shell acceleration functionality

OPTIONS:
  --help             - Help to use this application
  --version          - Report the version of XRT and its drivers
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation

C:\Users\rchane\Desktop\xrt>xrt-smi blah
ERROR: Unknown command: 'blah'

DESCRIPTION: The Xilinx (R) Run Time - System Management Interface (xrt-smi) is a standalone
             command line utility that is included with the Xilinx Run Time (XRT) installation
             package. It includes multiple commands to identify and validate the installed card(s).

              This information can be used for both card administration and application debugging.

USAGE: xrt-smi[--help] [--version] [--verbose] [--batch] [--force] [command [commandArgs]]

AVAILABLE COMMANDS:
  configure  - Device and host configuration
  examine    - Status of the system and device
  validate   - Validates the basic shell acceleration functionality

OPTIONS:
  --help             - Help to use this application
  --version          - Report the version of XRT and its drivers
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation
ERROR: operation canceled

Documentation impact (if any)

N/A

rchane avatar Jul 03 '24 17:07 rchane