Skip to content

Commit 1aecfcf

Browse files
zdivelbisszdivelbiss
committed
amend documentation style
1 parent 1bf10f2 commit 1aecfcf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+430
-359
lines changed

‎src/cargo/util/command_prelude.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,7 @@ pub trait ArgMatchesExt {
670670
bail!(
671671
"\"--target\" takes a target architecture as an argument.
672672
673-
Run `{cmd}` to see possible targets, or specify `host` for the host architecture."
673+
Run `{cmd}` to see possible targets."
674674
);
675675
}
676676
Ok(self._values_of("target"))

‎src/doc/man/generated_txt/cargo-bench.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -220,30 +220,31 @@ OPTIONS
220220

221221
Compilation Options
222222
--target triple
223-
Benchmark for the specified target (may be specified multiple times)
224-
The default is the host architecture. The general format of the
225-
triple is <arch><sub>-<vendor>-<sys>-<abi>.
223+
Benchmark for the specified target architecture Flag may be
224+
specified multiple times. The default is the host architecture. The
225+
general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
226226

227-
You may specify the following kinds of targets:
227+
Possible values:
228228

229-
o Any supported target in rustc --print target-list (note: you have
230-
to install/add the target to use it).
229+
o Any supported target in rustc --print target-list.
231230

232-
o host, which will internally be substituted by the host’s
231+
o "host", which will internally be substituted by the host’s
233232
target. This can be particularly useful if you’re
234233
cross-compiling some crates, and don’t want to specify your
235234
host’s machine as a target (for instance, an xtask in a shared
236235
project that may be worked on by many hosts).
237236

