| = cargo-fix(1) |
| :idprefix: cargo_fix_ |
| :doctype: manpage |
| :actionverb: Fix |
| |
| == NAME |
| |
| cargo-fix - Automatically fix lint warnings reported by rustc |
| |
| == SYNOPSIS |
| |
| `cargo fix [_OPTIONS_]` |
| |
| == 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 `cargo fix` 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. |
| |
| Executing `cargo fix` will under the hood execute man:cargo-check[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: |
| |
| cargo fix --edition |
| |
| which behaves the same as `cargo check --all-targets`. Similarly if you'd like |
| to fix code for different platforms you can do: |
| |
| cargo fix --edition --target x86_64-pc-windows-gnu |
| |
| or if your crate has optional features: |
| |
| cargo fix --edition --no-default-features --features foo |
| |
| If you encounter any problems with `cargo fix` or otherwise have any questions |
| or feature requests please don't hesitate to file an issue at |
| https://github.com/rust-lang/cargo |
| |
| == OPTIONS |
| |
| === Fix options |
| |
| *--broken-code*:: |
| Fix code even if it already has compiler errors. This is useful if `cargo |
| fix` 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. |
| |
| *--edition*:: |
| Apply changes that will update the code to the latest edition. This will |
| not update the edition in the `Cargo.toml` manifest, which must be updated |
| manually. |
| |
| *--edition-idioms*:: |
| Apply suggestions that will update code to the preferred style for the |
| current edition. |
| |
| *--allow-no-vcs*:: |
| Fix code even if a VCS was not detected. |
| |
| *--allow-dirty*:: |
| Fix code even if the working directory has changes. |
| |
| *--allow-staged*:: |
| Fix code even if the working directory has staged changes. |
| |
| === Package Selection |
| |
| include::options-packages.adoc[] |
| |
| === Target Selection |
| |
| When no target selection options are given, `cargo fix` will fix all targets |
| (`--all-targets` implied). Binaries are skipped if they have |
| `required-features` that are missing. |
| |
| include::options-targets.adoc[] |
| |
| include::options-features.adoc[] |
| |
| === Compilation Options |
| |
| include::options-target-triple.adoc[] |
| |
| include::options-release.adoc[] |
| |
| include::options-profile.adoc[] |
| |
| === Output Options |
| |
| include::options-target-dir.adoc[] |
| |
| === Display Options |
| |
| include::options-display.adoc[] |
| |
| include::options-message-format.adoc[] |
| |
| === Manifest Options |
| |
| include::options-manifest-path.adoc[] |
| |
| include::options-locked.adoc[] |
| |
| === Common Options |
| |
| include::options-common.adoc[] |
| |
| === Miscellaneous Options |
| |
| include::options-jobs.adoc[] |
| |
| include::section-profiles.adoc[] |
| |
| include::section-environment.adoc[] |
| |
| include::section-exit-status.adoc[] |
| |
| == EXAMPLES |
| |
| . Apply compiler suggestions to the local package: |
| |
| cargo fix |
| |
| . Convert a 2015 edition to 2018: |
| |
| cargo fix --edition |
| |
| . Apply suggested idioms for the current edition: |
| |
| cargo fix --edition-idioms |
| |
| == SEE ALSO |
| man:cargo[1], man:cargo-check[1] |
