Skip to content

Commit

Permalink
Auto merge of #7928 - ehuss:features-current-doc, r=alexcrichton
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bors committed Feb 25, 2020
2 parents 9c29861 + 7551730 commit 9ac6af8
Show file tree
Hide file tree
Showing 27 changed files with 193 additions and 18 deletions.
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-bench.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,13 @@ <h3 id="cargo_bench_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_bench_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-build.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,13 @@ <h3 id="cargo_build_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_build_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-check.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,13 @@ <h3 id="cargo_check_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_check_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-doc.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ <h3 id="cargo_doc_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_doc_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-fix.html
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,13 @@ <h3 id="cargo_fix_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_fix_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-install.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,13 @@ <h3 id="cargo_install_install_options">Install Options</h3>
<div class="sect2">
<h3 id="cargo_install_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-metadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,13 @@ <h3 id="cargo_metadata_output_options">Output Options</h3>
<div class="sect2">
<h3 id="cargo_metadata_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-package.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,13 @@ <h3 id="cargo_package_compilation_options">Compilation Options</h3>
<div class="sect2">
<h3 id="cargo_package_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-publish.html
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,13 @@ <h3 id="cargo_publish_compilation_options">Compilation Options</h3>
<div class="sect2">
<h3 id="cargo_publish_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-run.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,13 @@ <h3 id="cargo_run_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_run_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-rustc.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ <h3 id="cargo_rustc_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_rustc_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-rustdoc.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,13 @@ <h3 id="cargo_rustdoc_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_rustdoc_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated/cargo-test.html
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,13 @@ <h3 id="cargo_test_target_selection">Target Selection</h3>
<div class="sect2">
<h3 id="cargo_test_feature_selection">Feature Selection</h3>
<div class="paragraph">
<p>The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in <code>--manifest-path</code>. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if <code>--all-features</code> is specified.</p>
</div>
<div class="paragraph">
<p>When no feature options are given, the <code>default</code> feature is activated for
every selected package.</p>
</div>
Expand Down
6 changes: 6 additions & 0 deletions src/doc/man/options-features.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
=== Feature Selection

The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in `--manifest-path`. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if `--all-features` is specified.

When no feature options are given, the `default` feature is activated for
every selected package.

Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-bench.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-bench
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2020-01-18
.\" Date: 2020-02-06
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-BENCH" "1" "2020-01-18" "\ \&" "\ \&"
.TH "CARGO\-BENCH" "1" "2020-02-06" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -244,6 +244,12 @@ Benchmark all targets. This is equivalent to specifying \fB\-\-lib \-\-bins
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
6 changes: 6 additions & 0 deletions src/etc/man/cargo-build.1
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,12 @@ Build all targets. This is equivalent to specifying \fB\-\-lib \-\-bins
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
6 changes: 6 additions & 0 deletions src/etc/man/cargo-check.1
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,12 @@ Check all targets. This is equivalent to specifying \fB\-\-lib \-\-bins
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-doc.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-doc
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2019-12-05
.\" Date: 2020-02-06
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-DOC" "1" "2019-12-05" "\ \&" "\ \&"
.TH "CARGO\-DOC" "1" "2020-02-06" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -116,6 +116,12 @@ Document all binary targets.
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-fix.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-fix
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2019-12-19
.\" Date: 2020-02-06
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-FIX" "1" "2019-12-19" "\ \&" "\ \&"
.TH "CARGO\-FIX" "1" "2020-02-06" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -222,6 +222,12 @@ Fix all targets. This is equivalent to specifying \fB\-\-lib \-\-bins
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-install.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-install
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2019-12-05
.\" Date: 2020-02-06
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-INSTALL" "1" "2019-12-05" "\ \&" "\ \&"
.TH "CARGO\-INSTALL" "1" "2020-02-06" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -295,6 +295,12 @@ If not specified, the default registry is used, which is defined by the
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-metadata.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-metadata
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2019-12-05
.\" Date: 2020-02-24
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-METADATA" "1" "2019-12-05" "\ \&" "\ \&"
.TH "CARGO\-METADATA" "1" "2020-02-24" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -317,6 +317,12 @@ reproduction of the information within \fBCargo.toml\fP.
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
10 changes: 8 additions & 2 deletions src/etc/man/cargo-package.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: cargo-package
.\" Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\" Date: 2019-12-19
.\" Date: 2020-02-06
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "CARGO\-PACKAGE" "1" "2019-12-19" "\ \&" "\ \&"
.TH "CARGO\-PACKAGE" "1" "2020-02-06" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.ss \n[.ss] 0
Expand Down Expand Up @@ -217,6 +217,12 @@ to \fBtarget\fP in the root of the workspace.
.RE
.SS "Feature Selection"
.sp
The feature flags allow you to control the enabled features for the "current"
package. The "current" package is the package in the current directory, or the
one specified in \fB\-\-manifest\-path\fP. If running in the root of a virtual
workspace, then the default features are selected for all workspace members,
or all features if \fB\-\-all\-features\fP is specified.
.sp
When no feature options are given, the \fBdefault\fP feature is activated for
every selected package.
.sp
Expand Down
Loading

0 comments on commit 9ac6af8

Please sign in to comment.