Documentation update#9874
Open
aktondak wants to merge 3 commits into
Open
Conversation
Contributor
|
clang-tidy review says "All clean, LGTM! 👍" |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Ryzen xrt-smi options were only discoverable from code or --help; there was no short, user-facing summary next to the SMI implementation. This can be incrementally improved to add any additional information we want to put out for user.
Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered
None. This is additive documentation.
How problem was solved, alternative solutions (if any) and why they were rejected
Added README.md under core/common/smi/ with Markdown tables so GitHub renders them
Risks (if any) associated the changes in the commit
None
What has been tested and how, request additional testing if necessary
None
Documentation impact (if any)
None