-
Notifications
You must be signed in to change notification settings - Fork 473
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
VITIS-8128 Update help Menu generator for SubCmds #7568
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Daniel Benusovich <dbenusov@xilinx.com>
Signed-off-by: Daniel Benusovich <dbenusov@xilinx.com>
…RT discussion Signed-off-by: Daniel Benusovich <dbenusov@xilinx.com>
Signed-off-by: Daniel Benusovich <dbenusov@xilinx.com>
Signed-off-by: Daniel Benusovich <dbenusov@xilinx.com>
Build failed :( |
Signed-off-by: Daniel Benusovich <dbenusov@xilinx.com>
Build failed :( |
retest this please. |
Build failed :( |
retest this please. |
uday610
approved these changes
May 25, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you
Build failed :( |
retest this please. |
Build Passed! |
chvamshi-xilinx
approved these changes
May 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem solved by the commit
https://jira.xilinx.com/browse/VITIS-8128
The new configuration files are implemented the help menu will need to be formatted differently that reflect the device type being accessed by the user.
This PR focuses on updating SubCmdExamine
Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered
The current help menu displays all options under a single group. As an example the
examine
help menu shows reports:However, certain reports are unique to Alveo and others to AIE devices. Displaying them at all times does not make sense and is confusing.
How problem was solved, alternative solutions (if any) and why they were rejected
This problem was solved by utilizing the new command configuration json that specifies which reports are associated with certain device types. Within the constructor of the chosen command we construct a help menu unique to that device type. Depending on which device the user specifies we change which help menu is displayed to one of the premade help menus.
In addition, if no device is specified ALL reports are displayed. However, the reports are broken into device specific categories.
At the moment, the device type is not available. We are waiting on the shim upgrade before activating that portion of the filter. The current device specific reports will continue to function as they have in the past.
Risks (if any) associated the changes in the commit
This is changing how the help menu appears so some users may be startled by the new menu. However, it is much clearer than the previous iteration and specifies which reports they can run at all.
What has been tested and how, request additional testing if necessary
Ubuntu 20.04 u55c
No device specified result
device specified result
Documentation impact (if any)
None