You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
500 lines
15 KiB
500 lines
15 KiB
'\" t
|
|
.TH "CARGO\-FIX" "1"
|
|
.nh
|
|
.ad l
|
|
.ss \n[.ss] 0
|
|
.SH "NAME"
|
|
cargo\-fix \- Automatically fix lint warnings reported by rustc
|
|
.SH "SYNOPSIS"
|
|
\fBcargo fix\fR [\fIoptions\fR]
|
|
.SH "DESCRIPTION"
|
|
This Cargo subcommand will automatically take rustc's suggestions from
|
|
diagnostics like warnings and apply them to your source code. This is intended
|
|
to help automate tasks that rustc itself already knows how to tell you to fix!
|
|
The \fBcargo fix\fR subcommand is also being developed for the Rust 2018 edition
|
|
to provide code the ability to easily opt\-in to the new edition without having
|
|
to worry about any breakage.
|
|
.sp
|
|
Executing \fBcargo fix\fR will under the hood execute \fBcargo\-check\fR(1). Any warnings
|
|
applicable to your crate will be automatically fixed (if possible) and all
|
|
remaining warnings will be displayed when the check process is finished. For
|
|
example if you'd like to prepare for the 2018 edition, you can do so by
|
|
executing:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo fix \-\-edition
|
|
.fi
|
|
.RE
|
|
.sp
|
|
which behaves the same as \fBcargo check \-\-all\-targets\fR\&.
|
|
.sp
|
|
\fBcargo fix\fR is only capable of fixing code that is normally compiled with
|
|
\fBcargo check\fR\&. If code is conditionally enabled with optional features, you
|
|
will need to enable those features for that code to be analyzed:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo fix \-\-edition \-\-features foo
|
|
.fi
|
|
.RE
|
|
.sp
|
|
Similarly, other \fBcfg\fR expressions like platform\-specific code will need to
|
|
pass \fB\-\-target\fR to fix code for the given target.
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo fix \-\-edition \-\-target x86_64\-pc\-windows\-gnu
|
|
.fi
|
|
.RE
|
|
.sp
|
|
If you encounter any problems with \fBcargo fix\fR or otherwise have any questions
|
|
or feature requests please don't hesitate to file an issue at
|
|
<https://github.com/rust\-lang/cargo>
|
|
.SH "OPTIONS"
|
|
.SS "Fix options"
|
|
.sp
|
|
\fB\-\-broken\-code\fR
|
|
.RS 4
|
|
Fix code even if it already has compiler errors. This is useful if \fBcargo fix\fR
|
|
fails to apply the changes. It will apply the changes and leave the broken
|
|
code in the working directory for you to inspect and manually fix.
|
|
.RE
|
|
.sp
|
|
\fB\-\-edition\fR
|
|
.RS 4
|
|
Apply changes that will update the code to the latest edition. This will not
|
|
update the edition in the \fBCargo.toml\fR manifest, which must be updated
|
|
manually.
|
|
.RE
|
|
.sp
|
|
\fB\-\-edition\-idioms\fR
|
|
.RS 4
|
|
Apply suggestions that will update code to the preferred style for the current
|
|
edition.
|
|
.RE
|
|
.sp
|
|
\fB\-\-allow\-no\-vcs\fR
|
|
.RS 4
|
|
Fix code even if a VCS was not detected.
|
|
.RE
|
|
.sp
|
|
\fB\-\-allow\-dirty\fR
|
|
.RS 4
|
|
Fix code even if the working directory has changes.
|
|
.RE
|
|
.sp
|
|
\fB\-\-allow\-staged\fR
|
|
.RS 4
|
|
Fix code even if the working directory has staged changes.
|
|
.RE
|
|
.SS "Package Selection"
|
|
By default, when no package selection options are given, the packages selected
|
|
depend on the selected manifest file (based on the current working directory if
|
|
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
|
the workspaces default members are selected, otherwise only the package defined
|
|
by the manifest will be selected.
|
|
.sp
|
|
The default members of a workspace can be set explicitly with the
|
|
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
|
virtual workspace will include all workspace members (equivalent to passing
|
|
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
|
.sp
|
|
\fB\-p\fR \fIspec\fR\&...,
|
|
\fB\-\-package\fR \fIspec\fR\&...
|
|
.RS 4
|
|
Fix only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
|
SPEC format. This flag may be specified multiple times and supports common Unix
|
|
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
|
expanding glob patterns before Cargo handles them, you must use single quotes or
|
|
double quotes around each pattern.
|
|
.RE
|
|
.sp
|
|
\fB\-\-workspace\fR
|
|
.RS 4
|
|
Fix all members in the workspace.
|
|
.RE
|
|
.sp
|
|
\fB\-\-all\fR
|
|
.RS 4
|
|
Deprecated alias for \fB\-\-workspace\fR\&.
|
|
.RE
|
|
.sp
|
|
\fB\-\-exclude\fR \fISPEC\fR\&...
|
|
.RS 4
|
|
Exclude the specified packages. Must be used in conjunction with the
|
|
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
|
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
|
accidentally expanding glob patterns before Cargo handles them, you must use
|
|
single quotes or double quotes around each pattern.
|
|
.RE
|
|
.SS "Target Selection"
|
|
When no target selection options are given, \fBcargo fix\fR will fix all targets
|
|
(\fB\-\-all\-targets\fR implied). Binaries are skipped if they have
|
|
\fBrequired\-features\fR that are missing.
|
|
.sp
|
|
Passing target selection flags will fix only the specified
|
|
targets.
|
|
.sp
|
|
Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
|
|
support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your
|
|
shell accidentally expanding glob patterns before Cargo handles them, you must
|
|
use single quotes or double quotes around each glob pattern.
|
|
.sp
|
|
\fB\-\-lib\fR
|
|
.RS 4
|
|
Fix the package's library.
|
|
.RE
|
|
.sp
|
|
\fB\-\-bin\fR \fIname\fR\&...
|
|
.RS 4
|
|
Fix the specified binary. This flag may be specified multiple times
|
|
and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-bins\fR
|
|
.RS 4
|
|
Fix all binary targets.
|
|
.RE
|
|
.sp
|
|
\fB\-\-example\fR \fIname\fR\&...
|
|
.RS 4
|
|
Fix the specified example. This flag may be specified multiple times
|
|
and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-examples\fR
|
|
.RS 4
|
|
Fix all example targets.
|
|
.RE
|
|
.sp
|
|
\fB\-\-test\fR \fIname\fR\&...
|
|
.RS 4
|
|
Fix the specified integration test. This flag may be specified
|
|
multiple times and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-tests\fR
|
|
.RS 4
|
|
Fix all targets in test mode that have the \fBtest = true\fR manifest
|
|
flag set. By default this includes the library and binaries built as
|
|
unittests, and integration tests. Be aware that this will also build any
|
|
required dependencies, so the lib target may be built twice (once as a
|
|
unittest, and once as a dependency for binaries, integration tests, etc.).
|
|
Targets may be enabled or disabled by setting the \fBtest\fR flag in the
|
|
manifest settings for the target.
|
|
.RE
|
|
.sp
|
|
\fB\-\-bench\fR \fIname\fR\&...
|
|
.RS 4
|
|
Fix the specified benchmark. This flag may be specified multiple
|
|
times and supports common Unix glob patterns.
|
|
.RE
|
|
.sp
|
|
\fB\-\-benches\fR
|
|
.RS 4
|
|
Fix all targets in benchmark mode that have the \fBbench = true\fR
|
|
manifest flag set. By default this includes the library and binaries built
|
|
as benchmarks, and bench targets. Be aware that this will also build any
|
|
required dependencies, so the lib target may be built twice (once as a
|
|
benchmark, and once as a dependency for binaries, benchmarks, etc.).
|
|
Targets may be enabled or disabled by setting the \fBbench\fR flag in the
|
|
manifest settings for the target.
|
|
.RE
|
|
.sp
|
|
\fB\-\-all\-targets\fR
|
|
.RS 4
|
|
Fix all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
|
|
.RE
|
|
.SS "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 \fB\-\-manifest\-path\fR\&. 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\fR is specified.
|
|
.sp
|
|
When no feature options are given, the \fBdefault\fR feature is activated for
|
|
every selected package.
|
|
.sp
|
|
\fB\-\-features\fR \fIfeatures\fR
|
|
.RS 4
|
|
Space or comma separated list of features to activate. These features only
|
|
apply to the current directory's package. Features of direct dependencies
|
|
may be enabled with \fB<dep\-name>/<feature\-name>\fR syntax. This flag may be
|
|
specified multiple times, which enables all specified features.
|
|
.RE
|
|
.sp
|
|
\fB\-\-all\-features\fR
|
|
.RS 4
|
|
Activate all available features of all selected packages.
|
|
.RE
|
|
.sp
|
|
\fB\-\-no\-default\-features\fR
|
|
.RS 4
|
|
Do not activate the \fBdefault\fR feature of the current directory's package.
|
|
.RE
|
|
.SS "Compilation Options"
|
|
.sp
|
|
\fB\-\-target\fR \fItriple\fR
|
|
.RS 4
|
|
Fix for the given architecture. The default is the host
|
|
architecture. The general format of the triple is
|
|
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
|
|
list of supported targets.
|
|
.sp
|
|
This may also be specified with the \fBbuild.target\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.sp
|
|
Note that specifying this flag makes Cargo run in a different mode where the
|
|
target artifacts are placed in a separate directory. See the
|
|
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/guide/build\-cache.html> documentation for more details.
|
|
.RE
|
|
.sp
|
|
\fB\-\-release\fR
|
|
.RS 4
|
|
Fix optimized artifacts with the \fBrelease\fR profile. See the
|
|
PROFILES section for details on how this affects profile
|
|
selection.
|
|
.RE
|
|
.sp
|
|
\fB\-\-profile\fR \fIname\fR
|
|
.RS 4
|
|
Changes fix behavior. Currently only \fBtest\fR is supported,
|
|
which will fix with the \fB#[cfg(test)]\fR attribute enabled.
|
|
This is useful to have it fix unit tests which are usually
|
|
excluded via the \fBcfg\fR attribute. This does not change the actual profile
|
|
used.
|
|
.RE
|
|
.SS "Output Options"
|
|
.sp
|
|
\fB\-\-target\-dir\fR \fIdirectory\fR
|
|
.RS 4
|
|
Directory for all generated artifacts and intermediate files. May also be
|
|
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
|
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults
|
|
to \fBtarget\fR in the root of the workspace.
|
|
.RE
|
|
.SS "Display Options"
|
|
.sp
|
|
\fB\-v\fR,
|
|
\fB\-\-verbose\fR
|
|
.RS 4
|
|
Use verbose output. May be specified twice for "very verbose" output which
|
|
includes extra output such as dependency warnings and build script output.
|
|
May also be specified with the \fBterm.verbose\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-q\fR,
|
|
\fB\-\-quiet\fR
|
|
.RS 4
|
|
No output printed to stdout.
|
|
.RE
|
|
.sp
|
|
\fB\-\-color\fR \fIwhen\fR
|
|
.RS 4
|
|
Control when colored output is used. Valid values:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBauto\fR (default): Automatically detect if color support is available on the
|
|
terminal.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBalways\fR: Always display colors.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBnever\fR: Never display colors.
|
|
.RE
|
|
.sp
|
|
May also be specified with the \fBterm.color\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-\-message\-format\fR \fIfmt\fR
|
|
.RS 4
|
|
The output format for diagnostic messages. Can be specified multiple times
|
|
and consists of comma\-separated values. Valid values:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBhuman\fR (default): Display in a human\-readable text format.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBshort\fR: Emit shorter, human\-readable text messages.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\fR: Emit JSON messages to stdout. See
|
|
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
|
for more details.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
|
the "short" rendering from rustc.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
|
contains embedded ANSI color codes for respecting rustc's default color
|
|
scheme.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in
|
|
in JSON messages printed, but instead Cargo itself should render the
|
|
JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others
|
|
coming from rustc are still emitted.
|
|
.RE
|
|
.RE
|
|
.SS "Manifest Options"
|
|
.sp
|
|
\fB\-\-manifest\-path\fR \fIpath\fR
|
|
.RS 4
|
|
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
|
\fBCargo.toml\fR file in the current directory or any parent directory.
|
|
.RE
|
|
.sp
|
|
\fB\-\-frozen\fR,
|
|
\fB\-\-locked\fR
|
|
.RS 4
|
|
Either of these flags requires that the \fBCargo.lock\fR file is
|
|
up\-to\-date. If the lock file is missing, or it needs to be updated, Cargo will
|
|
exit with an error. The \fB\-\-frozen\fR flag also prevents Cargo from
|
|
attempting to access the network to determine if it is out\-of\-date.
|
|
.sp
|
|
These may be used in environments where you want to assert that the
|
|
\fBCargo.lock\fR file is up\-to\-date (such as a CI build) or want to avoid network
|
|
access.
|
|
.RE
|
|
.sp
|
|
\fB\-\-offline\fR
|
|
.RS 4
|
|
Prevents Cargo from accessing the network for any reason. Without this
|
|
flag, Cargo will stop with an error if it needs to access the network and
|
|
the network is not available. With this flag, Cargo will attempt to
|
|
proceed without the network if possible.
|
|
.sp
|
|
Beware that this may result in different dependency resolution than online
|
|
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
|
if there might be a newer version as indicated in the local copy of the index.
|
|
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
|
offline.
|
|
.sp
|
|
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.SS "Common Options"
|
|
.sp
|
|
\fB+\fR\fItoolchain\fR
|
|
.RS 4
|
|
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
|
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
|
as \fB+stable\fR or \fB+nightly\fR).
|
|
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
|
for more information about how toolchain overrides work.
|
|
.RE
|
|
.sp
|
|
\fB\-h\fR,
|
|
\fB\-\-help\fR
|
|
.RS 4
|
|
Prints help information.
|
|
.RE
|
|
.sp
|
|
\fB\-Z\fR \fIflag\fR
|
|
.RS 4
|
|
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
|
.RE
|
|
.SS "Miscellaneous Options"
|
|
.sp
|
|
\fB\-j\fR \fIN\fR,
|
|
\fB\-\-jobs\fR \fIN\fR
|
|
.RS 4
|
|
Number of parallel jobs to run. May also be specified with the
|
|
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
|
the number of CPUs.
|
|
.RE
|
|
.SH "PROFILES"
|
|
Profiles may be used to configure compiler options such as optimization levels
|
|
and debug settings. See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more
|
|
details.
|
|
.sp
|
|
Profile selection depends on the target and crate being built. By default the
|
|
\fBdev\fR or \fBtest\fR profiles are used. If the \fB\-\-release\fR flag is given, then the
|
|
\fBrelease\fR or \fBbench\fR profiles are used.
|
|
|
|
.TS
|
|
allbox tab(:);
|
|
lt lt lt.
|
|
T{
|
|
Target
|
|
T}:T{
|
|
Default Profile
|
|
T}:T{
|
|
\fB\-\-release\fR Profile
|
|
T}
|
|
T{
|
|
lib, bin, example
|
|
T}:T{
|
|
\fBdev\fR
|
|
T}:T{
|
|
\fBrelease\fR
|
|
T}
|
|
T{
|
|
test, bench, or any target in "test" or "bench" mode
|
|
T}:T{
|
|
\fBtest\fR
|
|
T}:T{
|
|
\fBbench\fR
|
|
T}
|
|
.TE
|
|
.sp
|
|
.sp
|
|
Dependencies use the \fBdev\fR/\fBrelease\fR profiles.
|
|
.SH "ENVIRONMENT"
|
|
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
|
details on environment variables that Cargo reads.
|
|
.SH "EXIT STATUS"
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fB0\fR: Cargo succeeded.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fB101\fR: Cargo failed to complete.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 1.\h'+01'Apply compiler suggestions to the local package:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo fix
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 2.\h'+01'Convert a 2015 edition to 2018:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo fix \-\-edition
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 3.\h'+01'Apply suggested idioms for the current edition:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo fix \-\-edition\-idioms
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
\fBcargo\fR(1), \fBcargo\-check\fR(1)
|