scx_bpfland, scx_lavd: Improve help info a bit #543
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
A lot of scx_lavd's options do not clearly explain what they do. Add some short explanations, clean up the existing ones, and direct the user to read the in-code documentation for more info.
arighi
approved these changes
Aug 23, 2024
htejun
approved these changes
Aug 24, 2024
htejun
added a commit
that referenced
this pull request
Aug 24, 2024
scx_lavd: Fix my own formatting error in #543 scx_rusty: help info and README cleanup
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.
I wanted to do some work improving the end-user documentation, as I noticed some random typos and other things that were worded a little unclearly or just not explained at all.
I made some minor grammatical changes to scx_bpfland, and I added explanations to scx_lavd that were poorly explained or missing entirely; for example, that the power mode options control the defaults for the four scheduling controls wasn't explained anywhere, and I only learned that by paging through the Rust code, or using the correct terminology "SMT sibling" rather than "logical core."
In a perfect world, the documentation for every scheduler should be formatted exactly the same, and the information useful to end users shouldn't just be embedded in the source code. While an experienced sysadmin might not mind, it is a barrier of entry for, say, a gamer who is interested in tuning scx to their needs and has installed prebuilt schedulers from their distro's repos (I think only CachyOS packages them right now, but that will likely change in the future.) This is just a small start.
I'll probably do some more work when I have the time.