Skip to content

Commit

Permalink
Make samply installation command better
Browse files Browse the repository at this point in the history
  • Loading branch information
Kobzol committed Jun 26, 2024
1 parent fa340b4 commit a29b18a
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/bootstrap/src/core/build_steps/perf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ enum PerfCommand {
Eprintln,
/// Run `profile_local samply`
/// This executes the compiler on the given benchmarks and profiles it with `samply`.
/// You need to install `samply`, e.g. using `cargo install samply`.
/// You need to install `samply`, e.g. using `cargo install --locked samply`.
Samply,
/// Run `profile_local cachegrind`.
/// This executes the compiler on the given benchmarks under `Cachegrind`.
Expand Down
2 changes: 1 addition & 1 deletion src/etc/completions/x.py.fish
Original file line number Diff line number Diff line change
Expand Up @@ -667,7 +667,7 @@ complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subco
complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subcommand_from eprintln; and not __fish_seen_subcommand_from samply; and not __fish_seen_subcommand_from cachegrind" -l skip-stage0-validation -d 'Skip stage0 compiler validation'
complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subcommand_from eprintln; and not __fish_seen_subcommand_from samply; and not __fish_seen_subcommand_from cachegrind" -s h -l help -d 'Print help (see more with \'--help\')'
complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subcommand_from eprintln; and not __fish_seen_subcommand_from samply; and not __fish_seen_subcommand_from cachegrind" -f -a "eprintln" -d 'Run `profile_local eprintln`. This executes the compiler on the given benchmarks and stores its stderr output'
complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subcommand_from eprintln; and not __fish_seen_subcommand_from samply; and not __fish_seen_subcommand_from cachegrind" -f -a "samply" -d 'Run `profile_local samply` This executes the compiler on the given benchmarks and profiles it with `samply`. You need to install `samply`, e.g. using `cargo install samply`'
complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subcommand_from eprintln; and not __fish_seen_subcommand_from samply; and not __fish_seen_subcommand_from cachegrind" -f -a "samply" -d 'Run `profile_local samply` This executes the compiler on the given benchmarks and profiles it with `samply`. You need to install `samply`, e.g. using `cargo install --locked samply`'
complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subcommand_from eprintln; and not __fish_seen_subcommand_from samply; and not __fish_seen_subcommand_from cachegrind" -f -a "cachegrind" -d 'Run `profile_local cachegrind`. This executes the compiler on the given benchmarks under `Cachegrind`'
complete -c x.py -n "__fish_seen_subcommand_from perf; and __fish_seen_subcommand_from eprintln" -l include -d 'Select the benchmarks that you want to run (separated by commas). If unspecified, all benchmarks will be executed' -r
complete -c x.py -n "__fish_seen_subcommand_from perf; and __fish_seen_subcommand_from eprintln" -l scenarios -d 'Select the scenarios that should be benchmarked' -r -f -a "{Full '',IncrFull '',IncrUnchanged '',IncrPatched ''}"
Expand Down
2 changes: 1 addition & 1 deletion src/etc/completions/x.py.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -813,7 +813,7 @@ Register-ArgumentCompleter -Native -CommandName 'x.py' -ScriptBlock {
[CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help (see more with ''--help'')')
[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help (see more with ''--help'')')
[CompletionResult]::new('eprintln', 'eprintln', [CompletionResultType]::ParameterValue, 'Run `profile_local eprintln`. This executes the compiler on the given benchmarks and stores its stderr output')
[CompletionResult]::new('samply', 'samply', [CompletionResultType]::ParameterValue, 'Run `profile_local samply` This executes the compiler on the given benchmarks and profiles it with `samply`. You need to install `samply`, e.g. using `cargo install samply`')
[CompletionResult]::new('samply', 'samply', [CompletionResultType]::ParameterValue, 'Run `profile_local samply` This executes the compiler on the given benchmarks and profiles it with `samply`. You need to install `samply`, e.g. using `cargo install --locked samply`')
[CompletionResult]::new('cachegrind', 'cachegrind', [CompletionResultType]::ParameterValue, 'Run `profile_local cachegrind`. This executes the compiler on the given benchmarks under `Cachegrind`')
break
}
Expand Down
2 changes: 1 addition & 1 deletion src/etc/completions/x.py.zsh
Original file line number Diff line number Diff line change
Expand Up @@ -1083,7 +1083,7 @@ _x.py__miri_commands() {
_x.py__perf_commands() {
local commands; commands=(
'eprintln:Run \`profile_local eprintln\`. This executes the compiler on the given benchmarks and stores its stderr output' \
'samply:Run \`profile_local samply\` This executes the compiler on the given benchmarks and profiles it with \`samply\`. You need to install \`samply\`, e.g. using \`cargo install samply\`' \
'samply:Run \`profile_local samply\` This executes the compiler on the given benchmarks and profiles it with \`samply\`. You need to install \`samply\`, e.g. using \`cargo install --locked samply\`' \
'cachegrind:Run \`profile_local cachegrind\`. This executes the compiler on the given benchmarks under \`Cachegrind\`' \
)
_describe -t commands 'x.py perf commands' commands "$@"
Expand Down

0 comments on commit a29b18a

Please sign in to comment.