238-
o A path to a custom target specification (further reading here
239-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
237+
o A path to a custom target specification. See Custom Target Lookup
238+
Path
239+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
240+
for more information.
240241

241242
This may also be specified with the build.target config value
242243
<https://doc.rust-lang.org/cargo/reference/config.html>.
243244

244-
Note: Specifying this flag makes Cargo run in a different mode where
245-
the target artifacts are placed in a separate directory. See the
246-
build cache
245+
Note that specifying this flag makes Cargo run in a different mode
246+
where the target artifacts are placed in a separate directory. See
247+
the build cache
247248
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
248249
documentation for more details.
249250

‎src/doc/man/generated_txt/cargo-build.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -137,30 +137,31 @@ OPTIONS
137137

138138
Compilation Options
139139
--target triple
140-
Build for the specified target (may be specified multiple times) The
141-
default is the host architecture. The general format of the triple
142-
is <arch><sub>-<vendor>-<sys>-<abi>.
140+
Build for the specified target architecture Flag may be specified
141+
multiple times. The default is the host architecture. The general
142+
format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
143143

144-
You may specify the following kinds of targets:
144+
Possible values:
145145

146-
o Any supported target in rustc --print target-list (note: you have
147-
to install/add the target to use it).
146+
o Any supported target in rustc --print target-list.
148147

149-
o host, which will internally be substituted by the host’s
148+
o "host", which will internally be substituted by the host’s
150149
target. This can be particularly useful if you’re
151150
cross-compiling some crates, and don’t want to specify your
152151
host’s machine as a target (for instance, an xtask in a shared
153152
project that may be worked on by many hosts).
154153

155-
o A path to a custom target specification (further reading here
156-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
154+
o A path to a custom target specification. See Custom Target Lookup
155+
Path
156+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
157+
for more information.
157158

158159
This may also be specified with the build.target config value
159160
<https://doc.rust-lang.org/cargo/reference/config.html>.
160161

161-
Note: Specifying this flag makes Cargo run in a different mode where
162-
the target artifacts are placed in a separate directory. See the
163-
build cache
162+
Note that specifying this flag makes Cargo run in a different mode
163+
where the target artifacts are placed in a separate directory. See
164+
the build cache
164165
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
165166
documentation for more details.
166167

‎src/doc/man/generated_txt/cargo-check.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -134,30 +134,31 @@ OPTIONS
134134

135135
Compilation Options
136136
--target triple
137-
Check for the specified target (may be specified multiple times) The
138-
default is the host architecture. The general format of the triple
139-
is <arch><sub>-<vendor>-<sys>-<abi>.
137+
Check for the specified target architecture Flag may be specified
138+
multiple times. The default is the host architecture. The general
139+
format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
140140

141-
You may specify the following kinds of targets:
141+
Possible values:
142142

143-
o Any supported target in rustc --print target-list (note: you have
144-
to install/add the target to use it).
143+
o Any supported target in rustc --print target-list.
145144

146-
o host, which will internally be substituted by the host’s
145+
o "host", which will internally be substituted by the host’s
147146
target. This can be particularly useful if you’re
148147
cross-compiling some crates, and don’t want to specify your
149148
host’s machine as a target (for instance, an xtask in a shared
150149
project that may be worked on by many hosts).
151150

152-
o A path to a custom target specification (further reading here
153-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
151+
o A path to a custom target specification. See Custom Target Lookup
152+
Path
153+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
154+
for more information.
154155

155156
This may also be specified with the build.target config value
156157
<https://doc.rust-lang.org/cargo/reference/config.html>.
157158

158-
Note: Specifying this flag makes Cargo run in a different mode where
159-
the target artifacts are placed in a separate directory. See the
160-
build cache
159+
Note that specifying this flag makes Cargo run in a different mode
160+
where the target artifacts are placed in a separate directory. See
161+
the build cache
161162
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
162163
documentation for more details.
163164

‎src/doc/man/generated_txt/cargo-clean.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,30 +45,31 @@ OPTIONS
4545
target in the root of the workspace.
4646

4747
--target triple
48-
Clean for the specified target (may be specified multiple times) The
49-
default is the host architecture. The general format of the triple
50-
is <arch><sub>-<vendor>-<sys>-<abi>.
48+
Clean for the specified target architecture Flag may be specified
49+
multiple times. The default is the host architecture. The general
50+
format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
5151

52-
You may specify the following kinds of targets:
52+
Possible values:
5353

54-
o Any supported target in rustc --print target-list (note: you have
55-
to install/add the target to use it).
54+
o Any supported target in rustc --print target-list.
5655

57-
o host, which will internally be substituted by the host’s
56+
o "host", which will internally be substituted by the host’s
5857
target. This can be particularly useful if you’re
5958
cross-compiling some crates, and don’t want to specify your
6059
host’s machine as a target (for instance, an xtask in a shared
6160
project that may be worked on by many hosts).
6261

63-
o A path to a custom target specification (further reading here
64-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
62+
o A path to a custom target specification. See Custom Target Lookup
63+
Path
64+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
65+
for more information.
6566

6667
This may also be specified with the build.target config value
6768
<https://doc.rust-lang.org/cargo/reference/config.html>.
6869

69-
Note: Specifying this flag makes Cargo run in a different mode where
70-
the target artifacts are placed in a separate directory. See the
71-
build cache
70+
Note that specifying this flag makes Cargo run in a different mode
71+
where the target artifacts are placed in a separate directory. See
72+
the build cache
7273
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
7374
documentation for more details.
7475

‎src/doc/man/generated_txt/cargo-doc.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -112,30 +112,31 @@ OPTIONS
112112

113113
Compilation Options
114114
--target triple
115-
Document for the specified target (may be specified multiple times)
116-
The default is the host architecture. The general format of the
117-
triple is <arch><sub>-<vendor>-<sys>-<abi>.
115+
Document for the specified target architecture Flag may be specified
116+
multiple times. The default is the host architecture. The general
117+
format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
118118

119-
You may specify the following kinds of targets:
119+
Possible values:
120120

121-
o Any supported target in rustc --print target-list (note: you have
122-
to install/add the target to use it).
121+
o Any supported target in rustc --print target-list.
123122

124-
o host, which will internally be substituted by the host’s
123+
o "host", which will internally be substituted by the host’s
125124
target. This can be particularly useful if you’re
126125
cross-compiling some crates, and don’t want to specify your
127126
host’s machine as a target (for instance, an xtask in a shared
128127
project that may be worked on by many hosts).
129128

130-
o A path to a custom target specification (further reading here
131-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
129+
o A path to a custom target specification. See Custom Target Lookup
130+
Path
131+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
132+
for more information.
132133

133134
This may also be specified with the build.target config value
134135
<https://doc.rust-lang.org/cargo/reference/config.html>.
135136

136-
Note: Specifying this flag makes Cargo run in a different mode where
137-
the target artifacts are placed in a separate directory. See the
138-
build cache
137+
Note that specifying this flag makes Cargo run in a different mode
138+
where the target artifacts are placed in a separate directory. See
139+
the build cache
139140
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
140141
documentation for more details.
141142

‎src/doc/man/generated_txt/cargo-fetch.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,30 +25,31 @@ DESCRIPTION
2525
OPTIONS
2626
Fetch options
2727
--target triple
28-
Fetch for the specified target (may be specified multiple times) The
29-
default is all architectures. The general format of the triple is
30-
<arch><sub>-<vendor>-<sys>-<abi>.
28+
Fetch for the specified target architecture Flag may be specified
29+
multiple times. The default is all architectures. The general format
30+
of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
3131

32-
You may specify the following kinds of targets:
32+
Possible values:
3333

34-
o Any supported target in rustc --print target-list (note: you have
35-
to install/add the target to use it).
34+
o Any supported target in rustc --print target-list.
3635

37-
o host, which will internally be substituted by the host’s
36+
o "host", which will internally be substituted by the host’s
3837
target. This can be particularly useful if you’re
3938
cross-compiling some crates, and don’t want to specify your
4039
host’s machine as a target (for instance, an xtask in a shared
4140
project that may be worked on by many hosts).
4241

43-
o A path to a custom target specification (further reading here
44-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
42+
o A path to a custom target specification. See Custom Target Lookup
43+
Path
44+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
45+
for more information.
4546

4647
This may also be specified with the build.target config value
4748
<https://doc.rust-lang.org/cargo/reference/config.html>.
4849

49-
Note: Specifying this flag makes Cargo run in a different mode where
50-
the target artifacts are placed in a separate directory. See the
51-
build cache
50+
Note that specifying this flag makes Cargo run in a different mode
51+
where the target artifacts are placed in a separate directory. See
52+
the build cache
5253
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
5354
documentation for more details.
5455

‎src/doc/man/generated_txt/cargo-fix.txt‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -208,30 +208,31 @@ OPTIONS
208208

209209
Compilation Options
210210
--target triple
211-
Fix for the specified target (may be specified multiple times) The
212-
default is the host architecture. The general format of the triple
213-
is <arch><sub>-<vendor>-<sys>-<abi>.
211+
Fix for the specified target architecture Flag may be specified
212+
multiple times. The default is the host architecture. The general
213+
format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.
214214

215-
You may specify the following kinds of targets:
215+
Possible values:
216216

217-
o Any supported target in rustc --print target-list (note: you have
218-
to install/add the target to use it).
217+
o Any supported target in rustc --print target-list.
219218

220-
o host, which will internally be substituted by the host’s
219+
o "host", which will internally be substituted by the host’s
221220
target. This can be particularly useful if you’re
222221
cross-compiling some crates, and don’t want to specify your
223222
host’s machine as a target (for instance, an xtask in a shared
224223
project that may be worked on by many hosts).
225224

226-
o A path to a custom target specification (further reading here
227-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
225+
o A path to a custom target specification. See Custom Target Lookup
226+
Path
227+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
228+
for more information.
228229

229230
This may also be specified with the build.target config value
230231
<https://doc.rust-lang.org/cargo/reference/config.html>.
231232

232-
Note: Specifying this flag makes Cargo run in a different mode where
233-
the target artifacts are placed in a separate directory. See the
234-
build cache
233+
Note that specifying this flag makes Cargo run in a different mode
234+
where the target artifacts are placed in a separate directory. See
235+
the build cache
235236
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
236237
documentation for more details.
237238

‎src/doc/man/generated_txt/cargo-install.txt‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -186,30 +186,31 @@ OPTIONS
186186

187187
Compilation Options
188188
--target triple
189-
Install for the specified target The default is the host
190-
architecture. The general format of the triple is
189+
Install for the specified target architecture The default is the
190+
host architecture. The general format of the triple is
191191
<arch><sub>-<vendor>-<sys>-<abi>.
192192

193-
You may specify the following kinds of targets:
193+
Possible values:
194194

195-
o Any supported target in rustc --print target-list (note: you have
196-
to install/add the target to use it).
195+
o Any supported target in rustc --print target-list.
197196

198-
o host, which will internally be substituted by the host’s
197+
o "host", which will internally be substituted by the host’s
199198
target. This can be particularly useful if you’re
200199
cross-compiling some crates, and don’t want to specify your
201200
host’s machine as a target (for instance, an xtask in a shared
202201
project that may be worked on by many hosts).
203202

204-
o A path to a custom target specification (further reading here
205-
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>).
203+
o A path to a custom target specification. See Custom Target Lookup
204+
Path
205+
<https://doc.rust-lang.org/rustc/targets/custom.html#custom-target-lookup-path>
206+
for more information.
206207

207208
This may also be specified with the build.target config value
208209
<https://doc.rust-lang.org/cargo/reference/config.html>.
209210

210-
Note: Specifying this flag makes Cargo run in a different mode where
211-
the target artifacts are placed in a separate directory. See the
212-
build cache
211+
Note that specifying this flag makes Cargo run in a different mode
212+
where the target artifacts are placed in a separate directory. See
213+
the build cache
213214
<https://doc.rust-lang.org/cargo/reference/build-cache.html>
214215
documentation for more details.
215216

0 commit comments

Comments
 (0)