Skip to content

Improve 'samply help' output. #507

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 27, 2025
Merged

Improve 'samply help' output. #507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions samply/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,23 +46,21 @@ use windows::profiler;
name = "samply",
version,
about = r#"
samply is a sampling CPU profiler.
Run a command, record a CPU profile of its execution, and open the profiler UI.
Recording is currently supported on Linux and macOS.
On other platforms, samply can only load existing profiles.
samply is a sampling CPU profiler for Windows, macOS, and Linux.
See "samply record --help" for additional information about the "samply record" command.

EXAMPLES:
# Default usage:
# Profile a freshly launched process:
samply record ./yourcommand yourargs

# On Linux, you can also profile existing processes by pid:
samply record -p 12345 # Linux only
# Profile an existing process by pid:
samply record -p 12345

# Alternative usage: Save profile to file for later viewing, and then load it.
samply record --save-only -o prof.json -- ./yourcommand yourargs
samply load prof.json # Opens in the browser and supplies symbols

# Import perf.data files from Linux perf:
# Import perf.data files from Linux perf or Android simpleperf:
samply import perf.data
"#
)]
Expand Down
Loading