Skip to content

Commit f2cfd67

Browse files
heisen-liheisen-li
committed
fix doc
1 parent 65c8eb3 commit f2cfd67

18 files changed

+168
-14
lines changed

‎src/doc/man/cargo-doc.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,17 @@ the manifest settings. Using target selection options will ignore the `doc`
5151
flag and will always document the given target.
5252

5353
{{#options}}
54-
{{> options-targets-lib-bin-example }}
54+
{{> options-targets-lib-bin }}
55+
56+
{{#option "`--example` _name_..." }}
57+
{{actionverb}} the specified example. This flag may be specified multiple times
58+
and supports common Unix glob patterns.
59+
{{/option}}
60+
61+
{{#option "`--examples`" }}
62+
{{actionverb}} all example targets.
63+
{{/option}}
64+
5565
{{/options}}
5666

5767
{{> section-features }}

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,16 @@ OPTIONS
118118
accidentally expanding glob patterns before Cargo handles them, you must
119119
use single quotes or double quotes around each glob pattern.
120120

121+
--lib
122+
Benchmark the package's library.
123+
124+
--bin name...
125+
Benchmark the specified binary. This flag may be specified multiple
126+
times and supports common Unix glob patterns.
127+
128+
--bins
129+
Benchmark all binary targets.
130+
121131
--example name...
122132
Benchmark the specified example. This flag may be specified multiple
123133
times and supports common Unix glob patterns.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,16 @@ OPTIONS
5858
accidentally expanding glob patterns before Cargo handles them, you must
5959
use single quotes or double quotes around each glob pattern.
6060

61+
--lib
62+
Build the package's library.
63+
64+
--bin name...
65+
Build the specified binary. This flag may be specified multiple
66+
times and supports common Unix glob patterns.
67+
68+
--bins
69+
Build all binary targets.
70+
6171
--example name...
6272
Build the specified example. This flag may be specified multiple
6373
times and supports common Unix glob patterns.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@ OPTIONS
6464
accidentally expanding glob patterns before Cargo handles them, you must
6565
use single quotes or double quotes around each glob pattern.
6666

67+
--lib
68+
Check the package's library.
69+
70+
--bin name...
71+
Check the specified binary. This flag may be specified multiple
72+
times and supports common Unix glob patterns.
73+
74+
--bins
75+
Check all binary targets.
76+
6777
--example name...
6878
Check the specified example. This flag may be specified multiple
6979
times and supports common Unix glob patterns.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ OPTIONS
8787
times and supports common Unix glob patterns.
8888

8989
--examples
90-
Document all examples targets.
90+
Document all example targets.
9191

9292
Feature Selection
9393
The feature flags allow you to control which features are enabled. When

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,16 @@ OPTIONS
137137
accidentally expanding glob patterns before Cargo handles them, you must
138138
use single quotes or double quotes around each glob pattern.
139139

140+
--lib
141+
Fix the package's library.
142+
143+
--bin name...
144+
Fix the specified binary. This flag may be specified multiple times
145+
and supports common Unix glob patterns.
146+
147+
--bins
148+
Fix all binary targets.
149+
140150
--example name...
141151
Fix the specified example. This flag may be specified multiple times
142152
and supports common Unix glob patterns.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,16 @@ OPTIONS
4949
accidentally expanding glob patterns before Cargo handles them, you must
5050
use single quotes or double quotes around each glob pattern.
5151

52+
--lib
53+
Build the package's library.
54+
55+
--bin name...
56+
Build the specified binary. This flag may be specified multiple
57+
times and supports common Unix glob patterns.
58+
59+
--bins
60+
Build all binary targets.
61+
5262
--example name...
5363
Build the specified example. This flag may be specified multiple
5464
times and supports common Unix glob patterns.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,16 @@ OPTIONS
5858
accidentally expanding glob patterns before Cargo handles them, you must
5959
use single quotes or double quotes around each glob pattern.
6060

61+
--lib
62+
Document the package's library.
63+
64+
--bin name...
65+
Document the specified binary. This flag may be specified multiple
66+
times and supports common Unix glob patterns.
67+
68+
--bins
69+
Document all binary targets.
70+
6171
--example name...
6272
Document the specified example. This flag may be specified multiple
6373
times and supports common Unix glob patterns.

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,16 @@ OPTIONS
131131
accidentally expanding glob patterns before Cargo handles them, you must
132132
use single quotes or double quotes around each glob pattern.
133133

134+
--lib
135+
Test the package's library.
136+
137+
--bin name...
138+
Test the specified binary. This flag may be specified multiple times
139+
and supports common Unix glob patterns.
140+
141+
--bins
142+
Test all binary targets.
143+
134144
--example name...
135145
Test the specified example. This flag may be specified multiple
136146
times and supports common Unix glob patterns.

‎src/doc/man/includes/options-targets-lib-bin-example.md renamed to ‎src/doc/man/includes/options-targets-lib-bin.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,3 @@ and supports common Unix glob patterns.
1010
{{#option "`--bins`" }}
1111
{{actionverb}} all binary targets.
1212
{{/option}}
13-
14-
{{#option "`--example` _name_..." }}
15-
{{actionverb}} the specified example. This flag may be specified multiple times
16-
and supports common Unix glob patterns.
17-
{{/option}}
18-
19-
{{#option "`--examples`" }}
20-
{{actionverb}} all examples targets.
21-
{{/option}}
22-

‎src/doc/src/commands/cargo-bench.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,18 @@ use single quotes or double quotes around each glob pattern.
140140

141141
<dl>
142142

143+
<dt class="option-term" id="option-cargo-bench---lib"><a class="option-anchor" href="#option-cargo-bench---lib"></a><code>--lib</code></dt>
144+
<dd class="option-desc">Benchmark the package's library.</dd>
145+
146+
147+
<dt class="option-term" id="option-cargo-bench---bin"><a class="option-anchor" href="#option-cargo-bench---bin"></a><code>--bin</code> <em>name</em>...</dt>
148+
<dd class="option-desc">Benchmark the specified binary. This flag may be specified multiple times
149+
and supports common Unix glob patterns.</dd>
150+
151+
152+
<dt class="option-term" id="option-cargo-bench---bins"><a class="option-anchor" href="#option-cargo-bench---bins"></a><code>--bins</code></dt>
153+
<dd class="option-desc">Benchmark all binary targets.</dd>
154+
143155

144156

145157
<dt class="option-term" id="option-cargo-bench---example"><a class="option-anchor" href="#option-cargo-bench---example"></a><code>--example</code> <em>name</em>...</dt>

‎src/doc/src/commands/cargo-build.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,18 @@ use single quotes or double quotes around each glob pattern.
7676

7777
<dl>
7878

79+
<dt class="option-term" id="option-cargo-build---lib"><a class="option-anchor" href="#option-cargo-build---lib"></a><code>--lib</code></dt>
80+
<dd class="option-desc">Build the package's library.</dd>
81+
82+
83+
<dt class="option-term" id="option-cargo-build---bin"><a class="option-anchor" href="#option-cargo-build---bin"></a><code>--bin</code> <em>name</em>...</dt>
84+
<dd class="option-desc">Build the specified binary. This flag may be specified multiple times
85+
and supports common Unix glob patterns.</dd>
86+
87+
88+
<dt class="option-term" id="option-cargo-build---bins"><a class="option-anchor" href="#option-cargo-build---bins"></a><code>--bins</code></dt>
89+
<dd class="option-desc">Build all binary targets.</dd>
90+
7991

8092

8193
<dt class="option-term" id="option-cargo-build---example"><a class="option-anchor" href="#option-cargo-build---example"></a><code>--example</code> <em>name</em>...</dt>

‎src/doc/src/commands/cargo-check.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,18 @@ use single quotes or double quotes around each glob pattern.
8181

8282
<dl>
8383

84+
<dt class="option-term" id="option-cargo-check---lib"><a class="option-anchor" href="#option-cargo-check---lib"></a><code>--lib</code></dt>
85+
<dd class="option-desc">Check the package's library.</dd>
86+
87+
88+
<dt class="option-term" id="option-cargo-check---bin"><a class="option-anchor" href="#option-cargo-check---bin"></a><code>--bin</code> <em>name</em>...</dt>
89+
<dd class="option-desc">Check the specified binary. This flag may be specified multiple times
90+
and supports common Unix glob patterns.</dd>
91+
92+
93+
<dt class="option-term" id="option-cargo-check---bins"><a class="option-anchor" href="#option-cargo-check---bins"></a><code>--bins</code></dt>
94+
<dd class="option-desc">Check all binary targets.</dd>
95+
8496

8597

8698
<dt class="option-term" id="option-cargo-check---example"><a class="option-anchor" href="#option-cargo-check---example"></a><code>--example</code> <em>name</em>...</dt>

‎src/doc/src/commands/cargo-doc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,14 @@ and supports common Unix glob patterns.</dd>
107107
<dd class="option-desc">Document all binary targets.</dd>
108108

109109

110+
110111
<dt class="option-term" id="option-cargo-doc---example"><a class="option-anchor" href="#option-cargo-doc---example"></a><code>--example</code> <em>name</em>...</dt>
111112
<dd class="option-desc">Document the specified example. This flag may be specified multiple times
112113
and supports common Unix glob patterns.</dd>
113114

114115

115116
<dt class="option-term" id="option-cargo-doc---examples"><a class="option-anchor" href="#option-cargo-doc---examples"></a><code>--examples</code></dt>
116-
<dd class="option-desc">Document all examples targets.</dd>
117-
117+
<dd class="option-desc">Document all example targets.</dd>
118118

119119

120120
</dl>

‎src/doc/src/commands/cargo-fix.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,18 @@ use single quotes or double quotes around each glob pattern.
161161

162162
<dl>
163163

164+
<dt class="option-term" id="option-cargo-fix---lib"><a class="option-anchor" href="#option-cargo-fix---lib"></a><code>--lib</code></dt>
165+
<dd class="option-desc">Fix the package's library.</dd>
166+
167+
168+
<dt class="option-term" id="option-cargo-fix---bin"><a class="option-anchor" href="#option-cargo-fix---bin"></a><code>--bin</code> <em>name</em>...</dt>
169+
<dd class="option-desc">Fix the specified binary. This flag may be specified multiple times
170+
and supports common Unix glob patterns.</dd>
171+
172+
173+
<dt class="option-term" id="option-cargo-fix---bins"><a class="option-anchor" href="#option-cargo-fix---bins"></a><code>--bins</code></dt>
174+
<dd class="option-desc">Fix all binary targets.</dd>
175+
164176

165177

166178
<dt class="option-term" id="option-cargo-fix---example"><a class="option-anchor" href="#option-cargo-fix---example"></a><code>--example</code> <em>name</em>...</dt>

‎src/doc/src/commands/cargo-rustc.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,18 @@ use single quotes or double quotes around each glob pattern.
6363

6464
<dl>
6565

66+
<dt class="option-term" id="option-cargo-rustc---lib"><a class="option-anchor" href="#option-cargo-rustc---lib"></a><code>--lib</code></dt>
67+
<dd class="option-desc">Build the package's library.</dd>
68+
69+
70+
<dt class="option-term" id="option-cargo-rustc---bin"><a class="option-anchor" href="#option-cargo-rustc---bin"></a><code>--bin</code> <em>name</em>...</dt>
71+
<dd class="option-desc">Build the specified binary. This flag may be specified multiple times
72+
and supports common Unix glob patterns.</dd>
73+
74+
75+
<dt class="option-term" id="option-cargo-rustc---bins"><a class="option-anchor" href="#option-cargo-rustc---bins"></a><code>--bins</code></dt>
76+
<dd class="option-desc">Build all binary targets.</dd>
77+
6678

6779

6880
<dt class="option-term" id="option-cargo-rustc---example"><a class="option-anchor" href="#option-cargo-rustc---example"></a><code>--example</code> <em>name</em>...</dt>

‎src/doc/src/commands/cargo-rustdoc.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,18 @@ use single quotes or double quotes around each glob pattern.
7878

7979
<dl>
8080

81+
<dt class="option-term" id="option-cargo-rustdoc---lib"><a class="option-anchor" href="#option-cargo-rustdoc---lib"></a><code>--lib</code></dt>
82+
<dd class="option-desc">Document the package's library.</dd>
83+
84+
85+
<dt class="option-term" id="option-cargo-rustdoc---bin"><a class="option-anchor" href="#option-cargo-rustdoc---bin"></a><code>--bin</code> <em>name</em>...</dt>
86+
<dd class="option-desc">Document the specified binary. This flag may be specified multiple times
87+
and supports common Unix glob patterns.</dd>
88+
89+
90+
<dt class="option-term" id="option-cargo-rustdoc---bins"><a class="option-anchor" href="#option-cargo-rustdoc---bins"></a><code>--bins</code></dt>
91+
<dd class="option-desc">Document all binary targets.</dd>
92+
8193

8294

8395
<dt class="option-term" id="option-cargo-rustdoc---example"><a class="option-anchor" href="#option-cargo-rustdoc---example"></a><code>--example</code> <em>name</em>...</dt>

‎src/doc/src/commands/cargo-test.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,18 @@ use single quotes or double quotes around each glob pattern.
148148

149149
<dl>
150150

151+
<dt class="option-term" id="option-cargo-test---lib"><a class="option-anchor" href="#option-cargo-test---lib"></a><code>--lib</code></dt>
152+
<dd class="option-desc">Test the package's library.</dd>
153+
154+
155+
<dt class="option-term" id="option-cargo-test---bin"><a class="option-anchor" href="#option-cargo-test---bin"></a><code>--bin</code> <em>name</em>...</dt>
156+
<dd class="option-desc">Test the specified binary. This flag may be specified multiple times
157+
and supports common Unix glob patterns.</dd>
158+
159+
160+
<dt class="option-term" id="option-cargo-test---bins"><a class="option-anchor" href="#option-cargo-test---bins"></a><code>--bins</code></dt>
161+
<dd class="option-desc">Test all binary targets.</dd>
162+
151163

152164

153165
<dt class="option-term" id="option-cargo-test---example"><a class="option-anchor" href="#option-cargo-test---example"></a><code>--example</code> <em>name</em>...</dt>

0 commit comments

Comments
 (0)