docs: CPU Profile generation#121
Open
olivereanderson wants to merge 1 commit intocyberus-technology:gardenlinuxfrom
Open
docs: CPU Profile generation#121olivereanderson wants to merge 1 commit intocyberus-technology:gardenlinuxfrom
olivereanderson wants to merge 1 commit intocyberus-technology:gardenlinuxfrom
Conversation
We add developer documentation on how to use the CPU profile generation tool. We also include a short outlook section with ideas for what we want to improve in the near future. Signed-off-by: Oliver Anderson <oliver.anderson@cyberus-technology.de> On-behalf-of: SAP oliver.anderson@sap.com
phip1611
reviewed
Mar 23, 2026
|
|
||
| check them in to git and then extend the `arch::x86_64::CpuProfile` enum with a new variant for your freshly generated profile. | ||
|
|
||
| The final step is then to adapt `arch::x86_64::CpuProfile::cpuid_data` and `arch::x86_64::CpuProfile::msr_data` mutatis mutandis |
Member
There was a problem hiding this comment.
Maybe it is just me but I had to google the meaning of mutatis mutandis
Author
There was a problem hiding this comment.
I will try to find a simpler formulation. As always there is no need to be unnecessarily fancy. I just don't know of any other concise way to say exactly that, but it doesn't hurt to spend a few more words here anyway 🙂
phip1611
reviewed
Mar 23, 2026
| Such PRs will **not be accepted**. Instead we encourage you add a `V2` (or higher number if `V<i>` already exists) suffix | ||
| when generating the profile. | ||
|
|
||
| ## Outlook |
Member
There was a problem hiding this comment.
I see your idea and the writeup is valuabe! I think however this belongs to an issue. Outlook section may link to an issue, tho.
phip1611
approved these changes
Mar 23, 2026
Member
phip1611
left a comment
phip1611
left a comment
There was a problem hiding this comment.
LGTM, thanks! I think the outlook section should be an issue instead.
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
2 participants
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.
Add developer documentation on how to use the CPU profile generation tool.
Open questions
Would it perhaps be better to open one or more issues instead of having an outlook section here?