servoshell: Update the debug options (-Z) help to reflect current set of options
#39316
Conversation
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
servo-highfive
added
the
S-awaiting-review
mukilan
reviewed
Sep 15, 2025
mukilan
removed
the
S-awaiting-review
Narfinger
force-pushed
the
debug-help
branch
from
0f54ded to
aa8f712
Compare
servo-highfive
added
the
S-awaiting-review
mukilan
approved these changes
Sep 16, 2025
components/config/opts.rs
Outdated
| //! from command line arguments. | ||
| use std::default::Default; | ||
| use std::fmt::Debug; |
There was a problem hiding this comment.
This doesn't seem to be used anywhere. Is this needed?
servo-highfive
removed
the
S-awaiting-review
mrobinson
requested changes
Sep 16, 2025
components/config/opts.rs
Outdated
Comment on lines
179
to
237
| pub fn print_help(app: &str) { | ||
| fn print_option(name: &str, description: &str) { | ||
| println!("\t{:<35} {}", name, description); | ||
| } | ||
| println!( | ||
| "Usage: {} debug option,[options,...]\n\twhere options include\n\nOptions:", | ||
| app | ||
| ); | ||
| print_option( | ||
| "convert-mouse-to-touch", | ||
| "Send touch events instead of mouse events", | ||
| ); | ||
| print_option( | ||
| "disable-share-style-cache", | ||
| "Disable the style sharing cache.", | ||
| ); | ||
| print_option( | ||
| "dump-display-list", | ||
| "Print the display list after each layout.", | ||
| ); | ||
| print_option( | ||
| "dump-stacking-context-tree", | ||
| "Print the stacking context tree after each layout.", | ||
| ); | ||
| print_option( | ||
| "dump-flow-tree", | ||
| "Print the fragment tree after each layout.", | ||
| ); | ||
| print_option( | ||
| "dump-rule-tree", | ||
| "Print the style rule tree after each layout.", | ||
| ); | ||
| print_option( | ||
| "dump-style-tree", | ||
| "Print the DOM with computed styles after each restyle.", | ||
| ); | ||
| print_option("dump-style-stats", "Print style stats after each restyle."); | ||
| print_option("dump-scroll-tree", "Print scroll tree after each layout."); | ||
| print_option("gc-profile", "Log GC passes and their durations."); | ||
| print_option( | ||
| "profile-script-events", | ||
| "Enable profiling of script-related events.", | ||
| ); | ||
| print_option( | ||
| "relayout-event", | ||
| "Print notifications when there is a relayout.", | ||
| ); | ||
| print_option( | ||
| "signpost", | ||
| "Emit native OS signposts for profile events (currently macOS only)", | ||
| ); | ||
| print_option( | ||
| "trace-layout", | ||
| "Write layout trace to an external file for debugging.", | ||
| ); | ||
| print_option("wr-stats", "Show WebRender profiler on screen."); | ||
|
|
||
| println!(); | ||
| } |
There was a problem hiding this comment.
This was moved to servoshell as Opts doesn't handle command-line arguments and thus shouldn't be responsible for dumping help output for them. I think it makes sense to keep this in servoshell.
There was a problem hiding this comment.
I think the problem is that it will always be out of sync if it is not close. I think if we really want to keep it in servo she'll, I can at least add a comment to the DebugOptions struct.
There was a problem hiding this comment.
They shouldn't be out of sync for long, as I have plans to integrate these options into the Servo API via a ServoLoggingSettings struct that will have parsing capability as well. Once that happens this code will likely go away. For the moment, I think it's better to keep all of the command-line parsing and help code together though.
@Narfinger I'm happy to do this as you are on vacation now.
There was a problem hiding this comment.
Ok that makes sense.
Feel free to do it.
servo-highfive
added
the
S-needs-code-changes
servo-highfive
added
S-needs-rebase
mrobinson
changed the title
-Z) help to reflect current set of options
mrobinson
force-pushed
the
debug-help
branch
from
8b23ca5 to
52cad52
Compare
servo-highfive
added
S-needs-rebase
mrobinson
approved these changes
Sep 17, 2025
servo-highfive
removed
the
S-awaiting-review
Signed-off-by: Narfinger <Narfinger@users.noreply.github.com>
mrobinson
force-pushed
the
debug-help
branch
from
52cad52 to
d3ca7c3
Compare
servo-highfive
added
S-awaiting-review
servo-highfive
added
the
S-awaiting-merge
servo-highfive
removed
the
S-awaiting-merge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
The command-line help output for
-Zand `DebugOptions were out of sync again. This change makes sure they match again.Testing: No tests necessary as this mainly just updates the help output.
Fixes: #39311