Skip to content

Commit a29b18a

Browse files
committed
Make samply installation command better
1 parent fa340b4 commit a29b18a

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

src/bootstrap/src/core/build_steps/perf.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ enum PerfCommand {
3030
Eprintln,
3131
/// Run `profile_local samply`
3232
/// This executes the compiler on the given benchmarks and profiles it with `samply`.
33-
/// You need to install `samply`, e.g. using `cargo install samply`.
33+
/// You need to install `samply`, e.g. using `cargo install --locked samply`.
3434
Samply,
3535
/// Run `profile_local cachegrind`.
3636
/// This executes the compiler on the given benchmarks under `Cachegrind`.

src/etc/completions/x.py.fish

+1-1
Original file line numberDiff line numberDiff line change
@@ -667,7 +667,7 @@ complete -c x.py -n "__fish_seen_subcommand_from perf; and not __fish_seen_subco
667667
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'
668668
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\')'
669669
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'
670-
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`'
670+
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`'
671671
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`'
672672
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
673673
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 ''}"

src/etc/completions/x.py.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -813,7 +813,7 @@ Register-ArgumentCompleter -Native -CommandName 'x.py' -ScriptBlock {
813813
[CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help (see more with ''--help'')')
814814
[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help (see more with ''--help'')')
815815
[CompletionResult]::new('eprintln', 'eprintln', [CompletionResultType]::ParameterValue, 'Run `profile_local eprintln`. This executes the compiler on the given benchmarks and stores its stderr output')
816-
[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`')
816+
[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`')
817817
[CompletionResult]::new('cachegrind', 'cachegrind', [CompletionResultType]::ParameterValue, 'Run `profile_local cachegrind`. This executes the compiler on the given benchmarks under `Cachegrind`')
818818
break
819819
}

src/etc/completions/x.py.zsh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1083,7 +1083,7 @@ _x.py__miri_commands() {
10831083
_x.py__perf_commands() {
10841084
local commands; commands=(
10851085
'eprintln:Run \`profile_local eprintln\`. This executes the compiler on the given benchmarks and stores its stderr output' \
1086-
'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\`' \
1086+
'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\`' \
10871087
'cachegrind:Run \`profile_local cachegrind\`. This executes the compiler on the given benchmarks under \`Cachegrind\`' \
10881088
)
10891089
_describe -t commands 'x.py perf commands' commands "$@"

0 commit comments

Comments
 (0)