Skip to content

Commit 9ac6af8

Browse files
borsbors
committed
Auto merge of #7928 - ehuss:features-current-doc, r=alexcrichton
Try to clarify how feature flags work on the "current" package. It's a bit confusing, even with an explanation, but maybe it will help. Hopefully some day in the future feature selection won't be so wonky.
2 parents 9c29861 + 7551730 commit 9ac6af8

27 files changed

+193
-18
lines changed

‎src/doc/man/generated/cargo-bench.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,13 @@ <h3 id="cargo_bench_target_selection">Target Selection</h3>
204204
<div class="sect2">
205205
<h3 id="cargo_bench_feature_selection">Feature Selection</h3>
206206
<div class="paragraph">
207+
<p>The feature flags allow you to control the enabled features for the "current"
208+
package. The "current" package is the package in the current directory, or the
209+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
210+
workspace, then the default features are selected for all workspace members,
211+
or all features if <code>--all-features</code> is specified.</p>
212+
</div>
213+
<div class="paragraph">
207214
<p>When no feature options are given, the <code>default</code> feature is activated for
208215
every selected package.</p>
209216
</div>

‎src/doc/man/generated/cargo-build.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,13 @@ <h3 id="cargo_build_target_selection">Target Selection</h3>
133133
<div class="sect2">
134134
<h3 id="cargo_build_feature_selection">Feature Selection</h3>
135135
<div class="paragraph">
136+
<p>The feature flags allow you to control the enabled features for the "current"
137+
package. The "current" package is the package in the current directory, or the
138+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
139+
workspace, then the default features are selected for all workspace members,
140+
or all features if <code>--all-features</code> is specified.</p>
141+
</div>
142+
<div class="paragraph">
136143
<p>When no feature options are given, the <code>default</code> feature is activated for
137144
every selected package.</p>
138145
</div>

‎src/doc/man/generated/cargo-check.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,13 @@ <h3 id="cargo_check_target_selection">Target Selection</h3>
137137
<div class="sect2">
138138
<h3 id="cargo_check_feature_selection">Feature Selection</h3>
139139
<div class="paragraph">
140+
<p>The feature flags allow you to control the enabled features for the "current"
141+
package. The "current" package is the package in the current directory, or the
142+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
143+
workspace, then the default features are selected for all workspace members,
144+
or all features if <code>--all-features</code> is specified.</p>
145+
</div>
146+
<div class="paragraph">
140147
<p>When no feature options are given, the <code>default</code> feature is activated for
141148
every selected package.</p>
142149
</div>

‎src/doc/man/generated/cargo-doc.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ <h3 id="cargo_doc_target_selection">Target Selection</h3>
115115
<div class="sect2">
116116
<h3 id="cargo_doc_feature_selection">Feature Selection</h3>
117117
<div class="paragraph">
118+
<p>The feature flags allow you to control the enabled features for the "current"
119+
package. The "current" package is the package in the current directory, or the
120+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
121+
workspace, then the default features are selected for all workspace members,
122+
or all features if <code>--all-features</code> is specified.</p>
123+
</div>
124+
<div class="paragraph">
118125
<p>When no feature options are given, the <code>default</code> feature is activated for
119126
every selected package.</p>
120127
</div>

‎src/doc/man/generated/cargo-fix.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,13 @@ <h3 id="cargo_fix_target_selection">Target Selection</h3>
213213
<div class="sect2">
214214
<h3 id="cargo_fix_feature_selection">Feature Selection</h3>
215215
<div class="paragraph">
216+
<p>The feature flags allow you to control the enabled features for the "current"
217+
package. The "current" package is the package in the current directory, or the
218+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
219+
workspace, then the default features are selected for all workspace members,
220+
or all features if <code>--all-features</code> is specified.</p>
221+
</div>
222+
<div class="paragraph">
216223
<p>When no feature options are given, the <code>default</code> feature is activated for
217224
every selected package.</p>
218225
</div>

‎src/doc/man/generated/cargo-install.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,13 @@ <h3 id="cargo_install_install_options">Install Options</h3>
203203
<div class="sect2">
204204
<h3 id="cargo_install_feature_selection">Feature Selection</h3>
205205
<div class="paragraph">
206+
<p>The feature flags allow you to control the enabled features for the "current"
207+
package. The "current" package is the package in the current directory, or the
208+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
209+
workspace, then the default features are selected for all workspace members,
210+
or all features if <code>--all-features</code> is specified.</p>
211+
</div>
212+
<div class="paragraph">
206213
<p>When no feature options are given, the <code>default</code> feature is activated for
207214
every selected package.</p>
208215
</div>

‎src/doc/man/generated/cargo-metadata.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,13 @@ <h3 id="cargo_metadata_output_options">Output Options</h3>
312312
<div class="sect2">
313313
<h3 id="cargo_metadata_feature_selection">Feature Selection</h3>
314314
<div class="paragraph">
315+
<p>The feature flags allow you to control the enabled features for the "current"
316+
package. The "current" package is the package in the current directory, or the
317+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
318+
workspace, then the default features are selected for all workspace members,
319+
or all features if <code>--all-features</code> is specified.</p>
320+
</div>
321+
<div class="paragraph">
315322
<p>When no feature options are given, the <code>default</code> feature is activated for
316323
every selected package.</p>
317324
</div>

‎src/doc/man/generated/cargo-package.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,13 @@ <h3 id="cargo_package_compilation_options">Compilation Options</h3>
145145
<div class="sect2">
146146
<h3 id="cargo_package_feature_selection">Feature Selection</h3>
147147
<div class="paragraph">
148+
<p>The feature flags allow you to control the enabled features for the "current"
149+
package. The "current" package is the package in the current directory, or the
150+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
151+
workspace, then the default features are selected for all workspace members,
152+
or all features if <code>--all-features</code> is specified.</p>
153+
</div>
154+
<div class="paragraph">
148155
<p>When no feature options are given, the <code>default</code> feature is activated for
149156
every selected package.</p>
150157
</div>

‎src/doc/man/generated/cargo-publish.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,13 @@ <h3 id="cargo_publish_compilation_options">Compilation Options</h3>
129129
<div class="sect2">
130130
<h3 id="cargo_publish_feature_selection">Feature Selection</h3>
131131
<div class="paragraph">
132+
<p>The feature flags allow you to control the enabled features for the "current"
133+
package. The "current" package is the package in the current directory, or the
134+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
135+
workspace, then the default features are selected for all workspace members,
136+
or all features if <code>--all-features</code> is specified.</p>
137+
</div>
138+
<div class="paragraph">
132139
<p>When no feature options are given, the <code>default</code> feature is activated for
133140
every selected package.</p>
134141
</div>

‎src/doc/man/generated/cargo-run.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ <h3 id="cargo_run_target_selection">Target Selection</h3>
6767
<div class="sect2">
6868
<h3 id="cargo_run_feature_selection">Feature Selection</h3>
6969
<div class="paragraph">
70+
<p>The feature flags allow you to control the enabled features for the "current"
71+
package. The "current" package is the package in the current directory, or the
72+
one specified in <code>--manifest-path</code>. If running in the root of a virtual
73+
workspace, then the default features are selected for all workspace members,
74+
or all features if <code>--all-features</code> is specified.</p>
75+
</div>
76+
<div class="paragraph">
7077
<p>When no feature options are given, the <code>default</code> feature is activated for
7178
every selected package.</p>
7279
</div>

0 commit comments

Comments
 (0)