fork/cargo

git clone https://git.julia.blue/fork/cargo

Weihang Lofeat: vcs, color, and message format native completion (#15322)8364f7b68

0.88.0
11.1 KiB150 linesraw
1<svg width="827px" height="1154px" xmlns="http://www.w3.org/2000/svg">
2  <style>
3    .fg { fill: #AAAAAA }
4    .bg { background: #000000 }
5    .fg-cyan { fill: #00AAAA }
6    .fg-green { fill: #00AA00 }
7    .container {
8      padding: 0 10px;
9      line-height: 18px;
10    }
11    .bold { font-weight: bold; }
12    tspan {
13      font: 14px SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace;
14      white-space: pre;
15      line-height: 18px;
16    }
17  </style>
18
19  <rect width="100%" height="100%" y="0" rx="4.5" class="bg" />
20
21  <text xml:space="preserve" class="container fg">
22    <tspan x="10px" y="28px"><tspan>Execute all benchmarks of a local package</tspan>
23</tspan>
24    <tspan x="10px" y="46px">
25</tspan>
26    <tspan x="10px" y="64px"><tspan class="fg-green bold">Usage:</tspan><tspan> </tspan><tspan class="fg-cyan bold">cargo[EXE] bench</tspan><tspan> </tspan><tspan class="fg-cyan">[OPTIONS]</tspan><tspan> </tspan><tspan class="fg-cyan">[BENCHNAME]</tspan><tspan> </tspan><tspan class="fg-cyan bold">[--</tspan><tspan> </tspan><tspan class="fg-cyan">[ARGS]...</tspan><tspan class="fg-cyan bold">]</tspan>
27</tspan>
28    <tspan x="10px" y="82px">
29</tspan>
30    <tspan x="10px" y="100px"><tspan class="fg-green bold">Arguments:</tspan>
31</tspan>
32    <tspan x="10px" y="118px"><tspan>  </tspan><tspan class="fg-cyan">[BENCHNAME]</tspan><tspan>  If specified, only run benches containing this string in their names</tspan>
33</tspan>
34    <tspan x="10px" y="136px"><tspan>  </tspan><tspan class="fg-cyan">[ARGS]...</tspan><tspan>    Arguments for the bench binary</tspan>
35</tspan>
36    <tspan x="10px" y="154px">
37</tspan>
38    <tspan x="10px" y="172px"><tspan class="fg-green bold">Options:</tspan>
39</tspan>
40    <tspan x="10px" y="190px"><tspan>      </tspan><tspan class="fg-cyan bold">--no-run</tspan><tspan>                   Compile, but don't run benchmarks</tspan>
41</tspan>
42    <tspan x="10px" y="208px"><tspan>      </tspan><tspan class="fg-cyan bold">--no-fail-fast</tspan><tspan>             Run all benchmarks regardless of failure</tspan>
43</tspan>
44    <tspan x="10px" y="226px"><tspan>      </tspan><tspan class="fg-cyan bold">--message-format</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;FMT&gt;</tspan><tspan>     Error format [possible values: human, short, json,</tspan>
45</tspan>
46    <tspan x="10px" y="244px"><tspan>                                 json-diagnostic-short, json-diagnostic-rendered-ansi,</tspan>
47</tspan>
48    <tspan x="10px" y="262px"><tspan>                                 json-render-diagnostics]</tspan>
49</tspan>
50    <tspan x="10px" y="280px"><tspan>  </tspan><tspan class="fg-cyan bold">-v</tspan><tspan>, </tspan><tspan class="fg-cyan bold">--verbose</tspan><tspan class="fg-cyan">...</tspan><tspan>               Use verbose output (-vv very verbose/build.rs output)</tspan>
51</tspan>
52    <tspan x="10px" y="298px"><tspan>  </tspan><tspan class="fg-cyan bold">-q</tspan><tspan>, </tspan><tspan class="fg-cyan bold">--quiet</tspan><tspan>                    Do not print cargo log messages</tspan>
53</tspan>
54    <tspan x="10px" y="316px"><tspan>      </tspan><tspan class="fg-cyan bold">--color</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;WHEN&gt;</tspan><tspan>             Coloring [possible values: auto, always, never]</tspan>
55</tspan>
56    <tspan x="10px" y="334px"><tspan>      </tspan><tspan class="fg-cyan bold">--config</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;KEY=VALUE|PATH&gt;</tspan><tspan>  Override a configuration value</tspan>
57</tspan>
58    <tspan x="10px" y="352px"><tspan>  </tspan><tspan class="fg-cyan bold">-Z</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;FLAG&gt;</tspan><tspan>                      Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for</tspan>
59</tspan>
60    <tspan x="10px" y="370px"><tspan>                                 details</tspan>
61</tspan>
62    <tspan x="10px" y="388px"><tspan>  </tspan><tspan class="fg-cyan bold">-h</tspan><tspan>, </tspan><tspan class="fg-cyan bold">--help</tspan><tspan>                     Print help</tspan>
63</tspan>
64    <tspan x="10px" y="406px">
65</tspan>
66    <tspan x="10px" y="424px"><tspan class="fg-green bold">Package Selection:</tspan>
67</tspan>
68    <tspan x="10px" y="442px"><tspan>  </tspan><tspan class="fg-cyan bold">-p</tspan><tspan>, </tspan><tspan class="fg-cyan bold">--package</tspan><tspan class="fg-cyan"> [</tspan><tspan class="fg-cyan">&lt;SPEC&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>  Package to run benchmarks for</tspan>
69</tspan>
70    <tspan x="10px" y="460px"><tspan>      </tspan><tspan class="fg-cyan bold">--workspace</tspan><tspan>         Benchmark all packages in the workspace</tspan>
71</tspan>
72    <tspan x="10px" y="478px"><tspan>      </tspan><tspan class="fg-cyan bold">--exclude</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;SPEC&gt;</tspan><tspan>    Exclude packages from the benchmark</tspan>
73</tspan>
74    <tspan x="10px" y="496px"><tspan>      </tspan><tspan class="fg-cyan bold">--all</tspan><tspan>               Alias for --workspace (deprecated)</tspan>
75</tspan>
76    <tspan x="10px" y="514px">
77</tspan>
78    <tspan x="10px" y="532px"><tspan class="fg-green bold">Target Selection:</tspan>
79</tspan>
80    <tspan x="10px" y="550px"><tspan>      </tspan><tspan class="fg-cyan bold">--lib</tspan><tspan>               Benchmark only this package's library</tspan>
81</tspan>
82    <tspan x="10px" y="568px"><tspan>      </tspan><tspan class="fg-cyan bold">--bins</tspan><tspan>              Benchmark all binaries</tspan>
83</tspan>
84    <tspan x="10px" y="586px"><tspan>      </tspan><tspan class="fg-cyan bold">--bin</tspan><tspan class="fg-cyan"> [</tspan><tspan class="fg-cyan">&lt;NAME&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>      Benchmark only the specified binary</tspan>
85</tspan>
86    <tspan x="10px" y="604px"><tspan>      </tspan><tspan class="fg-cyan bold">--examples</tspan><tspan>          Benchmark all examples</tspan>
87</tspan>
88    <tspan x="10px" y="622px"><tspan>      </tspan><tspan class="fg-cyan bold">--example</tspan><tspan class="fg-cyan"> [</tspan><tspan class="fg-cyan">&lt;NAME&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>  Benchmark only the specified example</tspan>
89</tspan>
90    <tspan x="10px" y="640px"><tspan>      </tspan><tspan class="fg-cyan bold">--tests</tspan><tspan>             Benchmark all targets that have `test = true` set</tspan>
91</tspan>
92    <tspan x="10px" y="658px"><tspan>      </tspan><tspan class="fg-cyan bold">--test</tspan><tspan class="fg-cyan"> [</tspan><tspan class="fg-cyan">&lt;NAME&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>     Benchmark only the specified test target</tspan>
93</tspan>
94    <tspan x="10px" y="676px"><tspan>      </tspan><tspan class="fg-cyan bold">--benches</tspan><tspan>           Benchmark all targets that have `bench = true` set</tspan>
95</tspan>
96    <tspan x="10px" y="694px"><tspan>      </tspan><tspan class="fg-cyan bold">--bench</tspan><tspan class="fg-cyan"> [</tspan><tspan class="fg-cyan">&lt;NAME&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>    Benchmark only the specified bench target</tspan>
97</tspan>
98    <tspan x="10px" y="712px"><tspan>      </tspan><tspan class="fg-cyan bold">--all-targets</tspan><tspan>       Benchmark all targets</tspan>
99</tspan>
100    <tspan x="10px" y="730px">
101</tspan>
102    <tspan x="10px" y="748px"><tspan class="fg-green bold">Feature Selection:</tspan>
103</tspan>
104    <tspan x="10px" y="766px"><tspan>  </tspan><tspan class="fg-cyan bold">-F</tspan><tspan>, </tspan><tspan class="fg-cyan bold">--features</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;FEATURES&gt;</tspan><tspan>  Space or comma separated list of features to activate</tspan>
105</tspan>
106    <tspan x="10px" y="784px"><tspan>      </tspan><tspan class="fg-cyan bold">--all-features</tspan><tspan>         Activate all available features</tspan>
107</tspan>
108    <tspan x="10px" y="802px"><tspan>      </tspan><tspan class="fg-cyan bold">--no-default-features</tspan><tspan>  Do not activate the `default` feature</tspan>
109</tspan>
110    <tspan x="10px" y="820px">
111</tspan>
112    <tspan x="10px" y="838px"><tspan class="fg-green bold">Compilation Options:</tspan>
113</tspan>
114    <tspan x="10px" y="856px"><tspan>  </tspan><tspan class="fg-cyan bold">-j</tspan><tspan>, </tspan><tspan class="fg-cyan bold">--jobs</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;N&gt;</tspan><tspan>                Number of parallel jobs, defaults to # of CPUs.</tspan>
115</tspan>
116    <tspan x="10px" y="874px"><tspan>      </tspan><tspan class="fg-cyan bold">--profile</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;PROFILE-NAME&gt;</tspan><tspan>  Build artifacts with the specified profile</tspan>
117</tspan>
118    <tspan x="10px" y="892px"><tspan>      </tspan><tspan class="fg-cyan bold">--target</tspan><tspan class="fg-cyan"> [</tspan><tspan class="fg-cyan">&lt;TRIPLE&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>       Build for the target triple</tspan>
119</tspan>
120    <tspan x="10px" y="910px"><tspan>      </tspan><tspan class="fg-cyan bold">--target-dir</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;DIRECTORY&gt;</tspan><tspan>  Directory for all generated artifacts</tspan>
121</tspan>
122    <tspan x="10px" y="928px"><tspan>      </tspan><tspan class="fg-cyan bold">--unit-graph</tspan><tspan>              Output build graph in JSON (unstable)</tspan>
123</tspan>
124    <tspan x="10px" y="946px"><tspan>      </tspan><tspan class="fg-cyan bold">--timings</tspan><tspan class="fg-cyan">[=</tspan><tspan class="fg-cyan">&lt;FMTS&gt;</tspan><tspan class="fg-cyan">]</tspan><tspan>        Timing output formats (unstable) (comma separated): html, json</tspan>
125</tspan>
126    <tspan x="10px" y="964px">
127</tspan>
128    <tspan x="10px" y="982px"><tspan class="fg-green bold">Manifest Options:</tspan>
129</tspan>
130    <tspan x="10px" y="1000px"><tspan>      </tspan><tspan class="fg-cyan bold">--manifest-path</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;PATH&gt;</tspan><tspan>  Path to Cargo.toml</tspan>
131</tspan>
132    <tspan x="10px" y="1018px"><tspan>      </tspan><tspan class="fg-cyan bold">--lockfile-path</tspan><tspan class="fg-cyan"> </tspan><tspan class="fg-cyan">&lt;PATH&gt;</tspan><tspan>  Path to Cargo.lock (unstable)</tspan>
133</tspan>
134    <tspan x="10px" y="1036px"><tspan>      </tspan><tspan class="fg-cyan bold">--ignore-rust-version</tspan><tspan>   Ignore `rust-version` specification in packages</tspan>
135</tspan>
136    <tspan x="10px" y="1054px"><tspan>      </tspan><tspan class="fg-cyan bold">--locked</tspan><tspan>                Assert that `Cargo.lock` will remain unchanged</tspan>
137</tspan>
138    <tspan x="10px" y="1072px"><tspan>      </tspan><tspan class="fg-cyan bold">--offline</tspan><tspan>               Run without accessing the network</tspan>
139</tspan>
140    <tspan x="10px" y="1090px"><tspan>      </tspan><tspan class="fg-cyan bold">--frozen</tspan><tspan>                Equivalent to specifying both --locked and --offline</tspan>
141</tspan>
142    <tspan x="10px" y="1108px">
143</tspan>
144    <tspan x="10px" y="1126px"><tspan>Run `</tspan><tspan class="fg-cyan bold">cargo help bench</tspan><tspan class="bold">` for more detailed information.</tspan>
145</tspan>
146    <tspan x="10px" y="1144px">
147</tspan>
148  </text>
149
150</svg>