diff --git a/crates/mdman/doc/out/mdman.md b/crates/mdman/doc/out/mdman.md index aefafa48bbd..08233ac3224 100644 --- a/crates/mdman/doc/out/mdman.md +++ b/crates/mdman/doc/out/mdman.md @@ -53,7 +53,7 @@ man page:
-
-t type
+
-t type

Specifies the output type. The following output types are supported:

-
-o outdir
+
-o outdir

Specifies the directory where to save the output.

-
--url base_url
+
--url base_url

Specifies a base URL to use for relative URLs within the document. Any relative URL will be joined with this URL.

-
--man name:section=url
+
--man name:section=url

Specifies a URL to use for the given man page. When the {{man name section}} expression is used, the given URL will be inserted as a link. This may be specified multiple times. If a man page reference does not have a matching --man entry, then a relative link to a file named name.md will @@ -85,7 +85,7 @@ be used.

-
sources…
+
sources…

The source input filename, may be specified multiple times.

diff --git a/crates/mdman/src/format/md.rs b/crates/mdman/src/format/md.rs index c10628c29c9..7f9cf6e074d 100644 --- a/crates/mdman/src/format/md.rs +++ b/crates/mdman/src/format/md.rs @@ -58,10 +58,8 @@ impl super::Formatter for MdFormatter { let id = format!("option-{}-{}", man_name, no_tags); write!( result, - "
\ - {OPTION}
\n", - ID = id, - OPTION = no_p + "
\ + {no_p}
\n", )?; } let rendered_block = self.render_html(block)?; diff --git a/crates/mdman/tests/compare/expected/links.md b/crates/mdman/tests/compare/expected/links.md index 526f01040d4..bcf7d7b7b46 100644 --- a/crates/mdman/tests/compare/expected/links.md +++ b/crates/mdman/tests/compare/expected/links.md @@ -33,7 +33,7 @@ Shortcut unknown: [shortcut unknown] [Some link](foo.html)
-
--include
+
--include

Testing an included link.

@@ -44,7 +44,7 @@ Shortcut unknown: [shortcut unknown]
-
--foo-bar
+
--foo-bar

Example link. See other-cmd(1), local-cmd(1)

diff --git a/crates/mdman/tests/compare/expected/options.md b/crates/mdman/tests/compare/expected/options.md index 5a8b7af13ca..58f451e0698 100644 --- a/crates/mdman/tests/compare/expected/options.md +++ b/crates/mdman/tests/compare/expected/options.md @@ -28,23 +28,23 @@ A description of the command.
-
--foo-bar
+
--foo-bar

Demo emphasis, strong, strike

-
-p spec
-
--package spec
+
-p spec
+
--package spec

This has multiple flags.

-
named-arg…
+
named-arg…

A named argument.

-
--complex
+
--complex

This option has a list.

  • alpha
    • @@ -60,22 +60,22 @@ A description of the command. ### Common Options
    -
    @filename
    +
    @filename

    Load from filename.

    -
    --foo [bar]
    +
    --foo [bar]

    Flag with optional value.

    -
    --foo[=bar]
    +
    --foo[=bar]

    Alternate syntax for optional value (with required = for disambiguation).

    -
    --split-block
    +
    --split-block

    An option where the description has a block statement that is split across multiple lines

    diff --git a/src/doc/src/commands/cargo-add.md b/src/doc/src/commands/cargo-add.md index 4f1ab7fca18..976c6ac1009 100644 --- a/src/doc/src/commands/cargo-add.md +++ b/src/doc/src/commands/cargo-add.md @@ -39,38 +39,38 @@ dependency will be listed in the command's output.
    -
    --git url
    +
    --git url

    Git URL to add the specified crate from.

    -
    --branch branch
    +
    --branch branch

    Branch to use when adding from git.

    -
    --tag tag
    +
    --tag tag

    Tag to use when adding from git.

    -
    --rev sha
    +
    --rev sha

    Specific commit to use when adding from git.

    -
    --path path
    +
    --path path

    Filesystem path to local crate to add.

    -
    --base base
    +
    --base base

    The path base to use when adding a local crate.

    Unstable (nightly-only)

    -
    --registry registry
    +
    --registry registry

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -84,17 +84,17 @@ which is defined by the registry.default config key which defaults

    -
    --dev
    +
    --dev

    Add as a development dependency.

    -
    --build
    +
    --build

    Add as a build dependency.

    -
    --target target
    +
    --target target

    Add as a dependency to the given target platform.

    To avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.

    @@ -106,52 +106,52 @@ which is defined by the registry.default config key which defaults
    -
    --dry-run
    +
    --dry-run

    Don’t actually write the manifest

    -
    --rename name
    +
    --rename name

    Rename the dependency.

    -
    --optional
    +
    --optional

    Mark the dependency as optional.

    -
    --no-optional
    +
    --no-optional

    Mark the dependency as required.

    -
    --public
    +
    --public

    Mark the dependency as public.

    The dependency can be referenced in your library’s public API.

    Unstable (nightly-only)

    -
    --no-public
    +
    --no-public

    Mark the dependency as private.

    While you can use the crate in your implementation, it cannot be referenced in your public API.

    Unstable (nightly-only)

    -
    --no-default-features
    +
    --no-default-features

    Disable the default features.

    -
    --default-features
    +
    --default-features

    Re-enable the default features.

    -
    -F features
    -
    --features features
    +
    -F features
    +
    --features features

    Space or comma separated list of features to activate. When adding multiple crates, the features for a specific crate may be enabled with @@ -166,8 +166,8 @@ which enables all specified features.

    ### Display Options
    -
    -v
    -
    --verbose
    +
    -v
    +
    --verbose

    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 term.verbose @@ -175,15 +175,15 @@ May also be specified with the term.verbose

    -
    -q
    -
    --quiet
    +
    -q
    +
    --quiet

    Do not print cargo log messages. May also be specified with the term.quiet config value.

    -
    --color when
    +
    --color when

    Control when colored output is used. Valid values:

    • auto (default): Automatically detect if color support is available on the @@ -200,24 +200,24 @@ terminal.
      • ### Manifest Options
      -
      --manifest-path path
      +
      --manifest-path path

      Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

      -
      -p spec
      -
      --package spec
      +
      -p spec
      +
      --package spec

      Add dependencies to only the specified package.

      -
      --ignore-rust-version
      +
      --ignore-rust-version

      Ignore rust-version specification in packages.

      -
      --locked
      +
      --locked

      Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

      @@ -230,7 +230,7 @@ such as in CI pipelines.

      -
      --offline
      +
      --offline

      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 @@ -244,12 +244,12 @@ offline.

      -
      --frozen
      +
      --frozen

      Equivalent to specifying both --locked and --offline.

      -
      --lockfile-path PATH
      +
      --lockfile-path PATH

      Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -267,7 +267,7 @@ requires the -Z unstable-options flag to enable (see

      -
      +toolchain
      +
      +toolchain

      If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -276,14 +276,14 @@ for more information about how toolchain overrides work.

      -
      --config KEY=VALUE or PATH
      +
      --config KEY=VALUE or PATH

      Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

      -
      -C PATH
      +
      -C PATH

      Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -295,13 +295,13 @@ requires the -Z unstable-options flag to enable (see

      -
      -h
      -
      --help
      +
      -h
      +
      --help

      Prints help information.

      -
      -Z flag
      +
      -Z flag

      Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

      diff --git a/src/doc/src/commands/cargo-bench.md b/src/doc/src/commands/cargo-bench.md index 0994e76911f..6b3dc61f827 100644 --- a/src/doc/src/commands/cargo-bench.md +++ b/src/doc/src/commands/cargo-bench.md @@ -66,12 +66,12 @@ relative paths, regardless from where `cargo bench` was executed from.
      -
      --no-run
      +
      --no-run

      Compile, but don’t run benchmarks.

      -
      --no-fail-fast
      +
      --no-fail-fast

      Run all benchmarks regardless of failure. Without this flag, Cargo will exit after the first executable fails. The Rust test harness will run all benchmarks within the executable to completion, this flag only applies to the executable @@ -96,8 +96,8 @@ virtual workspace will include all workspace members (equivalent to passing

      -
      -p spec…
      -
      --package spec…
      +
      -p spec…
      +
      --package spec…

      Benchmark only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -106,17 +106,17 @@ double quotes around each pattern.

      -
      --workspace
      +
      --workspace

      Benchmark all members in the workspace.

      -
      --all
      +
      --all

      Deprecated alias for --workspace.

      -
      --exclude SPEC…
      +
      --exclude SPEC…

      Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -171,40 +171,40 @@ use single quotes or double quotes around each glob pattern.

      -
      --lib
      +
      --lib

      Benchmark the package’s library.

      -
      --bin name…
      +
      --bin name…

      Benchmark the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

      -
      --bins
      +
      --bins

      Benchmark all binary targets.

      -
      --example name…
      +
      --example name…

      Benchmark the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

      -
      --examples
      +
      --examples

      Benchmark all example targets.

      -
      --test name…
      +
      --test name…

      Benchmark the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

      -
      --tests
      +
      --tests

      Benchmark all targets that have the test = true 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 @@ -215,13 +215,13 @@ manifest settings for the target.

      -
      --bench name…
      +
      --bench name…

      Benchmark the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

      -
      --benches
      +
      --benches

      Benchmark all targets that have the bench = true 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 @@ -232,7 +232,7 @@ manifest settings for the target.

      -
      --all-targets
      +
      --all-targets

      Benchmark all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

      @@ -250,20 +250,20 @@ for more details.
      -
      -F features
      -
      --features features
      +
      -F features
      +
      --features features

      Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

      -
      --all-features
      +
      --all-features

      Activate all available features of all selected packages.

      -
      --no-default-features
      +
      --no-default-features

      Do not activate the default feature of the selected packages.

      @@ -274,7 +274,7 @@ be specified multiple times, which enables all specified features.

      -
      --target triple
      +
      --target triple

      Benchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

      Possible values:

      @@ -290,13 +290,13 @@ target artifacts are placed in a separate directory. See the
      -
      --profile name
      +
      --profile name

      Benchmark with the given profile. See the reference for more details on profiles.

      -
      --timings=fmts
      +
      --timings=fmts

      Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -320,7 +320,7 @@ information about timing information. ### Output Options

      -
      --target-dir directory
      +
      --target-dir directory

      Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -339,8 +339,8 @@ passing `--no-capture` to the benchmark binaries:

      -
      -v
      -
      --verbose
      +
      -v
      +
      --verbose

      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 term.verbose @@ -348,15 +348,15 @@ May also be specified with the term.verbose

      -
      -q
      -
      --quiet
      +
      -q
      +
      --quiet

      Do not print cargo log messages. May also be specified with the term.quiet config value.

      -
      --color when
      +
      --color when

      Control when colored output is used. Valid values:

      • auto (default): Automatically detect if color support is available on the @@ -369,7 +369,7 @@ terminal.
      -
      --message-format fmt
      +
      --message-format fmt

      The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

        @@ -398,18 +398,18 @@ coming from rustc are still emitted. Cannot be used with human or < ### Manifest Options
        -
        --manifest-path path
        +
        --manifest-path path

        Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

        -
        --ignore-rust-version
        +
        --ignore-rust-version

        Ignore rust-version specification in packages.

        -
        --locked
        +
        --locked

        Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

        @@ -422,7 +422,7 @@ such as in CI pipelines.

        -
        --offline
        +
        --offline

        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 @@ -436,12 +436,12 @@ offline.

        -
        --frozen
        +
        --frozen

        Equivalent to specifying both --locked and --offline.

        -
        --lockfile-path PATH
        +
        --lockfile-path PATH

        Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -459,7 +459,7 @@ requires the -Z unstable-options flag to enable (see

        -
        +toolchain
        +
        +toolchain

        If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -468,14 +468,14 @@ for more information about how toolchain overrides work.

        -
        --config KEY=VALUE or PATH
        +
        --config KEY=VALUE or PATH

        Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

        -
        -C PATH
        +
        -C PATH

        Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -487,13 +487,13 @@ requires the -Z unstable-options flag to enable (see

        -
        -h
        -
        --help
        +
        -h
        +
        --help

        Prints help information.

        -
        -Z flag
        +
        -Z flag

        Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

        @@ -507,8 +507,8 @@ does not affect how many threads are used when running the benchmarks. The Rust test harness runs benchmarks serially in a single thread.
        -
        -j N
        -
        --jobs N
        +
        -j N
        +
        --jobs N

        Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of diff --git a/src/doc/src/commands/cargo-build.md b/src/doc/src/commands/cargo-build.md index c072b054930..2753873b8d5 100644 --- a/src/doc/src/commands/cargo-build.md +++ b/src/doc/src/commands/cargo-build.md @@ -28,8 +28,8 @@ virtual workspace will include all workspace members (equivalent to passing

        -
        -p spec…
        -
        --package spec…
        +
        -p spec…
        +
        --package spec…

        Build only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -38,17 +38,17 @@ double quotes around each pattern.

        -
        --workspace
        +
        --workspace

        Build all members in the workspace.

        -
        --all
        +
        --all

        Deprecated alias for --workspace.

        -
        --exclude SPEC…
        +
        --exclude SPEC…

        Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -84,40 +84,40 @@ use single quotes or double quotes around each glob pattern.

        -
        --lib
        +
        --lib

        Build the package’s library.

        -
        --bin name…
        +
        --bin name…

        Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --bins
        +
        --bins

        Build all binary targets.

        -
        --example name…
        +
        --example name…

        Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --examples
        +
        --examples

        Build all example targets.

        -
        --test name…
        +
        --test name…

        Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --tests
        +
        --tests

        Build all targets that have the test = true 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 @@ -128,13 +128,13 @@ manifest settings for the target.

        -
        --bench name…
        +
        --bench name…

        Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --benches
        +
        --benches

        Build all targets that have the bench = true 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 @@ -145,7 +145,7 @@ manifest settings for the target.

        -
        --all-targets
        +
        --all-targets

        Build all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

        @@ -163,20 +163,20 @@ for more details.
        -
        -F features
        -
        --features features
        +
        -F features
        +
        --features features

        Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

        -
        --all-features
        +
        --all-features

        Activate all available features of all selected packages.

        -
        --no-default-features
        +
        --no-default-features

        Do not activate the default feature of the selected packages.

        @@ -187,7 +187,7 @@ be specified multiple times, which enables all specified features.

        -
        --target triple
        +
        --target triple

        Build for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

        Possible values:

        @@ -203,20 +203,20 @@ target artifacts are placed in a separate directory. See the
        -
        -r
        -
        --release
        +
        -r
        +
        --release

        Build optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

        -
        --profile name
        +
        --profile name

        Build with the given profile. See the reference for more details on profiles.

        -
        --timings=fmts
        +
        --timings=fmts

        Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -240,7 +240,7 @@ information about timing information. ### Output Options

        -
        --target-dir directory
        +
        --target-dir directory

        Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -248,7 +248,7 @@ Defaults to target in the root of the workspace.

        -
        --artifact-dir directory
        +
        --artifact-dir directory

        Copy final artifacts to this directory.

        This option is unstable and available only on the nightly channel @@ -262,8 +262,8 @@ See https://github.com/ ### Display Options

        -
        -v
        -
        --verbose
        +
        -v
        +
        --verbose

        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 term.verbose @@ -271,15 +271,15 @@ May also be specified with the term.verbose

        -
        -q
        -
        --quiet
        +
        -q
        +
        --quiet

        Do not print cargo log messages. May also be specified with the term.quiet config value.

        -
        --color when
        +
        --color when

        Control when colored output is used. Valid values:

        • auto (default): Automatically detect if color support is available on the @@ -292,7 +292,7 @@ terminal.
        -
        --message-format fmt
        +
        --message-format fmt

        The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

          @@ -316,7 +316,7 @@ coming from rustc are still emitted. Cannot be used with human or <
        -
        --build-plan
        +
        --build-plan

        Outputs a series of JSON messages to stdout that indicate the commands to run the build.

        This option is unstable and available only on the @@ -330,18 +330,18 @@ See https://github.com/ ### Manifest Options

        -
        --manifest-path path
        +
        --manifest-path path

        Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

        -
        --ignore-rust-version
        +
        --ignore-rust-version

        Ignore rust-version specification in packages.

        -
        --locked
        +
        --locked

        Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

        @@ -354,7 +354,7 @@ such as in CI pipelines.

        -
        --offline
        +
        --offline

        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 @@ -368,12 +368,12 @@ offline.

        -
        --frozen
        +
        --frozen

        Equivalent to specifying both --locked and --offline.

        -
        --lockfile-path PATH
        +
        --lockfile-path PATH

        Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -391,7 +391,7 @@ requires the -Z unstable-options flag to enable (see

        -
        +toolchain
        +
        +toolchain

        If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -400,14 +400,14 @@ for more information about how toolchain overrides work.

        -
        --config KEY=VALUE or PATH
        +
        --config KEY=VALUE or PATH

        Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

        -
        -C PATH
        +
        -C PATH

        Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -419,13 +419,13 @@ requires the -Z unstable-options flag to enable (see

        -
        -h
        -
        --help
        +
        -h
        +
        --help

        Prints help information.

        -
        -Z flag
        +
        -Z flag

        Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

        @@ -435,8 +435,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
        -
        -j N
        -
        --jobs N
        +
        -j N
        +
        --jobs N

        Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -445,7 +445,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

        -
        --keep-going
        +
        --keep-going

        Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

        For example if the current package depends on dependencies fails and works, @@ -455,7 +455,7 @@ first), whereas cargo build -j1 --keep-going would definitely run b builds, even if the one run first fails.

        -
        --future-incompat-report
        +
        --future-incompat-report

        Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

        See cargo-report(1)

        diff --git a/src/doc/src/commands/cargo-check.md b/src/doc/src/commands/cargo-check.md index 56292de3c02..c76bd7d6d93 100644 --- a/src/doc/src/commands/cargo-check.md +++ b/src/doc/src/commands/cargo-check.md @@ -33,8 +33,8 @@ virtual workspace will include all workspace members (equivalent to passing
        -
        -p spec…
        -
        --package spec…
        +
        -p spec…
        +
        --package spec…

        Check only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -43,17 +43,17 @@ double quotes around each pattern.

        -
        --workspace
        +
        --workspace

        Check all members in the workspace.

        -
        --all
        +
        --all

        Deprecated alias for --workspace.

        -
        --exclude SPEC…
        +
        --exclude SPEC…

        Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -80,40 +80,40 @@ use single quotes or double quotes around each glob pattern.

        -
        --lib
        +
        --lib

        Check the package’s library.

        -
        --bin name…
        +
        --bin name…

        Check the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --bins
        +
        --bins

        Check all binary targets.

        -
        --example name…
        +
        --example name…

        Check the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --examples
        +
        --examples

        Check all example targets.

        -
        --test name…
        +
        --test name…

        Check the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --tests
        +
        --tests

        Check all targets that have the test = true 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 @@ -124,13 +124,13 @@ manifest settings for the target.

        -
        --bench name…
        +
        --bench name…

        Check the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

        -
        --benches
        +
        --benches

        Check all targets that have the bench = true 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 @@ -141,7 +141,7 @@ manifest settings for the target.

        -
        --all-targets
        +
        --all-targets

        Check all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

        @@ -159,20 +159,20 @@ for more details.
        -
        -F features
        -
        --features features
        +
        -F features
        +
        --features features

        Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

        -
        --all-features
        +
        --all-features

        Activate all available features of all selected packages.

        -
        --no-default-features
        +
        --no-default-features

        Do not activate the default feature of the selected packages.

        @@ -183,7 +183,7 @@ be specified multiple times, which enables all specified features.

        -
        --target triple
        +
        --target triple

        Check for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

        Possible values:

        @@ -199,14 +199,14 @@ target artifacts are placed in a separate directory. See the
        -
        -r
        -
        --release
        +
        -r
        +
        --release

        Check optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

        -
        --profile name
        +
        --profile name

        Check with the given profile.

        As a special case, specifying the test profile will also enable checking in test mode which will enable checking tests and enable the test cfg option. @@ -216,7 +216,7 @@ detail.

        -
        --timings=fmts
        +
        --timings=fmts

        Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -240,7 +240,7 @@ information about timing information. ### Output Options

        -
        --target-dir directory
        +
        --target-dir directory

        Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -252,8 +252,8 @@ Defaults to target in the root of the workspace.

        ### Display Options
        -
        -v
        -
        --verbose
        +
        -v
        +
        --verbose

        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 term.verbose @@ -261,15 +261,15 @@ May also be specified with the term.verbose

        -
        -q
        -
        --quiet
        +
        -q
        +
        --quiet

        Do not print cargo log messages. May also be specified with the term.quiet config value.

        -
        --color when
        +
        --color when

        Control when colored output is used. Valid values:

        • auto (default): Automatically detect if color support is available on the @@ -282,7 +282,7 @@ terminal.
        -
        --message-format fmt
        +
        --message-format fmt

        The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

          @@ -310,18 +310,18 @@ coming from rustc are still emitted. Cannot be used with human or < ### Manifest Options
          -
          --manifest-path path
          +
          --manifest-path path

          Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

          -
          --ignore-rust-version
          +
          --ignore-rust-version

          Ignore rust-version specification in packages.

          -
          --locked
          +
          --locked

          Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

          @@ -334,7 +334,7 @@ such as in CI pipelines.

          -
          --offline
          +
          --offline

          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 @@ -348,12 +348,12 @@ offline.

          -
          --frozen
          +
          --frozen

          Equivalent to specifying both --locked and --offline.

          -
          --lockfile-path PATH
          +
          --lockfile-path PATH

          Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -371,7 +371,7 @@ requires the -Z unstable-options flag to enable (see

          -
          +toolchain
          +
          +toolchain

          If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -380,14 +380,14 @@ for more information about how toolchain overrides work.

          -
          --config KEY=VALUE or PATH
          +
          --config KEY=VALUE or PATH

          Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

          -
          -C PATH
          +
          -C PATH

          Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -399,13 +399,13 @@ requires the -Z unstable-options flag to enable (see

          -
          -h
          -
          --help
          +
          -h
          +
          --help

          Prints help information.

          -
          -Z flag
          +
          -Z flag

          Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

          @@ -415,8 +415,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
          -
          -j N
          -
          --jobs N
          +
          -j N
          +
          --jobs N

          Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -425,7 +425,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

          -
          --keep-going
          +
          --keep-going

          Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

          For example if the current package depends on dependencies fails and works, @@ -435,7 +435,7 @@ first), whereas cargo check -j1 --keep-going would definitely run b builds, even if the one run first fails.

          -
          --future-incompat-report
          +
          --future-incompat-report

          Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

          See cargo-report(1)

          diff --git a/src/doc/src/commands/cargo-clean.md b/src/doc/src/commands/cargo-clean.md index 8fe0a64c339..e1e91e8c389 100644 --- a/src/doc/src/commands/cargo-clean.md +++ b/src/doc/src/commands/cargo-clean.md @@ -22,8 +22,8 @@ When no packages are selected, all packages and all dependencies in the workspace are cleaned.
          -
          -p spec…
          -
          --package spec…
          +
          -p spec…
          +
          --package spec…

          Clean only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for the SPEC format.

          @@ -34,29 +34,29 @@ multiple times. See cargo-pkgid(1) for the SPEC f
          -
          --dry-run
          +
          --dry-run

          Displays a summary of what would be deleted without deleting anything. Use with --verbose to display the actual files that would be deleted.

          -
          --doc
          +
          --doc

          This option will cause cargo clean to remove only the doc directory in the target directory.

          -
          --release
          +
          --release

          Remove all artifacts in the release directory.

          -
          --profile name
          +
          --profile name

          Remove all artifacts in the directory with the given profile name.

          -
          --target-dir directory
          +
          --target-dir directory

          Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -64,7 +64,7 @@ Defaults to target in the root of the workspace.

          -
          --target triple
          +
          --target triple

          Clean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

          Possible values:

          @@ -85,8 +85,8 @@ target artifacts are placed in a separate directory. See the ### Display Options
          -
          -v
          -
          --verbose
          +
          -v
          +
          --verbose

          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 term.verbose @@ -94,15 +94,15 @@ May also be specified with the term.verbose

          -
          -q
          -
          --quiet
          +
          -q
          +
          --quiet

          Do not print cargo log messages. May also be specified with the term.quiet config value.

          -
          --color when
          +
          --color when

          Control when colored output is used. Valid values:

          • auto (default): Automatically detect if color support is available on the @@ -119,13 +119,13 @@ terminal.
            • ### Manifest Options
            -
            --manifest-path path
            +
            --manifest-path path

            Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

            -
            --locked
            +
            --locked

            Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

            @@ -138,7 +138,7 @@ such as in CI pipelines.

            -
            --offline
            +
            --offline

            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 @@ -152,12 +152,12 @@ offline.

            -
            --frozen
            +
            --frozen

            Equivalent to specifying both --locked and --offline.

            -
            --lockfile-path PATH
            +
            --lockfile-path PATH

            Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -175,7 +175,7 @@ requires the -Z unstable-options flag to enable (see

            -
            +toolchain
            +
            +toolchain

            If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -184,14 +184,14 @@ for more information about how toolchain overrides work.

            -
            --config KEY=VALUE or PATH
            +
            --config KEY=VALUE or PATH

            Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

            -
            -C PATH
            +
            -C PATH

            Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -203,13 +203,13 @@ requires the -Z unstable-options flag to enable (see

            -
            -h
            -
            --help
            +
            -h
            +
            --help

            Prints help information.

            -
            -Z flag
            +
            -Z flag

            Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

            diff --git a/src/doc/src/commands/cargo-doc.md b/src/doc/src/commands/cargo-doc.md index 6e4600c84bd..261b581e91f 100644 --- a/src/doc/src/commands/cargo-doc.md +++ b/src/doc/src/commands/cargo-doc.md @@ -20,7 +20,7 @@ is placed in `target/doc` in rustdoc's usual format.
            -
            --open
            +
            --open

            Open the docs in a browser after building them. This will use your default browser unless you define another one in the BROWSER environment variable or use the doc.browser configuration @@ -28,12 +28,12 @@ option.

            -
            --no-deps
            +
            --no-deps

            Do not build documentation for dependencies.

            -
            --document-private-items
            +
            --document-private-items

            Include non-public items in the documentation. This will be enabled by default if documenting a binary target.

            @@ -55,8 +55,8 @@ virtual workspace will include all workspace members (equivalent to passing
            -
            -p spec…
            -
            --package spec…
            +
            -p spec…
            +
            --package spec…

            Document only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -65,17 +65,17 @@ double quotes around each pattern.

            -
            --workspace
            +
            --workspace

            Document all members in the workspace.

            -
            --all
            +
            --all

            Deprecated alias for --workspace.

            -
            --exclude SPEC…
            +
            --exclude SPEC…

            Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -98,29 +98,29 @@ the manifest settings. Using target selection options will ignore the `doc` flag and will always document the given target.

            -
            --lib
            +
            --lib

            Document the package’s library.

            -
            --bin name…
            +
            --bin name…

            Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

            -
            --bins
            +
            --bins

            Document all binary targets.

            -
            --example name…
            +
            --example name…

            Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

            -
            --examples
            +
            --examples

            Document all example targets.

            @@ -138,20 +138,20 @@ for more details.
            -
            -F features
            -
            --features features
            +
            -F features
            +
            --features features

            Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

            -
            --all-features
            +
            --all-features

            Activate all available features of all selected packages.

            -
            --no-default-features
            +
            --no-default-features

            Do not activate the default feature of the selected packages.

            @@ -162,7 +162,7 @@ be specified multiple times, which enables all specified features.

            -
            --target triple
            +
            --target triple

            Document for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

            Possible values:

            @@ -178,20 +178,20 @@ target artifacts are placed in a separate directory. See the
            -
            -r
            -
            --release
            +
            -r
            +
            --release

            Document optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

            -
            --profile name
            +
            --profile name

            Document with the given profile. See the reference for more details on profiles.

            -
            --timings=fmts
            +
            --timings=fmts

            Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -215,7 +215,7 @@ information about timing information. ### Output Options

            -
            --target-dir directory
            +
            --target-dir directory

            Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -227,8 +227,8 @@ Defaults to target in the root of the workspace.

            ### Display Options
            -
            -v
            -
            --verbose
            +
            -v
            +
            --verbose

            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 term.verbose @@ -236,15 +236,15 @@ May also be specified with the term.verbose

            -
            -q
            -
            --quiet
            +
            -q
            +
            --quiet

            Do not print cargo log messages. May also be specified with the term.quiet config value.

            -
            --color when
            +
            --color when

            Control when colored output is used. Valid values:

            • auto (default): Automatically detect if color support is available on the @@ -257,7 +257,7 @@ terminal.
            -
            --message-format fmt
            +
            --message-format fmt

            The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

              @@ -285,18 +285,18 @@ coming from rustc are still emitted. Cannot be used with human or < ### Manifest Options
              -
              --manifest-path path
              +
              --manifest-path path

              Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

              -
              --ignore-rust-version
              +
              --ignore-rust-version

              Ignore rust-version specification in packages.

              -
              --locked
              +
              --locked

              Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

              @@ -309,7 +309,7 @@ such as in CI pipelines.

              -
              --offline
              +
              --offline

              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 @@ -323,12 +323,12 @@ offline.

              -
              --frozen
              +
              --frozen

              Equivalent to specifying both --locked and --offline.

              -
              --lockfile-path PATH
              +
              --lockfile-path PATH

              Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -346,7 +346,7 @@ requires the -Z unstable-options flag to enable (see

              -
              +toolchain
              +
              +toolchain

              If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -355,14 +355,14 @@ for more information about how toolchain overrides work.

              -
              --config KEY=VALUE or PATH
              +
              --config KEY=VALUE or PATH

              Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

              -
              -C PATH
              +
              -C PATH

              Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -374,13 +374,13 @@ requires the -Z unstable-options flag to enable (see

              -
              -h
              -
              --help
              +
              -h
              +
              --help

              Prints help information.

              -
              -Z flag
              +
              -Z flag

              Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

              @@ -390,8 +390,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
              -
              -j N
              -
              --jobs N
              +
              -j N
              +
              --jobs N

              Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -400,7 +400,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

              -
              --keep-going
              +
              --keep-going

              Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

              For example if the current package depends on dependencies fails and works, diff --git a/src/doc/src/commands/cargo-fetch.md b/src/doc/src/commands/cargo-fetch.md index ba8d72a34ce..b519199175a 100644 --- a/src/doc/src/commands/cargo-fetch.md +++ b/src/doc/src/commands/cargo-fetch.md @@ -28,7 +28,7 @@ you plan to use Cargo without a network with the `--offline` flag. ### Fetch options

              -
              --target triple
              +
              --target triple

              Fetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

              Possible values:

              @@ -48,8 +48,8 @@ target artifacts are placed in a separate directory. See the ### Display Options
              -
              -v
              -
              --verbose
              +
              -v
              +
              --verbose

              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 term.verbose @@ -57,15 +57,15 @@ May also be specified with the term.verbose

              -
              -q
              -
              --quiet
              +
              -q
              +
              --quiet

              Do not print cargo log messages. May also be specified with the term.quiet config value.

              -
              --color when
              +
              --color when

              Control when colored output is used. Valid values:

              • auto (default): Automatically detect if color support is available on the @@ -82,13 +82,13 @@ terminal.
                • ### Manifest Options
                -
                --manifest-path path
                +
                --manifest-path path

                Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                -
                --locked
                +
                --locked

                Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                @@ -101,7 +101,7 @@ such as in CI pipelines.

                -
                --offline
                +
                --offline

                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 @@ -113,12 +113,12 @@ if there might be a newer version as indicated in the local copy of the index. -

                --frozen
                +
                --frozen

                Equivalent to specifying both --locked and --offline.

                -
                --lockfile-path PATH
                +
                --lockfile-path PATH

                Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -136,7 +136,7 @@ requires the -Z unstable-options flag to enable (see

                -
                +toolchain
                +
                +toolchain

                If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -145,14 +145,14 @@ for more information about how toolchain overrides work.

                -
                --config KEY=VALUE or PATH
                +
                --config KEY=VALUE or PATH

                Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                -
                -C PATH
                +
                -C PATH

                Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -164,13 +164,13 @@ requires the -Z unstable-options flag to enable (see

                -
                -h
                -
                --help
                +
                -h
                +
                --help

                Prints help information.

                -
                -Z flag
                +
                -Z flag

                Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                diff --git a/src/doc/src/commands/cargo-fix.md b/src/doc/src/commands/cargo-fix.md index 5cba8433054..954255b5fe8 100644 --- a/src/doc/src/commands/cargo-fix.md +++ b/src/doc/src/commands/cargo-fix.md @@ -67,37 +67,37 @@ with the new edition.
                -
                --broken-code
                +
                --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
                +
                --edition

                Apply changes that will update the code to the next edition. This will not update the edition in the Cargo.toml manifest, which must be updated manually after cargo fix --edition has finished.

                -
                --edition-idioms
                +
                --edition-idioms

                Apply suggestions that will update code to the preferred style for the current edition.

                -
                --allow-no-vcs
                +
                --allow-no-vcs

                Fix code even if a VCS was not detected.

                -
                --allow-dirty
                +
                --allow-dirty

                Fix code even if the working directory has changes (including staged changes).

                -
                --allow-staged
                +
                --allow-staged

                Fix code even if the working directory has staged changes.

                @@ -119,8 +119,8 @@ virtual workspace will include all workspace members (equivalent to passing
                -
                -p spec…
                -
                --package spec…
                +
                -p spec…
                +
                --package spec…

                Fix only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -129,17 +129,17 @@ double quotes around each pattern.

                -
                --workspace
                +
                --workspace

                Fix all members in the workspace.

                -
                --all
                +
                --all

                Deprecated alias for --workspace.

                -
                --exclude SPEC…
                +
                --exclude SPEC…

                Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -166,40 +166,40 @@ use single quotes or double quotes around each glob pattern.

                -
                --lib
                +
                --lib

                Fix the package’s library.

                -
                --bin name…
                +
                --bin name…

                Fix the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

                -
                --bins
                +
                --bins

                Fix all binary targets.

                -
                --example name…
                +
                --example name…

                Fix the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

                -
                --examples
                +
                --examples

                Fix all example targets.

                -
                --test name…
                +
                --test name…

                Fix the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

                -
                --tests
                +
                --tests

                Fix all targets that have the test = true 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 @@ -210,13 +210,13 @@ manifest settings for the target.

                -
                --bench name…
                +
                --bench name…

                Fix the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

                -
                --benches
                +
                --benches

                Fix all targets that have the bench = true 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 @@ -227,7 +227,7 @@ manifest settings for the target.

                -
                --all-targets
                +
                --all-targets

                Fix all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

                @@ -245,20 +245,20 @@ for more details.
                -
                -F features
                -
                --features features
                +
                -F features
                +
                --features features

                Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                -
                --all-features
                +
                --all-features

                Activate all available features of all selected packages.

                -
                --no-default-features
                +
                --no-default-features

                Do not activate the default feature of the selected packages.

                @@ -269,7 +269,7 @@ be specified multiple times, which enables all specified features.

                -
                --target triple
                +
                --target triple

                Fix for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                Possible values:

                @@ -285,14 +285,14 @@ target artifacts are placed in a separate directory. See the
                -
                -r
                -
                --release
                +
                -r
                +
                --release

                Fix optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

                -
                --profile name
                +
                --profile name

                Fix with the given profile.

                As a special case, specifying the test profile will also enable checking in test mode which will enable checking tests and enable the test cfg option. @@ -302,7 +302,7 @@ detail.

                -
                --timings=fmts
                +
                --timings=fmts

                Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -326,7 +326,7 @@ information about timing information. ### Output Options

                -
                --target-dir directory
                +
                --target-dir directory

                Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -338,8 +338,8 @@ Defaults to target in the root of the workspace.

                ### Display Options
                -
                -v
                -
                --verbose
                +
                -v
                +
                --verbose

                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 term.verbose @@ -347,15 +347,15 @@ May also be specified with the term.verbose

                -
                -q
                -
                --quiet
                +
                -q
                +
                --quiet

                Do not print cargo log messages. May also be specified with the term.quiet config value.

                -
                --color when
                +
                --color when

                Control when colored output is used. Valid values:

                • auto (default): Automatically detect if color support is available on the @@ -368,7 +368,7 @@ terminal.
                -
                --message-format fmt
                +
                --message-format fmt

                The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

                  @@ -396,18 +396,18 @@ coming from rustc are still emitted. Cannot be used with human or < ### Manifest Options
                  -
                  --manifest-path path
                  +
                  --manifest-path path

                  Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                  -
                  --ignore-rust-version
                  +
                  --ignore-rust-version

                  Ignore rust-version specification in packages.

                  -
                  --locked
                  +
                  --locked

                  Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                  @@ -420,7 +420,7 @@ such as in CI pipelines.

                  -
                  --offline
                  +
                  --offline

                  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 @@ -434,12 +434,12 @@ offline.

                  -
                  --frozen
                  +
                  --frozen

                  Equivalent to specifying both --locked and --offline.

                  -
                  --lockfile-path PATH
                  +
                  --lockfile-path PATH

                  Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -457,7 +457,7 @@ requires the -Z unstable-options flag to enable (see

                  -
                  +toolchain
                  +
                  +toolchain

                  If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -466,14 +466,14 @@ for more information about how toolchain overrides work.

                  -
                  --config KEY=VALUE or PATH
                  +
                  --config KEY=VALUE or PATH

                  Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                  -
                  -C PATH
                  +
                  -C PATH

                  Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -485,13 +485,13 @@ requires the -Z unstable-options flag to enable (see

                  -
                  -h
                  -
                  --help
                  +
                  -h
                  +
                  --help

                  Prints help information.

                  -
                  -Z flag
                  +
                  -Z flag

                  Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                  @@ -501,8 +501,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
                  -
                  -j N
                  -
                  --jobs N
                  +
                  -j N
                  +
                  --jobs N

                  Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -511,7 +511,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                  -
                  --keep-going
                  +
                  --keep-going

                  Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                  For example if the current package depends on dependencies fails and works, diff --git a/src/doc/src/commands/cargo-generate-lockfile.md b/src/doc/src/commands/cargo-generate-lockfile.md index 9b87b9363a0..bee7ef75963 100644 --- a/src/doc/src/commands/cargo-generate-lockfile.md +++ b/src/doc/src/commands/cargo-generate-lockfile.md @@ -22,8 +22,8 @@ lockfile and has more options for controlling update behavior. ### Display Options

                  -
                  -v
                  -
                  --verbose
                  +
                  -v
                  +
                  --verbose

                  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 term.verbose @@ -31,15 +31,15 @@ May also be specified with the term.verbose

                  -
                  -q
                  -
                  --quiet
                  +
                  -q
                  +
                  --quiet

                  Do not print cargo log messages. May also be specified with the term.quiet config value.

                  -
                  --color when
                  +
                  --color when

                  Control when colored output is used. Valid values:

                  • auto (default): Automatically detect if color support is available on the @@ -56,18 +56,18 @@ terminal.
                    • ### Manifest Options
                    -
                    --manifest-path path
                    +
                    --manifest-path path

                    Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                    -
                    --ignore-rust-version
                    +
                    --ignore-rust-version

                    Ignore rust-version specification in packages.

                    -
                    --locked
                    +
                    --locked

                    Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                    @@ -80,7 +80,7 @@ such as in CI pipelines.

                    -
                    --offline
                    +
                    --offline

                    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 @@ -94,12 +94,12 @@ offline.

                    -
                    --frozen
                    +
                    --frozen

                    Equivalent to specifying both --locked and --offline.

                    -
                    --lockfile-path PATH
                    +
                    --lockfile-path PATH

                    Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -117,7 +117,7 @@ requires the -Z unstable-options flag to enable (see

                    -
                    +toolchain
                    +
                    +toolchain

                    If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -126,14 +126,14 @@ for more information about how toolchain overrides work.

                    -
                    --config KEY=VALUE or PATH
                    +
                    --config KEY=VALUE or PATH

                    Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                    -
                    -C PATH
                    +
                    -C PATH

                    Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -145,13 +145,13 @@ requires the -Z unstable-options flag to enable (see

                    -
                    -h
                    -
                    --help
                    +
                    -h
                    +
                    --help

                    Prints help information.

                    -
                    -Z flag
                    +
                    -Z flag

                    Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                    diff --git a/src/doc/src/commands/cargo-info.md b/src/doc/src/commands/cargo-info.md index d3489ba3525..67291183502 100644 --- a/src/doc/src/commands/cargo-info.md +++ b/src/doc/src/commands/cargo-info.md @@ -19,7 +19,7 @@ and presents it in a human-readable format.
                    -
                    spec
                    +
                    spec

                    Fetch information about the specified package. The spec can be a package ID, see cargo-pkgid(1) for the SPEC format. If the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed. @@ -27,11 +27,11 @@ If the Cargo.lock file does not exist, it will be created. If no ve selected based on the Minimum Supported Rust Version (MSRV).

                    -
                    --index index
                    +
                    --index index

                    The URL of the registry index to use.

                    -
                    --registry registry
                    +
                    --registry registry

                    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -43,8 +43,8 @@ which is defined by the registry.default config key which defaults ### Display Options

                    -
                    -v
                    -
                    --verbose
                    +
                    -v
                    +
                    --verbose

                    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 term.verbose @@ -52,15 +52,15 @@ May also be specified with the term.verbose

                    -
                    -q
                    -
                    --quiet
                    +
                    -q
                    +
                    --quiet

                    Do not print cargo log messages. May also be specified with the term.quiet config value.

                    -
                    --color when
                    +
                    --color when

                    Control when colored output is used. Valid values:

                    • auto (default): Automatically detect if color support is available on the @@ -77,7 +77,7 @@ terminal.
                      • ### Manifest Options
                      -
                      --locked
                      +
                      --locked

                      Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                      @@ -90,7 +90,7 @@ such as in CI pipelines.

                      -
                      --offline
                      +
                      --offline

                      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 @@ -104,7 +104,7 @@ offline.

                      -
                      --frozen
                      +
                      --frozen

                      Equivalent to specifying both --locked and --offline.

                      @@ -114,7 +114,7 @@ offline.

                      -
                      +toolchain
                      +
                      +toolchain

                      If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -123,14 +123,14 @@ for more information about how toolchain overrides work.

                      -
                      --config KEY=VALUE or PATH
                      +
                      --config KEY=VALUE or PATH

                      Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                      -
                      -C PATH
                      +
                      -C PATH

                      Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -142,13 +142,13 @@ requires the -Z unstable-options flag to enable (see

                      -
                      -h
                      -
                      --help
                      +
                      -h
                      +
                      --help

                      Prints help information.

                      -
                      -Z flag
                      +
                      -Z flag

                      Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                      diff --git a/src/doc/src/commands/cargo-init.md b/src/doc/src/commands/cargo-init.md index 66bba7457c5..b94228154e1 100644 --- a/src/doc/src/commands/cargo-init.md +++ b/src/doc/src/commands/cargo-init.md @@ -29,29 +29,29 @@ a new directory.
                      -
                      --bin
                      +
                      --bin

                      Create a package with a binary target (src/main.rs). This is the default behavior.

                      -
                      --lib
                      +
                      --lib

                      Create a package with a library target (src/lib.rs).

                      -
                      --edition edition
                      +
                      --edition edition

                      Specify the Rust edition to use. Default is 2024. Possible values: 2015, 2018, 2021, 2024

                      -
                      --name name
                      +
                      --name name

                      Set the package name. Defaults to the directory name.

                      -
                      --vcs vcs
                      +
                      --vcs vcs

                      Initialize a new VCS repository for the given version control system (git, hg, pijul, or fossil) or do not initialize any version control at all (none). If not specified, defaults to git or the configuration value @@ -59,7 +59,7 @@ hg, pijul, or fossil) or do not initialize any version control at all

                      -
                      --registry registry
                      +
                      --registry registry

                      This sets the publish field in Cargo.toml to the given registry name which will restrict publishing only to that registry.

                      Registry names are defined in Cargo config files. @@ -75,8 +75,8 @@ be restricted.

                      ### Display Options
                      -
                      -v
                      -
                      --verbose
                      +
                      -v
                      +
                      --verbose

                      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 term.verbose @@ -84,15 +84,15 @@ May also be specified with the term.verbose

                      -
                      -q
                      -
                      --quiet
                      +
                      -q
                      +
                      --quiet

                      Do not print cargo log messages. May also be specified with the term.quiet config value.

                      -
                      --color when
                      +
                      --color when

                      Control when colored output is used. Valid values:

                      • auto (default): Automatically detect if color support is available on the @@ -110,7 +110,7 @@ terminal.
                        • -
                        +toolchain
                        +
                        +toolchain

                        If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -119,14 +119,14 @@ for more information about how toolchain overrides work.

                        -
                        --config KEY=VALUE or PATH
                        +
                        --config KEY=VALUE or PATH

                        Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                        -
                        -C PATH
                        +
                        -C PATH

                        Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -138,13 +138,13 @@ requires the -Z unstable-options flag to enable (see

                        -
                        -h
                        -
                        --help
                        +
                        -h
                        +
                        --help

                        Prints help information.

                        -
                        -Z flag
                        +
                        -Z flag

                        Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                        diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md index 3e731e4c15e..c98defc6174 100644 --- a/src/doc/src/commands/cargo-install.md +++ b/src/doc/src/commands/cargo-install.md @@ -90,8 +90,8 @@ will be used, beginning discovery at `$PATH/.cargo/config.toml`.
                        -
                        --vers version
                        -
                        --version version
                        +
                        --vers version
                        +
                        --version version

                        Specify a version to install. This may be a version requirement, like ~1.2, to have Cargo select the newest version from the given requirement. If the version does not @@ -101,44 +101,44 @@ treated as a caret requirement like Cargo dependencies are.

                        -
                        --git url
                        +
                        --git url

                        Git URL to install the specified crate from.

                        -
                        --branch branch
                        +
                        --branch branch

                        Branch to use when installing from git.

                        -
                        --tag tag
                        +
                        --tag tag

                        Tag to use when installing from git.

                        -
                        --rev sha
                        +
                        --rev sha

                        Specific commit to use when installing from git.

                        -
                        --path path
                        +
                        --path path

                        Filesystem path to local crate to install from.

                        -
                        --list
                        +
                        --list

                        List all installed packages and their versions.

                        -
                        -n
                        -
                        --dry-run
                        +
                        -n
                        +
                        --dry-run

                        (unstable) Perform all checks without installing.

                        -
                        -f
                        -
                        --force
                        +
                        -f
                        +
                        --force

                        Force overwriting existing crates or binaries. This can be used if a package has installed a binary with the same name as another package. This is also useful if something has changed on the system that you want to rebuild with, @@ -146,7 +146,7 @@ such as a newer version of rustc.

                        -
                        --no-track
                        +
                        --no-track

                        By default, Cargo keeps track of the installed packages with a metadata file stored in the installation root directory. This flag tells Cargo not to use or create that file. With this flag, Cargo will refuse to overwrite any existing @@ -156,32 +156,32 @@ same time.

                        -
                        --bin name…
                        +
                        --bin name…

                        Install only the specified binary.

                        -
                        --bins
                        +
                        --bins

                        Install all binaries. This is the default behavior.

                        -
                        --example name…
                        +
                        --example name…

                        Install only the specified example.

                        -
                        --examples
                        +
                        --examples

                        Install all examples.

                        -
                        --root dir
                        +
                        --root dir

                        Directory to install packages into.

                        -
                        --registry registry
                        +
                        --registry registry

                        Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -189,7 +189,7 @@ which is defined by the registry.default config key which defaults

                        -
                        --index index
                        +
                        --index index

                        The URL of the registry index to use.

                        @@ -207,20 +207,20 @@ for more details.
                        -
                        -F features
                        -
                        --features features
                        +
                        -F features
                        +
                        --features features

                        Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                        -
                        --all-features
                        +
                        --all-features

                        Activate all available features of all selected packages.

                        -
                        --no-default-features
                        +
                        --no-default-features

                        Do not activate the default feature of the selected packages.

                        @@ -231,7 +231,7 @@ be specified multiple times, which enables all specified features.

                        -
                        --target triple
                        +
                        --target triple

                        Install for the specified target architecture. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                        Possible values:

                        @@ -247,7 +247,7 @@ target artifacts are placed in a separate directory. See the
                        -
                        --target-dir directory
                        +
                        --target-dir directory

                        Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -259,19 +259,19 @@ is specified.

                        -
                        --debug
                        +
                        --debug

                        Build with the dev profile instead of the release profile. See also the --profile option for choosing a specific profile by name.

                        -
                        --profile name
                        +
                        --profile name

                        Install with the given profile. See the reference for more details on profiles.

                        -
                        --timings=fmts
                        +
                        --timings=fmts

                        Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -295,12 +295,12 @@ information about timing information. ### Manifest Options

                        -
                        --ignore-rust-version
                        +
                        --ignore-rust-version

                        Ignore rust-version specification in packages.

                        -
                        --locked
                        +
                        --locked

                        Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                        @@ -313,7 +313,7 @@ such as in CI pipelines.

                        -
                        --offline
                        +
                        --offline

                        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 @@ -327,7 +327,7 @@ offline.

                        -
                        --frozen
                        +
                        --frozen

                        Equivalent to specifying both --locked and --offline.

                        @@ -336,8 +336,8 @@ offline.

                        ### Miscellaneous Options
                        -
                        -j N
                        -
                        --jobs N
                        +
                        -j N
                        +
                        --jobs N

                        Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -346,7 +346,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                        -
                        --keep-going
                        +
                        --keep-going

                        Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                        For example if the current package depends on dependencies fails and works, @@ -361,8 +361,8 @@ builds, even if the one run first fails.

                        ### Display Options
                        -
                        -v
                        -
                        --verbose
                        +
                        -v
                        +
                        --verbose

                        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 term.verbose @@ -370,15 +370,15 @@ May also be specified with the term.verbose

                        -
                        -q
                        -
                        --quiet
                        +
                        -q
                        +
                        --quiet

                        Do not print cargo log messages. May also be specified with the term.quiet config value.

                        -
                        --color when
                        +
                        --color when

                        Control when colored output is used. Valid values:

                        • auto (default): Automatically detect if color support is available on the @@ -391,7 +391,7 @@ terminal.
                        -
                        --message-format fmt
                        +
                        --message-format fmt

                        The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

                          @@ -421,7 +421,7 @@ coming from rustc are still emitted. Cannot be used with human or <
                          -
                          +toolchain
                          +
                          +toolchain

                          If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -430,14 +430,14 @@ for more information about how toolchain overrides work.

                          -
                          --config KEY=VALUE or PATH
                          +
                          --config KEY=VALUE or PATH

                          Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                          -
                          -C PATH
                          +
                          -C PATH

                          Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -449,13 +449,13 @@ requires the -Z unstable-options flag to enable (see

                          -
                          -h
                          -
                          --help
                          +
                          -h
                          +
                          --help

                          Prints help information.

                          -
                          -Z flag
                          +
                          -Z flag

                          Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                          diff --git a/src/doc/src/commands/cargo-locate-project.md b/src/doc/src/commands/cargo-locate-project.md index 286f0380bc8..d0f24148089 100644 --- a/src/doc/src/commands/cargo-locate-project.md +++ b/src/doc/src/commands/cargo-locate-project.md @@ -23,7 +23,7 @@ locating the manifest of a workspace member.
                          -
                          --workspace
                          +
                          --workspace

                          Locate the Cargo.toml at the root of the workspace, as opposed to the current workspace member.

                          @@ -35,7 +35,7 @@ workspace member.

                          -
                          --message-format fmt
                          +
                          --message-format fmt

                          The representation in which to print the project location. Valid values:

                          • json (default): JSON object with the path under the key “root”.
                            • @@ -44,8 +44,8 @@ workspace member.

                          -
                          -v
                          -
                          --verbose
                          +
                          -v
                          +
                          --verbose

                          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 term.verbose @@ -53,15 +53,15 @@ May also be specified with the term.verbose

                          -
                          -q
                          -
                          --quiet
                          +
                          -q
                          +
                          --quiet

                          Do not print cargo log messages. May also be specified with the term.quiet config value.

                          -
                          --color when
                          +
                          --color when

                          Control when colored output is used. Valid values:

                          • auto (default): Automatically detect if color support is available on the @@ -78,7 +78,7 @@ terminal.
                            • ### Manifest Options
                            -
                            --manifest-path path
                            +
                            --manifest-path path

                            Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                            @@ -89,7 +89,7 @@ terminal.
                            -
                            +toolchain
                            +
                            +toolchain

                            If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -98,14 +98,14 @@ for more information about how toolchain overrides work.

                            -
                            --config KEY=VALUE or PATH
                            +
                            --config KEY=VALUE or PATH

                            Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                            -
                            -C PATH
                            +
                            -C PATH

                            Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -117,13 +117,13 @@ requires the -Z unstable-options flag to enable (see

                            -
                            -h
                            -
                            --help
                            +
                            -h
                            +
                            --help

                            Prints help information.

                            -
                            -Z flag
                            +
                            -Z flag

                            Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                            diff --git a/src/doc/src/commands/cargo-login.md b/src/doc/src/commands/cargo-login.md index 723912759b6..ca022310c84 100644 --- a/src/doc/src/commands/cargo-login.md +++ b/src/doc/src/commands/cargo-login.md @@ -35,7 +35,7 @@ Take care to keep the token secret, it should not be shared with anyone else. ### Login Options
                            -
                            --registry registry
                            +
                            --registry registry

                            Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -47,8 +47,8 @@ which is defined by the registry.default config key which defaults ### Display Options

                            -
                            -v
                            -
                            --verbose
                            +
                            -v
                            +
                            --verbose

                            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 term.verbose @@ -56,15 +56,15 @@ May also be specified with the term.verbose

                            -
                            -q
                            -
                            --quiet
                            +
                            -q
                            +
                            --quiet

                            Do not print cargo log messages. May also be specified with the term.quiet config value.

                            -
                            --color when
                            +
                            --color when

                            Control when colored output is used. Valid values:

                            • auto (default): Automatically detect if color support is available on the @@ -82,7 +82,7 @@ terminal.
                              • -
                              +toolchain
                              +
                              +toolchain

                              If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -91,14 +91,14 @@ for more information about how toolchain overrides work.

                              -
                              --config KEY=VALUE or PATH
                              +
                              --config KEY=VALUE or PATH

                              Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                              -
                              -C PATH
                              +
                              -C PATH

                              Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -110,13 +110,13 @@ requires the -Z unstable-options flag to enable (see

                              -
                              -h
                              -
                              --help
                              +
                              -h
                              +
                              --help

                              Prints help information.

                              -
                              -Z flag
                              +
                              -Z flag

                              Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                              diff --git a/src/doc/src/commands/cargo-logout.md b/src/doc/src/commands/cargo-logout.md index ff150fe9638..40a91fd841d 100644 --- a/src/doc/src/commands/cargo-logout.md +++ b/src/doc/src/commands/cargo-logout.md @@ -34,7 +34,7 @@ visit the registry website and follow its instructions (see ### Logout Options
                              -
                              --registry registry
                              +
                              --registry registry

                              Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -46,8 +46,8 @@ which is defined by the registry.default config key which defaults ### Display Options

                              -
                              -v
                              -
                              --verbose
                              +
                              -v
                              +
                              --verbose

                              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 term.verbose @@ -55,15 +55,15 @@ May also be specified with the term.verbose

                              -
                              -q
                              -
                              --quiet
                              +
                              -q
                              +
                              --quiet

                              Do not print cargo log messages. May also be specified with the term.quiet config value.

                              -
                              --color when
                              +
                              --color when

                              Control when colored output is used. Valid values:

                              • auto (default): Automatically detect if color support is available on the @@ -81,7 +81,7 @@ terminal.
                                • -
                                +toolchain
                                +
                                +toolchain

                                If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -90,14 +90,14 @@ for more information about how toolchain overrides work.

                                -
                                --config KEY=VALUE or PATH
                                +
                                --config KEY=VALUE or PATH

                                Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                -
                                -C PATH
                                +
                                -C PATH

                                Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -109,13 +109,13 @@ requires the -Z unstable-options flag to enable (see

                                -
                                -h
                                -
                                --help
                                +
                                -h
                                +
                                --help

                                Prints help information.

                                -
                                -Z flag
                                +
                                -Z flag

                                Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                diff --git a/src/doc/src/commands/cargo-metadata.md b/src/doc/src/commands/cargo-metadata.md index d18a734c474..9a7a3fd9529 100644 --- a/src/doc/src/commands/cargo-metadata.md +++ b/src/doc/src/commands/cargo-metadata.md @@ -349,19 +349,19 @@ Notes:
                                -
                                --no-deps
                                +
                                --no-deps

                                Output information only about the workspace members and don’t fetch dependencies.

                                -
                                --format-version version
                                +
                                --format-version version

                                Specify the version of the output format to use. Currently 1 is the only possible value.

                                -
                                --filter-platform triple
                                +
                                --filter-platform triple

                                This filters the resolve output to only include dependencies for the given target triple. Without this flag, the resolve includes all targets.

                                @@ -384,20 +384,20 @@ for more details.
                                -
                                -F features
                                -
                                --features features
                                +
                                -F features
                                +
                                --features features

                                Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                -
                                --all-features
                                +
                                --all-features

                                Activate all available features of all selected packages.

                                -
                                --no-default-features
                                +
                                --no-default-features

                                Do not activate the default feature of the selected packages.

                                @@ -407,8 +407,8 @@ be specified multiple times, which enables all specified features.

                                ### Display Options
                                -
                                -v
                                -
                                --verbose
                                +
                                -v
                                +
                                --verbose

                                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 term.verbose @@ -416,15 +416,15 @@ May also be specified with the term.verbose

                                -
                                -q
                                -
                                --quiet
                                +
                                -q
                                +
                                --quiet

                                Do not print cargo log messages. May also be specified with the term.quiet config value.

                                -
                                --color when
                                +
                                --color when

                                Control when colored output is used. Valid values:

                                • auto (default): Automatically detect if color support is available on the @@ -441,13 +441,13 @@ terminal.
                                  • ### Manifest Options
                                  -
                                  --manifest-path path
                                  +
                                  --manifest-path path

                                  Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                  -
                                  --locked
                                  +
                                  --locked

                                  Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                  @@ -460,7 +460,7 @@ such as in CI pipelines.

                                  -
                                  --offline
                                  +
                                  --offline

                                  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 @@ -474,12 +474,12 @@ offline.

                                  -
                                  --frozen
                                  +
                                  --frozen

                                  Equivalent to specifying both --locked and --offline.

                                  -
                                  --lockfile-path PATH
                                  +
                                  --lockfile-path PATH

                                  Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -497,7 +497,7 @@ requires the -Z unstable-options flag to enable (see

                                  -
                                  +toolchain
                                  +
                                  +toolchain

                                  If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -506,14 +506,14 @@ for more information about how toolchain overrides work.

                                  -
                                  --config KEY=VALUE or PATH
                                  +
                                  --config KEY=VALUE or PATH

                                  Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                  -
                                  -C PATH
                                  +
                                  -C PATH

                                  Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -525,13 +525,13 @@ requires the -Z unstable-options flag to enable (see

                                  -
                                  -h
                                  -
                                  --help
                                  +
                                  -h
                                  +
                                  --help

                                  Prints help information.

                                  -
                                  -Z flag
                                  +
                                  -Z flag

                                  Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                  diff --git a/src/doc/src/commands/cargo-new.md b/src/doc/src/commands/cargo-new.md index c4ef3c0d72a..1235c29c30b 100644 --- a/src/doc/src/commands/cargo-new.md +++ b/src/doc/src/commands/cargo-new.md @@ -24,29 +24,29 @@ in an existing directory.
                                  -
                                  --bin
                                  +
                                  --bin

                                  Create a package with a binary target (src/main.rs). This is the default behavior.

                                  -
                                  --lib
                                  +
                                  --lib

                                  Create a package with a library target (src/lib.rs).

                                  -
                                  --edition edition
                                  +
                                  --edition edition

                                  Specify the Rust edition to use. Default is 2024. Possible values: 2015, 2018, 2021, 2024

                                  -
                                  --name name
                                  +
                                  --name name

                                  Set the package name. Defaults to the directory name.

                                  -
                                  --vcs vcs
                                  +
                                  --vcs vcs

                                  Initialize a new VCS repository for the given version control system (git, hg, pijul, or fossil) or do not initialize any version control at all (none). If not specified, defaults to git or the configuration value @@ -54,7 +54,7 @@ hg, pijul, or fossil) or do not initialize any version control at all

                                  -
                                  --registry registry
                                  +
                                  --registry registry

                                  This sets the publish field in Cargo.toml to the given registry name which will restrict publishing only to that registry.

                                  Registry names are defined in Cargo config files. @@ -70,8 +70,8 @@ be restricted.

                                  ### Display Options
                                  -
                                  -v
                                  -
                                  --verbose
                                  +
                                  -v
                                  +
                                  --verbose

                                  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 term.verbose @@ -79,15 +79,15 @@ May also be specified with the term.verbose

                                  -
                                  -q
                                  -
                                  --quiet
                                  +
                                  -q
                                  +
                                  --quiet

                                  Do not print cargo log messages. May also be specified with the term.quiet config value.

                                  -
                                  --color when
                                  +
                                  --color when

                                  Control when colored output is used. Valid values:

                                  • auto (default): Automatically detect if color support is available on the @@ -105,7 +105,7 @@ terminal.
                                    • -
                                    +toolchain
                                    +
                                    +toolchain

                                    If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -114,14 +114,14 @@ for more information about how toolchain overrides work.

                                    -
                                    --config KEY=VALUE or PATH
                                    +
                                    --config KEY=VALUE or PATH

                                    Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                    -
                                    -C PATH
                                    +
                                    -C PATH

                                    Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -133,13 +133,13 @@ requires the -Z unstable-options flag to enable (see

                                    -
                                    -h
                                    -
                                    --help
                                    +
                                    -h
                                    +
                                    --help

                                    Prints help information.

                                    -
                                    -Z flag
                                    +
                                    -Z flag

                                    Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                    diff --git a/src/doc/src/commands/cargo-owner.md b/src/doc/src/commands/cargo-owner.md index f8c6ff49403..1b8a7f96ddc 100644 --- a/src/doc/src/commands/cargo-owner.md +++ b/src/doc/src/commands/cargo-owner.md @@ -31,25 +31,25 @@ information about owners and publishing.
                                    -
                                    -a
                                    -
                                    --add login…
                                    +
                                    -a
                                    +
                                    --add login…

                                    Invite the given user or team as an owner.

                                    -
                                    -r
                                    -
                                    --remove login…
                                    +
                                    -r
                                    +
                                    --remove login…

                                    Remove the given user or team as an owner.

                                    -
                                    -l
                                    -
                                    --list
                                    +
                                    -l
                                    +
                                    --list

                                    List owners of a crate.

                                    -
                                    --token token
                                    +
                                    --token token

                                    API token to use when authenticating. This overrides the token stored in the credentials file (which is created by cargo-login(1)).

                                    Cargo config environment variables can be @@ -61,12 +61,12 @@ of the registry in all capital letters.

                                    -
                                    --index index
                                    +
                                    --index index

                                    The URL of the registry index to use.

                                    -
                                    --registry registry
                                    +
                                    --registry registry

                                    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -79,8 +79,8 @@ which is defined by the registry.default config key which defaults ### Display Options

                                    -
                                    -v
                                    -
                                    --verbose
                                    +
                                    -v
                                    +
                                    --verbose

                                    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 term.verbose @@ -88,15 +88,15 @@ May also be specified with the term.verbose

                                    -
                                    -q
                                    -
                                    --quiet
                                    +
                                    -q
                                    +
                                    --quiet

                                    Do not print cargo log messages. May also be specified with the term.quiet config value.

                                    -
                                    --color when
                                    +
                                    --color when

                                    Control when colored output is used. Valid values:

                                    • auto (default): Automatically detect if color support is available on the @@ -114,7 +114,7 @@ terminal.
                                      • -
                                      +toolchain
                                      +
                                      +toolchain

                                      If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -123,14 +123,14 @@ for more information about how toolchain overrides work.

                                      -
                                      --config KEY=VALUE or PATH
                                      +
                                      --config KEY=VALUE or PATH

                                      Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                      -
                                      -C PATH
                                      +
                                      -C PATH

                                      Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -142,13 +142,13 @@ requires the -Z unstable-options flag to enable (see

                                      -
                                      -h
                                      -
                                      --help
                                      +
                                      -h
                                      +
                                      --help

                                      Prints help information.

                                      -
                                      -Z flag
                                      +
                                      -Z flag

                                      Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                      diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index cf9ae1213a7..d8bf868e9f2 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -76,29 +76,29 @@ There is no guarantee that the source code in the tarball matches the VCS inform
                                      -
                                      -l
                                      -
                                      --list
                                      +
                                      -l
                                      +
                                      --list

                                      Print files included in a package without making one.

                                      -
                                      --no-verify
                                      +
                                      --no-verify

                                      Don’t verify the contents by building them.

                                      -
                                      --no-metadata
                                      +
                                      --no-metadata

                                      Ignore warnings about a lack of human-usable metadata (such as the description or the license).

                                      -
                                      --allow-dirty
                                      +
                                      --allow-dirty

                                      Allow working directories with uncommitted VCS changes to be packaged.

                                      -
                                      --exclude-lockfile
                                      +
                                      --exclude-lockfile

                                      Don’t include the lock file when packaging.

                                      This flag is not for general use. Some tools may expect a lock file to be present (e.g. cargo install --locked). @@ -106,12 +106,12 @@ Consider other options before using this.

                                      -
                                      --index index
                                      +
                                      --index index

                                      The URL of the registry index to use.

                                      -
                                      --registry registry
                                      +
                                      --registry registry

                                      Name of the registry to package for; see cargo publish --help for more details about configuration of registry names. The packages will not be published to this registry, but if we are packaging multiple inter-dependent crates, @@ -120,7 +120,7 @@ published to this registry.

                                      -
                                      --message-format fmt
                                      +
                                      --message-format fmt

                                      Specifies the output message format. Currently, it only works with --list and affects the file listing format. This is unstable and requires -Zunstable-options. @@ -181,8 +181,8 @@ virtual workspace will include all workspace members (equivalent to passing

                                      -
                                      -p spec…
                                      -
                                      --package spec…
                                      +
                                      -p spec…
                                      +
                                      --package spec…

                                      Package only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -191,13 +191,13 @@ double quotes around each pattern.

                                      -
                                      --workspace
                                      +
                                      --workspace

                                      Package all members in the workspace.

                                      -
                                      --exclude SPEC…
                                      +
                                      --exclude SPEC…

                                      Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -212,7 +212,7 @@ single quotes or double quotes around each pattern.

                                      -
                                      --target triple
                                      +
                                      --target triple

                                      Package for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                                      Possible values:

                                      @@ -228,7 +228,7 @@ target artifacts are placed in a separate directory. See the
                                      -
                                      --target-dir directory
                                      +
                                      --target-dir directory

                                      Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -249,20 +249,20 @@ for more details.

                                      -
                                      -F features
                                      -
                                      --features features
                                      +
                                      -F features
                                      +
                                      --features features

                                      Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                      -
                                      --all-features
                                      +
                                      --all-features

                                      Activate all available features of all selected packages.

                                      -
                                      --no-default-features
                                      +
                                      --no-default-features

                                      Do not activate the default feature of the selected packages.

                                      @@ -273,13 +273,13 @@ be specified multiple times, which enables all specified features.

                                      -
                                      --manifest-path path
                                      +
                                      --manifest-path path

                                      Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                      -
                                      --locked
                                      +
                                      --locked

                                      Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                      @@ -292,7 +292,7 @@ such as in CI pipelines.

                                      -
                                      --offline
                                      +
                                      --offline

                                      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 @@ -306,12 +306,12 @@ offline.

                                      -
                                      --frozen
                                      +
                                      --frozen

                                      Equivalent to specifying both --locked and --offline.

                                      -
                                      --lockfile-path PATH
                                      +
                                      --lockfile-path PATH

                                      Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -329,8 +329,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options

                                      -
                                      -j N
                                      -
                                      --jobs N
                                      +
                                      -j N
                                      +
                                      --jobs N

                                      Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -339,7 +339,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                                      -
                                      --keep-going
                                      +
                                      --keep-going

                                      Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                                      For example if the current package depends on dependencies fails and works, @@ -354,8 +354,8 @@ builds, even if the one run first fails.

                                      ### Display Options
                                      -
                                      -v
                                      -
                                      --verbose
                                      +
                                      -v
                                      +
                                      --verbose

                                      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 term.verbose @@ -363,15 +363,15 @@ May also be specified with the term.verbose

                                      -
                                      -q
                                      -
                                      --quiet
                                      +
                                      -q
                                      +
                                      --quiet

                                      Do not print cargo log messages. May also be specified with the term.quiet config value.

                                      -
                                      --color when
                                      +
                                      --color when

                                      Control when colored output is used. Valid values:

                                      • auto (default): Automatically detect if color support is available on the @@ -389,7 +389,7 @@ terminal.
                                        • -
                                        +toolchain
                                        +
                                        +toolchain

                                        If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -398,14 +398,14 @@ for more information about how toolchain overrides work.

                                        -
                                        --config KEY=VALUE or PATH
                                        +
                                        --config KEY=VALUE or PATH

                                        Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                        -
                                        -C PATH
                                        +
                                        -C PATH

                                        Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -417,13 +417,13 @@ requires the -Z unstable-options flag to enable (see

                                        -
                                        -h
                                        -
                                        --help
                                        +
                                        -h
                                        +
                                        --help

                                        Prints help information.

                                        -
                                        -Z flag
                                        +
                                        -Z flag

                                        Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                        diff --git a/src/doc/src/commands/cargo-pkgid.md b/src/doc/src/commands/cargo-pkgid.md index 1ad97bd92e6..31b02cf5ae8 100644 --- a/src/doc/src/commands/cargo-pkgid.md +++ b/src/doc/src/commands/cargo-pkgid.md @@ -43,8 +43,8 @@ The specification grammar can be found in chapter [Package ID Specifications].
                                        -
                                        -p spec
                                        -
                                        --package spec
                                        +
                                        -p spec
                                        +
                                        --package spec

                                        Get the package ID for the given package instead of the current package.

                                        @@ -54,8 +54,8 @@ The specification grammar can be found in chapter [Package ID Specifications]. ### Display Options
                                        -
                                        -v
                                        -
                                        --verbose
                                        +
                                        -v
                                        +
                                        --verbose

                                        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 term.verbose @@ -63,15 +63,15 @@ May also be specified with the term.verbose

                                        -
                                        -q
                                        -
                                        --quiet
                                        +
                                        -q
                                        +
                                        --quiet

                                        Do not print cargo log messages. May also be specified with the term.quiet config value.

                                        -
                                        --color when
                                        +
                                        --color when

                                        Control when colored output is used. Valid values:

                                        • auto (default): Automatically detect if color support is available on the @@ -89,13 +89,13 @@ terminal.
                                          • -
                                          --manifest-path path
                                          +
                                          --manifest-path path

                                          Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                          -
                                          --locked
                                          +
                                          --locked

                                          Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                          @@ -108,7 +108,7 @@ such as in CI pipelines.

                                          -
                                          --offline
                                          +
                                          --offline

                                          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 @@ -122,12 +122,12 @@ offline.

                                          -
                                          --frozen
                                          +
                                          --frozen

                                          Equivalent to specifying both --locked and --offline.

                                          -
                                          --lockfile-path PATH
                                          +
                                          --lockfile-path PATH

                                          Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -146,7 +146,7 @@ requires the -Z unstable-options flag to enable (see

                                          -
                                          +toolchain
                                          +
                                          +toolchain

                                          If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -155,14 +155,14 @@ for more information about how toolchain overrides work.

                                          -
                                          --config KEY=VALUE or PATH
                                          +
                                          --config KEY=VALUE or PATH

                                          Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                          -
                                          -C PATH
                                          +
                                          -C PATH

                                          Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -174,13 +174,13 @@ requires the -Z unstable-options flag to enable (see

                                          -
                                          -h
                                          -
                                          --help
                                          +
                                          -h
                                          +
                                          --help

                                          Prints help information.

                                          -
                                          -Z flag
                                          +
                                          -Z flag

                                          Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                          diff --git a/src/doc/src/commands/cargo-publish.md b/src/doc/src/commands/cargo-publish.md index 4bc2f608cd1..36247a01e38 100644 --- a/src/doc/src/commands/cargo-publish.md +++ b/src/doc/src/commands/cargo-publish.md @@ -37,27 +37,27 @@ packaging and publishing.
                                          -
                                          --dry-run
                                          +
                                          --dry-run

                                          Perform all checks without uploading.

                                          -
                                          --no-verify
                                          +
                                          --no-verify

                                          Don’t verify the contents by building them.

                                          -
                                          --allow-dirty
                                          +
                                          --allow-dirty

                                          Allow working directories with uncommitted VCS changes to be packaged.

                                          -
                                          --index index
                                          +
                                          --index index

                                          The URL of the registry index to use.

                                          -
                                          --registry registry
                                          +
                                          --registry registry

                                          Name of the registry to publish to. Registry names are defined in Cargo config files. If not specified, and there is a package.publish field in @@ -85,8 +85,8 @@ virtual workspace will include all workspace members (equivalent to passing

                                          -
                                          -p spec…
                                          -
                                          --package spec…
                                          +
                                          -p spec…
                                          +
                                          --package spec…

                                          Publish only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -95,17 +95,17 @@ double quotes around each pattern.

                                          -
                                          --workspace
                                          +
                                          --workspace

                                          Publish all members in the workspace.

                                          -
                                          --all
                                          +
                                          --all

                                          Deprecated alias for --workspace.

                                          -
                                          --exclude SPEC…
                                          +
                                          --exclude SPEC…

                                          Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -120,7 +120,7 @@ single quotes or double quotes around each pattern.

                                          -
                                          --target triple
                                          +
                                          --target triple

                                          Publish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                                          Possible values:

                                          @@ -136,7 +136,7 @@ target artifacts are placed in a separate directory. See the
                                          -
                                          --target-dir directory
                                          +
                                          --target-dir directory

                                          Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -157,20 +157,20 @@ for more details.

                                          -
                                          -F features
                                          -
                                          --features features
                                          +
                                          -F features
                                          +
                                          --features features

                                          Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                          -
                                          --all-features
                                          +
                                          --all-features

                                          Activate all available features of all selected packages.

                                          -
                                          --no-default-features
                                          +
                                          --no-default-features

                                          Do not activate the default feature of the selected packages.

                                          @@ -181,13 +181,13 @@ be specified multiple times, which enables all specified features.

                                          -
                                          --manifest-path path
                                          +
                                          --manifest-path path

                                          Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                          -
                                          --locked
                                          +
                                          --locked

                                          Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                          @@ -200,7 +200,7 @@ such as in CI pipelines.

                                          -
                                          --offline
                                          +
                                          --offline

                                          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 @@ -214,12 +214,12 @@ offline.

                                          -
                                          --frozen
                                          +
                                          --frozen

                                          Equivalent to specifying both --locked and --offline.

                                          -
                                          --lockfile-path PATH
                                          +
                                          --lockfile-path PATH

                                          Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -237,8 +237,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options

                                          -
                                          -j N
                                          -
                                          --jobs N
                                          +
                                          -j N
                                          +
                                          --jobs N

                                          Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -247,7 +247,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                                          -
                                          --keep-going
                                          +
                                          --keep-going

                                          Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                                          For example if the current package depends on dependencies fails and works, @@ -262,8 +262,8 @@ builds, even if the one run first fails.

                                          ### Display Options
                                          -
                                          -v
                                          -
                                          --verbose
                                          +
                                          -v
                                          +
                                          --verbose

                                          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 term.verbose @@ -271,15 +271,15 @@ May also be specified with the term.verbose

                                          -
                                          -q
                                          -
                                          --quiet
                                          +
                                          -q
                                          +
                                          --quiet

                                          Do not print cargo log messages. May also be specified with the term.quiet config value.

                                          -
                                          --color when
                                          +
                                          --color when

                                          Control when colored output is used. Valid values:

                                          • auto (default): Automatically detect if color support is available on the @@ -297,7 +297,7 @@ terminal.
                                            • -
                                            +toolchain
                                            +
                                            +toolchain

                                            If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -306,14 +306,14 @@ for more information about how toolchain overrides work.

                                            -
                                            --config KEY=VALUE or PATH
                                            +
                                            --config KEY=VALUE or PATH

                                            Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                            -
                                            -C PATH
                                            +
                                            -C PATH

                                            Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -325,13 +325,13 @@ requires the -Z unstable-options flag to enable (see

                                            -
                                            -h
                                            -
                                            --help
                                            +
                                            -h
                                            +
                                            --help

                                            Prints help information.

                                            -
                                            -Z flag
                                            +
                                            -Z flag

                                            Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                            diff --git a/src/doc/src/commands/cargo-remove.md b/src/doc/src/commands/cargo-remove.md index 32f46c9bf1c..6634e287266 100644 --- a/src/doc/src/commands/cargo-remove.md +++ b/src/doc/src/commands/cargo-remove.md @@ -17,17 +17,17 @@ Remove one or more dependencies from a `Cargo.toml` manifest.
                                            -
                                            --dev
                                            +
                                            --dev

                                            Remove as a development dependency.

                                            -
                                            --build
                                            +
                                            --build

                                            Remove as a build dependency.

                                            -
                                            --target target
                                            +
                                            --target target

                                            Remove as a dependency to the given target platform.

                                            To avoid unexpected shell expansions, you may use quotes around each target, e.g., --target 'cfg(unix)'.

                                            @@ -39,7 +39,7 @@ Remove one or more dependencies from a `Cargo.toml` manifest.
                                            -
                                            --dry-run
                                            +
                                            --dry-run

                                            Don’t actually write to the manifest.

                                            @@ -49,8 +49,8 @@ Remove one or more dependencies from a `Cargo.toml` manifest. ### Display Options
                                            -
                                            -v
                                            -
                                            --verbose
                                            +
                                            -v
                                            +
                                            --verbose

                                            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 term.verbose @@ -58,15 +58,15 @@ May also be specified with the term.verbose

                                            -
                                            -q
                                            -
                                            --quiet
                                            +
                                            -q
                                            +
                                            --quiet

                                            Do not print cargo log messages. May also be specified with the term.quiet config value.

                                            -
                                            --color when
                                            +
                                            --color when

                                            Control when colored output is used. Valid values:

                                            • auto (default): Automatically detect if color support is available on the @@ -83,13 +83,13 @@ terminal.
                                              • ### Manifest Options
                                              -
                                              --manifest-path path
                                              +
                                              --manifest-path path

                                              Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                              -
                                              --locked
                                              +
                                              --locked

                                              Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                              @@ -102,7 +102,7 @@ such as in CI pipelines.

                                              -
                                              --offline
                                              +
                                              --offline

                                              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 @@ -116,12 +116,12 @@ offline.

                                              -
                                              --frozen
                                              +
                                              --frozen

                                              Equivalent to specifying both --locked and --offline.

                                              -
                                              --lockfile-path PATH
                                              +
                                              --lockfile-path PATH

                                              Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -139,8 +139,8 @@ requires the -Z unstable-options flag to enable (see

                                              -
                                              -p spec…
                                              -
                                              --package spec…
                                              +
                                              -p spec…
                                              +
                                              --package spec…

                                              Package to remove from.

                                              @@ -151,7 +151,7 @@ requires the -Z unstable-options flag to enable (see
                                              -
                                              +toolchain
                                              +
                                              +toolchain

                                              If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -160,14 +160,14 @@ for more information about how toolchain overrides work.

                                              -
                                              --config KEY=VALUE or PATH
                                              +
                                              --config KEY=VALUE or PATH

                                              Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                              -
                                              -C PATH
                                              +
                                              -C PATH

                                              Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -179,13 +179,13 @@ requires the -Z unstable-options flag to enable (see

                                              -
                                              -h
                                              -
                                              --help
                                              +
                                              -h
                                              +
                                              --help

                                              Prints help information.

                                              -
                                              -Z flag
                                              +
                                              -Z flag

                                              Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                              diff --git a/src/doc/src/commands/cargo-report.md b/src/doc/src/commands/cargo-report.md index c05cfbbff94..f7553b14c73 100644 --- a/src/doc/src/commands/cargo-report.md +++ b/src/doc/src/commands/cargo-report.md @@ -16,13 +16,13 @@ Displays a report of the given _type_ --- currently, only `future-incompat` is s
                                              -
                                              --id id
                                              +
                                              --id id

                                              Show the report with the specified Cargo-generated id

                                              -
                                              -p spec…
                                              -
                                              --package spec…
                                              +
                                              -p spec…
                                              +
                                              --package spec…

                                              Only display a report for the specified package

                                              diff --git a/src/doc/src/commands/cargo-run.md b/src/doc/src/commands/cargo-run.md index 31722c951e6..8fd777b0bd8 100644 --- a/src/doc/src/commands/cargo-run.md +++ b/src/doc/src/commands/cargo-run.md @@ -28,8 +28,8 @@ flag can be used to choose a different package in a workspace.
                                              -
                                              -p spec
                                              -
                                              --package spec
                                              +
                                              -p spec
                                              +
                                              --package spec

                                              The package to run. See cargo-pkgid(1) for the SPEC format.

                                              @@ -46,12 +46,12 @@ section of `Cargo.toml` to choose the name of the binary to run by default.
                                              -
                                              --bin name
                                              +
                                              --bin name

                                              Run the specified binary.

                                              -
                                              --example name
                                              +
                                              --example name

                                              Run the specified example.

                                              @@ -69,20 +69,20 @@ for more details.
                                              -
                                              -F features
                                              -
                                              --features features
                                              +
                                              -F features
                                              +
                                              --features features

                                              Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                              -
                                              --all-features
                                              +
                                              --all-features

                                              Activate all available features of all selected packages.

                                              -
                                              --no-default-features
                                              +
                                              --no-default-features

                                              Do not activate the default feature of the selected packages.

                                              @@ -93,7 +93,7 @@ be specified multiple times, which enables all specified features.

                                              -
                                              --target triple
                                              +
                                              --target triple

                                              Run for the specified target architecture. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                                              Possible values:

                                              @@ -109,20 +109,20 @@ target artifacts are placed in a separate directory. See the
                                              -
                                              -r
                                              -
                                              --release
                                              +
                                              -r
                                              +
                                              --release

                                              Run optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

                                              -
                                              --profile name
                                              +
                                              --profile name

                                              Run with the given profile. See the reference for more details on profiles.

                                              -
                                              --timings=fmts
                                              +
                                              --timings=fmts

                                              Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -146,7 +146,7 @@ information about timing information. ### Output Options

                                              -
                                              --target-dir directory
                                              +
                                              --target-dir directory

                                              Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -159,8 +159,8 @@ Defaults to target in the root of the workspace.

                                              -
                                              -v
                                              -
                                              --verbose
                                              +
                                              -v
                                              +
                                              --verbose

                                              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 term.verbose @@ -168,15 +168,15 @@ May also be specified with the term.verbose

                                              -
                                              -q
                                              -
                                              --quiet
                                              +
                                              -q
                                              +
                                              --quiet

                                              Do not print cargo log messages. May also be specified with the term.quiet config value.

                                              -
                                              --color when
                                              +
                                              --color when

                                              Control when colored output is used. Valid values:

                                              • auto (default): Automatically detect if color support is available on the @@ -189,7 +189,7 @@ terminal.
                                              -
                                              --message-format fmt
                                              +
                                              --message-format fmt

                                              The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

                                                @@ -219,18 +219,18 @@ coming from rustc are still emitted. Cannot be used with human or <
                                                -
                                                --manifest-path path
                                                +
                                                --manifest-path path

                                                Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                -
                                                --ignore-rust-version
                                                +
                                                --ignore-rust-version

                                                Ignore rust-version specification in packages.

                                                -
                                                --locked
                                                +
                                                --locked

                                                Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                @@ -243,7 +243,7 @@ such as in CI pipelines.

                                                -
                                                --offline
                                                +
                                                --offline

                                                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 @@ -257,12 +257,12 @@ offline.

                                                -
                                                --frozen
                                                +
                                                --frozen

                                                Equivalent to specifying both --locked and --offline.

                                                -
                                                --lockfile-path PATH
                                                +
                                                --lockfile-path PATH

                                                Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -281,7 +281,7 @@ requires the -Z unstable-options flag to enable (see

                                                -
                                                +toolchain
                                                +
                                                +toolchain

                                                If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -290,14 +290,14 @@ for more information about how toolchain overrides work.

                                                -
                                                --config KEY=VALUE or PATH
                                                +
                                                --config KEY=VALUE or PATH

                                                Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                -
                                                -C PATH
                                                +
                                                -C PATH

                                                Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -309,13 +309,13 @@ requires the -Z unstable-options flag to enable (see

                                                -
                                                -h
                                                -
                                                --help
                                                +
                                                -h
                                                +
                                                --help

                                                Prints help information.

                                                -
                                                -Z flag
                                                +
                                                -Z flag

                                                Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                @@ -325,8 +325,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
                                                -
                                                -j N
                                                -
                                                --jobs N
                                                +
                                                -j N
                                                +
                                                --jobs N

                                                Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -335,7 +335,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                                                -
                                                --keep-going
                                                +
                                                --keep-going

                                                Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                                                For example if the current package depends on dependencies fails and works, diff --git a/src/doc/src/commands/cargo-rustc.md b/src/doc/src/commands/cargo-rustc.md index af33eb38ee4..4c9c73ccbac 100644 --- a/src/doc/src/commands/cargo-rustc.md +++ b/src/doc/src/commands/cargo-rustc.md @@ -37,8 +37,8 @@ flag can be used to choose a different package in a workspace.

                                                -
                                                -p spec
                                                -
                                                --package spec
                                                +
                                                -p spec
                                                +
                                                --package spec

                                                The package to build. See cargo-pkgid(1) for the SPEC format.

                                                @@ -70,40 +70,40 @@ use single quotes or double quotes around each glob pattern.
                                                -
                                                --lib
                                                +
                                                --lib

                                                Build the package’s library.

                                                -
                                                --bin name…
                                                +
                                                --bin name…

                                                Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

                                                -
                                                --bins
                                                +
                                                --bins

                                                Build all binary targets.

                                                -
                                                --example name…
                                                +
                                                --example name…

                                                Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

                                                -
                                                --examples
                                                +
                                                --examples

                                                Build all example targets.

                                                -
                                                --test name…
                                                +
                                                --test name…

                                                Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

                                                -
                                                --tests
                                                +
                                                --tests

                                                Build all targets that have the test = true 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 @@ -114,13 +114,13 @@ manifest settings for the target.

                                                -
                                                --bench name…
                                                +
                                                --bench name…

                                                Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

                                                -
                                                --benches
                                                +
                                                --benches

                                                Build all targets that have the bench = true 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 @@ -131,7 +131,7 @@ manifest settings for the target.

                                                -
                                                --all-targets
                                                +
                                                --all-targets

                                                Build all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

                                                @@ -149,20 +149,20 @@ for more details.
                                                -
                                                -F features
                                                -
                                                --features features
                                                +
                                                -F features
                                                +
                                                --features features

                                                Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                                -
                                                --all-features
                                                +
                                                --all-features

                                                Activate all available features of all selected packages.

                                                -
                                                --no-default-features
                                                +
                                                --no-default-features

                                                Do not activate the default feature of the selected packages.

                                                @@ -173,7 +173,7 @@ be specified multiple times, which enables all specified features.

                                                -
                                                --target triple
                                                +
                                                --target triple

                                                Build for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                                                Possible values:

                                                @@ -189,14 +189,14 @@ target artifacts are placed in a separate directory. See the
                                                -
                                                -r
                                                -
                                                --release
                                                +
                                                -r
                                                +
                                                --release

                                                Build optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

                                                -
                                                --profile name
                                                +
                                                --profile name

                                                Build with the given profile.

                                                The rustc subcommand will treat the following named profiles with special behaviors:

                                                  @@ -213,7 +213,7 @@ similar to the test profile.
                                                -
                                                --timings=fmts
                                                +
                                                --timings=fmts

                                                Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -232,7 +232,7 @@ information about timing information. -

                                                --crate-type crate-type
                                                +
                                                --crate-type crate-type

                                                Build for the given crate type. This flag accepts a comma-separated list of 1 or more crate types, of which the allowed values are the same as crate-type field in the manifest for configuring a Cargo target. See @@ -249,7 +249,7 @@ the command-line argument value will override what is in the manifest.

                                                ### Output Options
                                                -
                                                --target-dir directory
                                                +
                                                --target-dir directory

                                                Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -262,8 +262,8 @@ Defaults to target in the root of the workspace.

                                                -
                                                -v
                                                -
                                                --verbose
                                                +
                                                -v
                                                +
                                                --verbose

                                                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 term.verbose @@ -271,15 +271,15 @@ May also be specified with the term.verbose

                                                -
                                                -q
                                                -
                                                --quiet
                                                +
                                                -q
                                                +
                                                --quiet

                                                Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                -
                                                --color when
                                                +
                                                --color when

                                                Control when colored output is used. Valid values:

                                                • auto (default): Automatically detect if color support is available on the @@ -292,7 +292,7 @@ terminal.
                                                -
                                                --message-format fmt
                                                +
                                                --message-format fmt

                                                The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

                                                  @@ -322,18 +322,18 @@ coming from rustc are still emitted. Cannot be used with human or <
                                                  -
                                                  --manifest-path path
                                                  +
                                                  --manifest-path path

                                                  Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                  -
                                                  --ignore-rust-version
                                                  +
                                                  --ignore-rust-version

                                                  Ignore rust-version specification in packages.

                                                  -
                                                  --locked
                                                  +
                                                  --locked

                                                  Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                  @@ -346,7 +346,7 @@ such as in CI pipelines.

                                                  -
                                                  --offline
                                                  +
                                                  --offline

                                                  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 @@ -360,12 +360,12 @@ offline.

                                                  -
                                                  --frozen
                                                  +
                                                  --frozen

                                                  Equivalent to specifying both --locked and --offline.

                                                  -
                                                  --lockfile-path PATH
                                                  +
                                                  --lockfile-path PATH

                                                  Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -384,7 +384,7 @@ requires the -Z unstable-options flag to enable (see

                                                  -
                                                  +toolchain
                                                  +
                                                  +toolchain

                                                  If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -393,14 +393,14 @@ for more information about how toolchain overrides work.

                                                  -
                                                  --config KEY=VALUE or PATH
                                                  +
                                                  --config KEY=VALUE or PATH

                                                  Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                  -
                                                  -C PATH
                                                  +
                                                  -C PATH

                                                  Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -412,13 +412,13 @@ requires the -Z unstable-options flag to enable (see

                                                  -
                                                  -h
                                                  -
                                                  --help
                                                  +
                                                  -h
                                                  +
                                                  --help

                                                  Prints help information.

                                                  -
                                                  -Z flag
                                                  +
                                                  -Z flag

                                                  Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                  @@ -428,8 +428,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
                                                  -
                                                  -j N
                                                  -
                                                  --jobs N
                                                  +
                                                  -j N
                                                  +
                                                  --jobs N

                                                  Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -438,7 +438,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                                                  -
                                                  --keep-going
                                                  +
                                                  --keep-going

                                                  Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                                                  For example if the current package depends on dependencies fails and works, @@ -448,7 +448,7 @@ first), whereas cargo rustc -j1 --keep-going would definitely run b builds, even if the one run first fails.

                                                  -
                                                  --future-incompat-report
                                                  +
                                                  --future-incompat-report

                                                  Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

                                                  See cargo-report(1)

                                                  diff --git a/src/doc/src/commands/cargo-rustdoc.md b/src/doc/src/commands/cargo-rustdoc.md index ebb8b7b6358..d2b7e582cf8 100644 --- a/src/doc/src/commands/cargo-rustdoc.md +++ b/src/doc/src/commands/cargo-rustdoc.md @@ -34,7 +34,7 @@ or the `build.rustdocflags` [config value](../reference/config.html).
                                                  -
                                                  --open
                                                  +
                                                  --open

                                                  Open the docs in a browser after building them. This will use your default browser unless you define another one in the BROWSER environment variable or use the doc.browser configuration @@ -51,8 +51,8 @@ flag can be used to choose a different package in a workspace.

                                                  -
                                                  -p spec
                                                  -
                                                  --package spec
                                                  +
                                                  -p spec
                                                  +
                                                  --package spec

                                                  The package to document. See cargo-pkgid(1) for the SPEC format.

                                                  @@ -77,40 +77,40 @@ use single quotes or double quotes around each glob pattern.
                                                  -
                                                  --lib
                                                  +
                                                  --lib

                                                  Document the package’s library.

                                                  -
                                                  --bin name…
                                                  +
                                                  --bin name…

                                                  Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

                                                  -
                                                  --bins
                                                  +
                                                  --bins

                                                  Document all binary targets.

                                                  -
                                                  --example name…
                                                  +
                                                  --example name…

                                                  Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

                                                  -
                                                  --examples
                                                  +
                                                  --examples

                                                  Document all example targets.

                                                  -
                                                  --test name…
                                                  +
                                                  --test name…

                                                  Document the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

                                                  -
                                                  --tests
                                                  +
                                                  --tests

                                                  Document all targets that have the test = true 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 @@ -121,13 +121,13 @@ manifest settings for the target.

                                                  -
                                                  --bench name…
                                                  +
                                                  --bench name…

                                                  Document the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

                                                  -
                                                  --benches
                                                  +
                                                  --benches

                                                  Document all targets that have the bench = true 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 @@ -138,7 +138,7 @@ manifest settings for the target.

                                                  -
                                                  --all-targets
                                                  +
                                                  --all-targets

                                                  Document all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

                                                  @@ -156,20 +156,20 @@ for more details.
                                                  -
                                                  -F features
                                                  -
                                                  --features features
                                                  +
                                                  -F features
                                                  +
                                                  --features features

                                                  Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                                  -
                                                  --all-features
                                                  +
                                                  --all-features

                                                  Activate all available features of all selected packages.

                                                  -
                                                  --no-default-features
                                                  +
                                                  --no-default-features

                                                  Do not activate the default feature of the selected packages.

                                                  @@ -180,7 +180,7 @@ be specified multiple times, which enables all specified features.

                                                  -
                                                  --target triple
                                                  +
                                                  --target triple

                                                  Document for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                                                  Possible values:

                                                  @@ -196,20 +196,20 @@ target artifacts are placed in a separate directory. See the
                                                  -
                                                  -r
                                                  -
                                                  --release
                                                  +
                                                  -r
                                                  +
                                                  --release

                                                  Document optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

                                                  -
                                                  --profile name
                                                  +
                                                  --profile name

                                                  Document with the given profile. See the reference for more details on profiles.

                                                  -
                                                  --timings=fmts
                                                  +
                                                  --timings=fmts

                                                  Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -233,7 +233,7 @@ information about timing information. ### Output Options

                                                  -
                                                  --target-dir directory
                                                  +
                                                  --target-dir directory

                                                  Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -245,8 +245,8 @@ Defaults to target in the root of the workspace.

                                                  ### Display Options
                                                  -
                                                  -v
                                                  -
                                                  --verbose
                                                  +
                                                  -v
                                                  +
                                                  --verbose

                                                  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 term.verbose @@ -254,15 +254,15 @@ May also be specified with the term.verbose

                                                  -
                                                  -q
                                                  -
                                                  --quiet
                                                  +
                                                  -q
                                                  +
                                                  --quiet

                                                  Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                  -
                                                  --color when
                                                  +
                                                  --color when

                                                  Control when colored output is used. Valid values:

                                                  • auto (default): Automatically detect if color support is available on the @@ -275,7 +275,7 @@ terminal.
                                                  -
                                                  --message-format fmt
                                                  +
                                                  --message-format fmt

                                                  The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

                                                    @@ -303,18 +303,18 @@ coming from rustc are still emitted. Cannot be used with human or < ### Manifest Options
                                                    -
                                                    --manifest-path path
                                                    +
                                                    --manifest-path path

                                                    Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                    -
                                                    --ignore-rust-version
                                                    +
                                                    --ignore-rust-version

                                                    Ignore rust-version specification in packages.

                                                    -
                                                    --locked
                                                    +
                                                    --locked

                                                    Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                    @@ -327,7 +327,7 @@ such as in CI pipelines.

                                                    -
                                                    --offline
                                                    +
                                                    --offline

                                                    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 @@ -341,12 +341,12 @@ offline.

                                                    -
                                                    --frozen
                                                    +
                                                    --frozen

                                                    Equivalent to specifying both --locked and --offline.

                                                    -
                                                    --lockfile-path PATH
                                                    +
                                                    --lockfile-path PATH

                                                    Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -364,7 +364,7 @@ requires the -Z unstable-options flag to enable (see

                                                    -
                                                    +toolchain
                                                    +
                                                    +toolchain

                                                    If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -373,14 +373,14 @@ for more information about how toolchain overrides work.

                                                    -
                                                    --config KEY=VALUE or PATH
                                                    +
                                                    --config KEY=VALUE or PATH

                                                    Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                    -
                                                    -C PATH
                                                    +
                                                    -C PATH

                                                    Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -392,13 +392,13 @@ requires the -Z unstable-options flag to enable (see

                                                    -
                                                    -h
                                                    -
                                                    --help
                                                    +
                                                    -h
                                                    +
                                                    --help

                                                    Prints help information.

                                                    -
                                                    -Z flag
                                                    +
                                                    -Z flag

                                                    Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                    @@ -408,8 +408,8 @@ requires the -Z unstable-options flag to enable (see ### Miscellaneous Options
                                                    -
                                                    -j N
                                                    -
                                                    --jobs N
                                                    +
                                                    -j N
                                                    +
                                                    --jobs N

                                                    Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -418,7 +418,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                                                    -
                                                    --keep-going
                                                    +
                                                    --keep-going

                                                    Build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build.

                                                    For example if the current package depends on dependencies fails and works, @@ -428,7 +428,7 @@ first), whereas cargo rustdoc -j1 --keep-going would definitely run builds, even if the one run first fails.

                                                    -
                                                    --output-format
                                                    +
                                                    --output-format

                                                    The output type for the documentation emitted. Valid values:

                                                    • html (default): Emit the documentation in HTML format.
                                                      • diff --git a/src/doc/src/commands/cargo-search.md b/src/doc/src/commands/cargo-search.md index d04a8a7248c..fafed03248b 100644 --- a/src/doc/src/commands/cargo-search.md +++ b/src/doc/src/commands/cargo-search.md @@ -20,17 +20,17 @@ for copying into a `Cargo.toml` manifest.
                                                      -
                                                      --limit limit
                                                      +
                                                      --limit limit

                                                      Limit the number of results (default: 10, max: 100).

                                                      -
                                                      --index index
                                                      +
                                                      --index index

                                                      The URL of the registry index to use.

                                                      -
                                                      --registry registry
                                                      +
                                                      --registry registry

                                                      Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -43,8 +43,8 @@ which is defined by the registry.default config key which defaults ### Display Options

                                                      -
                                                      -v
                                                      -
                                                      --verbose
                                                      +
                                                      -v
                                                      +
                                                      --verbose

                                                      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 term.verbose @@ -52,15 +52,15 @@ May also be specified with the term.verbose

                                                      -
                                                      -q
                                                      -
                                                      --quiet
                                                      +
                                                      -q
                                                      +
                                                      --quiet

                                                      Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                      -
                                                      --color when
                                                      +
                                                      --color when

                                                      Control when colored output is used. Valid values:

                                                      • auto (default): Automatically detect if color support is available on the @@ -78,7 +78,7 @@ terminal.
                                                        • -
                                                        +toolchain
                                                        +
                                                        +toolchain

                                                        If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -87,14 +87,14 @@ for more information about how toolchain overrides work.

                                                        -
                                                        --config KEY=VALUE or PATH
                                                        +
                                                        --config KEY=VALUE or PATH

                                                        Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                        -
                                                        -C PATH
                                                        +
                                                        -C PATH

                                                        Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -106,13 +106,13 @@ requires the -Z unstable-options flag to enable (see

                                                        -
                                                        -h
                                                        -
                                                        --help
                                                        +
                                                        -h
                                                        +
                                                        --help

                                                        Prints help information.

                                                        -
                                                        -Z flag
                                                        +
                                                        -Z flag

                                                        Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                        diff --git a/src/doc/src/commands/cargo-test.md b/src/doc/src/commands/cargo-test.md index b4c086bd06a..3e0d75ac3c3 100644 --- a/src/doc/src/commands/cargo-test.md +++ b/src/doc/src/commands/cargo-test.md @@ -74,12 +74,12 @@ directory of the package the test belongs to, and is controlled via `rustdoc`'s
                                                        -
                                                        --no-run
                                                        +
                                                        --no-run

                                                        Compile, but don’t run tests.

                                                        -
                                                        --no-fail-fast
                                                        +
                                                        --no-fail-fast

                                                        Run all tests regardless of failure. Without this flag, Cargo will exit after the first executable fails. The Rust test harness will run all tests within the executable to completion, this flag only applies to the executable @@ -104,8 +104,8 @@ virtual workspace will include all workspace members (equivalent to passing

                                                        -
                                                        -p spec…
                                                        -
                                                        --package spec…
                                                        +
                                                        -p spec…
                                                        +
                                                        --package spec…

                                                        Test only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -114,17 +114,17 @@ double quotes around each pattern.

                                                        -
                                                        --workspace
                                                        +
                                                        --workspace

                                                        Test all members in the workspace.

                                                        -
                                                        --all
                                                        +
                                                        --all

                                                        Deprecated alias for --workspace.

                                                        -
                                                        --exclude SPEC…
                                                        +
                                                        --exclude SPEC…

                                                        Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -184,40 +184,40 @@ use single quotes or double quotes around each glob pattern.

                                                        -
                                                        --lib
                                                        +
                                                        --lib

                                                        Test the package’s library.

                                                        -
                                                        --bin name…
                                                        +
                                                        --bin name…

                                                        Test the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

                                                        -
                                                        --bins
                                                        +
                                                        --bins

                                                        Test all binary targets.

                                                        -
                                                        --example name…
                                                        +
                                                        --example name…

                                                        Test the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

                                                        -
                                                        --examples
                                                        +
                                                        --examples

                                                        Test all example targets.

                                                        -
                                                        --test name…
                                                        +
                                                        --test name…

                                                        Test the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

                                                        -
                                                        --tests
                                                        +
                                                        --tests

                                                        Test all targets that have the test = true 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 @@ -228,13 +228,13 @@ manifest settings for the target.

                                                        -
                                                        --bench name…
                                                        +
                                                        --bench name…

                                                        Test the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

                                                        -
                                                        --benches
                                                        +
                                                        --benches

                                                        Test all targets that have the bench = true 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 @@ -245,7 +245,7 @@ manifest settings for the target.

                                                        -
                                                        --all-targets
                                                        +
                                                        --all-targets

                                                        Test all targets. This is equivalent to specifying --lib --bins --tests --benches --examples.

                                                        @@ -254,7 +254,7 @@ manifest settings for the target.

                                                        -
                                                        --doc
                                                        +
                                                        --doc

                                                        Test only the library’s documentation. This cannot be mixed with other target options.

                                                        @@ -273,20 +273,20 @@ for more details.
                                                        -
                                                        -F features
                                                        -
                                                        --features features
                                                        +
                                                        -F features
                                                        +
                                                        --features features

                                                        Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                                        -
                                                        --all-features
                                                        +
                                                        --all-features

                                                        Activate all available features of all selected packages.

                                                        -
                                                        --no-default-features
                                                        +
                                                        --no-default-features

                                                        Do not activate the default feature of the selected packages.

                                                        @@ -297,7 +297,7 @@ be specified multiple times, which enables all specified features.

                                                        -
                                                        --target triple
                                                        +
                                                        --target triple

                                                        Test for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>.

                                                        Possible values:

                                                        @@ -313,20 +313,20 @@ target artifacts are placed in a separate directory. See the
                                                        -
                                                        -r
                                                        -
                                                        --release
                                                        +
                                                        -r
                                                        +
                                                        --release

                                                        Test optimized artifacts with the release profile. See also the --profile option for choosing a specific profile by name.

                                                        -
                                                        --profile name
                                                        +
                                                        --profile name

                                                        Test with the given profile. See the reference for more details on profiles.

                                                        -
                                                        --timings=fmts
                                                        +
                                                        --timings=fmts

                                                        Output information how long each compilation takes, and track concurrency information over time. Accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. @@ -350,7 +350,7 @@ information about timing information. ### Output Options

                                                        -
                                                        --target-dir directory
                                                        +
                                                        --target-dir directory

                                                        Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value. @@ -369,8 +369,8 @@ results readable. Test output can be recovered (e.g., for debugging) by passing

                                                        -
                                                        -v
                                                        -
                                                        --verbose
                                                        +
                                                        -v
                                                        +
                                                        --verbose

                                                        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 term.verbose @@ -378,15 +378,15 @@ May also be specified with the term.verbose

                                                        -
                                                        -q
                                                        -
                                                        --quiet
                                                        +
                                                        -q
                                                        +
                                                        --quiet

                                                        Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                        -
                                                        --color when
                                                        +
                                                        --color when

                                                        Control when colored output is used. Valid values:

                                                        • auto (default): Automatically detect if color support is available on the @@ -399,7 +399,7 @@ terminal.
                                                        -
                                                        --message-format fmt
                                                        +
                                                        --message-format fmt

                                                        The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

                                                          @@ -429,18 +429,18 @@ coming from rustc are still emitted. Cannot be used with human or <
                                                          -
                                                          --manifest-path path
                                                          +
                                                          --manifest-path path

                                                          Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                          -
                                                          --ignore-rust-version
                                                          +
                                                          --ignore-rust-version

                                                          Ignore rust-version specification in packages.

                                                          -
                                                          --locked
                                                          +
                                                          --locked

                                                          Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                          @@ -453,7 +453,7 @@ such as in CI pipelines.

                                                          -
                                                          --offline
                                                          +
                                                          --offline

                                                          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 @@ -467,12 +467,12 @@ offline.

                                                          -
                                                          --frozen
                                                          +
                                                          --frozen

                                                          Equivalent to specifying both --locked and --offline.

                                                          -
                                                          --lockfile-path PATH
                                                          +
                                                          --lockfile-path PATH

                                                          Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -491,7 +491,7 @@ requires the -Z unstable-options flag to enable (see

                                                          -
                                                          +toolchain
                                                          +
                                                          +toolchain

                                                          If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -500,14 +500,14 @@ for more information about how toolchain overrides work.

                                                          -
                                                          --config KEY=VALUE or PATH
                                                          +
                                                          --config KEY=VALUE or PATH

                                                          Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                          -
                                                          -C PATH
                                                          +
                                                          -C PATH

                                                          Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -519,13 +519,13 @@ requires the -Z unstable-options flag to enable (see

                                                          -
                                                          -h
                                                          -
                                                          --help
                                                          +
                                                          -h
                                                          +
                                                          --help

                                                          Prints help information.

                                                          -
                                                          -Z flag
                                                          +
                                                          -Z flag

                                                          Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                          @@ -542,8 +542,8 @@ includes an option to control the number of threads used:
                                                          -
                                                          -j N
                                                          -
                                                          --jobs N
                                                          +
                                                          -j N
                                                          +
                                                          --jobs N

                                                          Number of parallel jobs to run. May also be specified with the build.jobs config value. Defaults to the number of logical CPUs. If negative, it sets the maximum number of @@ -552,7 +552,7 @@ a string default is provided, it sets the value back to defaults. Should not be 0.

                                                          -
                                                          --future-incompat-report
                                                          +
                                                          --future-incompat-report

                                                          Displays a future-incompat report for any future-incompatible warnings produced during execution of this command

                                                          See cargo-report(1)

                                                          diff --git a/src/doc/src/commands/cargo-tree.md b/src/doc/src/commands/cargo-tree.md index 412afd8715e..ee8c90fa7bc 100644 --- a/src/doc/src/commands/cargo-tree.md +++ b/src/doc/src/commands/cargo-tree.md @@ -73,8 +73,8 @@ To learn more about feature unification, check out this
                                                          -
                                                          -i spec
                                                          -
                                                          --invert spec
                                                          +
                                                          -i spec
                                                          +
                                                          --invert spec

                                                          Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package.

                                                          Note that in a workspace, by default it will only display the package’s @@ -86,12 +86,12 @@ subtree of the package given to -p.

                                                          -
                                                          --prune spec
                                                          +
                                                          --prune spec

                                                          Prune the given package from the display of the dependency tree.

                                                          -
                                                          --depth depth
                                                          +
                                                          --depth depth

                                                          Maximum display depth of the dependency tree. A depth of 1 displays the direct dependencies, for example.

                                                          If the given value is workspace, only shows the dependencies that are member @@ -99,7 +99,7 @@ of the current workspace, instead.

                                                          -
                                                          --no-dedupe
                                                          +
                                                          --no-dedupe

                                                          Do not de-duplicate repeated dependencies. Usually, when a package has already displayed its dependencies, further occurrences will not re-display its dependencies, and will include a (*) to indicate it has already been shown. @@ -107,8 +107,8 @@ This flag will cause those duplicates to be repeated.

                                                          -
                                                          -d
                                                          -
                                                          --duplicates
                                                          +
                                                          -d
                                                          +
                                                          --duplicates

                                                          Show only dependencies which come in multiple versions (implies --invert). When used with the -p flag, only shows duplicates within the subtree of the given package.

                                                          @@ -120,8 +120,8 @@ only one instance is built.

                                                          -
                                                          -e kinds
                                                          -
                                                          --edges kinds
                                                          +
                                                          -e kinds
                                                          +
                                                          --edges kinds

                                                          The dependency kinds to display. Takes a comma separated list of values:

                                                          • all — Show all edge kinds.
                                                            • @@ -141,7 +141,7 @@ kind given, then it will automatically include the other dependency kinds.
                                                          -
                                                          --target triple
                                                          +
                                                          --target triple

                                                          Filter dependencies matching the given target triple. The default is the host platform. Use the value all to include all targets.

                                                          @@ -153,14 +153,14 @@ The default is the host platform. Use the value all to include
                                                          -
                                                          --charset charset
                                                          +
                                                          --charset charset

                                                          Chooses the character set to use for the tree. Valid values are “utf8” or “ascii”. When unspecified, cargo will auto-select a value.

                                                          -
                                                          -f format
                                                          -
                                                          --format format
                                                          +
                                                          -f format
                                                          +
                                                          --format format

                                                          Set the format string for each package. The default is “{p}”.

                                                          This is an arbitrary string which will be used to display each package. The following strings will be replaced with the corresponding value:

                                                          @@ -174,7 +174,7 @@ strings will be replaced with the corresponding value:

                                                          -
                                                          --prefix prefix
                                                          +
                                                          --prefix prefix

                                                          Sets how each line is displayed. The prefix value can be one of:

                                                          • indent (default) — Shows each line indented as a tree.
                                                            • @@ -201,8 +201,8 @@ virtual workspace will include all workspace members (equivalent to passing
                                                            -
                                                            -p spec…
                                                            -
                                                            --package spec…
                                                            +
                                                            -p spec…
                                                            +
                                                            --package spec…

                                                            Display only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -211,13 +211,13 @@ double quotes around each pattern.

                                                            -
                                                            --workspace
                                                            +
                                                            --workspace

                                                            Display all members in the workspace.

                                                            -
                                                            --exclude SPEC…
                                                            +
                                                            --exclude SPEC…

                                                            Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -232,13 +232,13 @@ single quotes or double quotes around each pattern.

                                                            -
                                                            --manifest-path path
                                                            +
                                                            --manifest-path path

                                                            Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                            -
                                                            --locked
                                                            +
                                                            --locked

                                                            Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                            @@ -251,7 +251,7 @@ such as in CI pipelines.

                                                            -
                                                            --offline
                                                            +
                                                            --offline

                                                            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 @@ -265,12 +265,12 @@ offline.

                                                            -
                                                            --frozen
                                                            +
                                                            --frozen

                                                            Equivalent to specifying both --locked and --offline.

                                                            -
                                                            --lockfile-path PATH
                                                            +
                                                            --lockfile-path PATH

                                                            Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -295,20 +295,20 @@ for more details.

                                                            -
                                                            -F features
                                                            -
                                                            --features features
                                                            +
                                                            -F features
                                                            +
                                                            --features features

                                                            Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

                                                            -
                                                            --all-features
                                                            +
                                                            --all-features

                                                            Activate all available features of all selected packages.

                                                            -
                                                            --no-default-features
                                                            +
                                                            --no-default-features

                                                            Do not activate the default feature of the selected packages.

                                                            @@ -319,8 +319,8 @@ be specified multiple times, which enables all specified features.

                                                            -
                                                            -v
                                                            -
                                                            --verbose
                                                            +
                                                            -v
                                                            +
                                                            --verbose

                                                            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 term.verbose @@ -328,15 +328,15 @@ May also be specified with the term.verbose

                                                            -
                                                            -q
                                                            -
                                                            --quiet
                                                            +
                                                            -q
                                                            +
                                                            --quiet

                                                            Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                            -
                                                            --color when
                                                            +
                                                            --color when

                                                            Control when colored output is used. Valid values:

                                                            • auto (default): Automatically detect if color support is available on the @@ -355,7 +355,7 @@ terminal.
                                                              • -
                                                              +toolchain
                                                              +
                                                              +toolchain

                                                              If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -364,14 +364,14 @@ for more information about how toolchain overrides work.

                                                              -
                                                              --config KEY=VALUE or PATH
                                                              +
                                                              --config KEY=VALUE or PATH

                                                              Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                              -
                                                              -C PATH
                                                              +
                                                              -C PATH

                                                              Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -383,13 +383,13 @@ requires the -Z unstable-options flag to enable (see

                                                              -
                                                              -h
                                                              -
                                                              --help
                                                              +
                                                              -h
                                                              +
                                                              --help

                                                              Prints help information.

                                                              -
                                                              -Z flag
                                                              +
                                                              -Z flag

                                                              Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                              diff --git a/src/doc/src/commands/cargo-uninstall.md b/src/doc/src/commands/cargo-uninstall.md index 080e793c4bb..480f90de733 100644 --- a/src/doc/src/commands/cargo-uninstall.md +++ b/src/doc/src/commands/cargo-uninstall.md @@ -31,18 +31,18 @@ The installation root is determined, in order of precedence:
                                                              -
                                                              -p
                                                              -
                                                              --package spec…
                                                              +
                                                              -p
                                                              +
                                                              --package spec…

                                                              Package to uninstall.

                                                              -
                                                              --bin name…
                                                              +
                                                              --bin name…

                                                              Only uninstall the binary name.

                                                              -
                                                              --root dir
                                                              +
                                                              --root dir

                                                              Directory to uninstall packages from.

                                                              @@ -53,8 +53,8 @@ The installation root is determined, in order of precedence:
                                                              -
                                                              -v
                                                              -
                                                              --verbose
                                                              +
                                                              -v
                                                              +
                                                              --verbose

                                                              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 term.verbose @@ -62,15 +62,15 @@ May also be specified with the term.verbose

                                                              -
                                                              -q
                                                              -
                                                              --quiet
                                                              +
                                                              -q
                                                              +
                                                              --quiet

                                                              Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                              -
                                                              --color when
                                                              +
                                                              --color when

                                                              Control when colored output is used. Valid values:

                                                              • auto (default): Automatically detect if color support is available on the @@ -89,7 +89,7 @@ terminal.
                                                                • -
                                                                +toolchain
                                                                +
                                                                +toolchain

                                                                If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -98,14 +98,14 @@ for more information about how toolchain overrides work.

                                                                -
                                                                --config KEY=VALUE or PATH
                                                                +
                                                                --config KEY=VALUE or PATH

                                                                Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                                -
                                                                -C PATH
                                                                +
                                                                -C PATH

                                                                Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -117,13 +117,13 @@ requires the -Z unstable-options flag to enable (see

                                                                -
                                                                -h
                                                                -
                                                                --help
                                                                +
                                                                -h
                                                                +
                                                                --help

                                                                Prints help information.

                                                                -
                                                                -Z flag
                                                                +
                                                                -Z flag

                                                                Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                                diff --git a/src/doc/src/commands/cargo-update.md b/src/doc/src/commands/cargo-update.md index ed0571a5c45..4f66c45f8df 100644 --- a/src/doc/src/commands/cargo-update.md +++ b/src/doc/src/commands/cargo-update.md @@ -20,7 +20,7 @@ latest available versions.
                                                                -
                                                                spec…
                                                                +
                                                                spec…

                                                                Update only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for the SPEC format.

                                                                If packages are specified with spec, then a conservative update of @@ -32,13 +32,13 @@ will remain locked at their currently recorded versions.

                                                                -
                                                                --recursive
                                                                +
                                                                --recursive

                                                                When used with spec, dependencies of spec are forced to update as well. Cannot be used with --precise.

                                                                -
                                                                --precise precise
                                                                +
                                                                --precise precise

                                                                When used with spec, allows you to specify a specific version number to set the package to. If the package comes from a git repository, this can be a git revision (such as a SHA hash or tag).

                                                                @@ -50,7 +50,7 @@ requirement in Cargo.toml doesn’t contain any pre-release identif
                                                                -
                                                                --breaking directory
                                                                +
                                                                --breaking directory

                                                                Update spec to latest SemVer-breaking version.

                                                                Version requirements will be modified to allow this update.

                                                                This only applies to dependencies when

                                                                @@ -67,8 +67,8 @@ See https://github.com
                                                                -
                                                                -w
                                                                -
                                                                --workspace
                                                                +
                                                                -w
                                                                +
                                                                --workspace

                                                                Attempt to update only packages defined in the workspace. Other packages are updated only if they don’t already exist in the lockfile. This option is useful for updating Cargo.lock after you’ve changed version @@ -76,7 +76,7 @@ numbers in Cargo.toml.

                                                                -
                                                                --dry-run
                                                                +
                                                                --dry-run

                                                                Displays what would be updated, but doesn’t actually write the lockfile.

                                                                @@ -86,8 +86,8 @@ numbers in Cargo.toml.

                                                                ### Display Options
                                                                -
                                                                -v
                                                                -
                                                                --verbose
                                                                +
                                                                -v
                                                                +
                                                                --verbose

                                                                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 term.verbose @@ -95,15 +95,15 @@ May also be specified with the term.verbose

                                                                -
                                                                -q
                                                                -
                                                                --quiet
                                                                +
                                                                -q
                                                                +
                                                                --quiet

                                                                Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                                -
                                                                --color when
                                                                +
                                                                --color when

                                                                Control when colored output is used. Valid values:

                                                                • auto (default): Automatically detect if color support is available on the @@ -121,18 +121,18 @@ terminal.
                                                                  • -
                                                                  --manifest-path path
                                                                  +
                                                                  --manifest-path path

                                                                  Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                                  -
                                                                  --ignore-rust-version
                                                                  +
                                                                  --ignore-rust-version

                                                                  Ignore rust-version specification in packages.

                                                                  -
                                                                  --locked
                                                                  +
                                                                  --locked

                                                                  Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                                  @@ -145,7 +145,7 @@ such as in CI pipelines.

                                                                  -
                                                                  --offline
                                                                  +
                                                                  --offline

                                                                  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 @@ -159,12 +159,12 @@ offline.

                                                                  -
                                                                  --frozen
                                                                  +
                                                                  --frozen

                                                                  Equivalent to specifying both --locked and --offline.

                                                                  -
                                                                  --lockfile-path PATH
                                                                  +
                                                                  --lockfile-path PATH

                                                                  Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -183,7 +183,7 @@ requires the -Z unstable-options flag to enable (see

                                                                  -
                                                                  +toolchain
                                                                  +
                                                                  +toolchain

                                                                  If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -192,14 +192,14 @@ for more information about how toolchain overrides work.

                                                                  -
                                                                  --config KEY=VALUE or PATH
                                                                  +
                                                                  --config KEY=VALUE or PATH

                                                                  Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                                  -
                                                                  -C PATH
                                                                  +
                                                                  -C PATH

                                                                  Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -211,13 +211,13 @@ requires the -Z unstable-options flag to enable (see

                                                                  -
                                                                  -h
                                                                  -
                                                                  --help
                                                                  +
                                                                  -h
                                                                  +
                                                                  --help

                                                                  Prints help information.

                                                                  -
                                                                  -Z flag
                                                                  +
                                                                  -Z flag

                                                                  Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                                  diff --git a/src/doc/src/commands/cargo-vendor.md b/src/doc/src/commands/cargo-vendor.md index 0b0e8cdf1eb..255ab54d292 100644 --- a/src/doc/src/commands/cargo-vendor.md +++ b/src/doc/src/commands/cargo-vendor.md @@ -33,26 +33,26 @@ as it knows that it is no longer a read-only dependency.
                                                                  -
                                                                  -s manifest
                                                                  -
                                                                  --sync manifest
                                                                  +
                                                                  -s manifest
                                                                  +
                                                                  --sync manifest

                                                                  Specify an extra Cargo.toml manifest to workspaces which should also be vendored and synced to the output. May be specified multiple times.

                                                                  -
                                                                  --no-delete
                                                                  +
                                                                  --no-delete

                                                                  Don’t delete the “vendor” directory when vendoring, but rather keep all existing contents of the vendor directory

                                                                  -
                                                                  --respect-source-config
                                                                  +
                                                                  --respect-source-config

                                                                  Instead of ignoring [source] configuration by default in .cargo/config.toml read it and use it when downloading crates from crates.io, for example

                                                                  -
                                                                  --versioned-dirs
                                                                  +
                                                                  --versioned-dirs

                                                                  Normally versions are only added to disambiguate multiple versions of the same package. This option causes all directories in the “vendor” directory to be versioned, which makes it easier to track the history of vendored @@ -67,13 +67,13 @@ only a subset of the packages have changed.

                                                                  -
                                                                  --manifest-path path
                                                                  +
                                                                  --manifest-path path

                                                                  Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

                                                                  -
                                                                  --locked
                                                                  +
                                                                  --locked

                                                                  Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                                  @@ -86,7 +86,7 @@ such as in CI pipelines.

                                                                  -
                                                                  --offline
                                                                  +
                                                                  --offline

                                                                  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 @@ -100,12 +100,12 @@ offline.

                                                                  -
                                                                  --frozen
                                                                  +
                                                                  --frozen

                                                                  Equivalent to specifying both --locked and --offline.

                                                                  -
                                                                  --lockfile-path PATH
                                                                  +
                                                                  --lockfile-path PATH

                                                                  Changes the path of the lockfile from the default (<workspace_root>/Cargo.lock) to PATH. PATH must end with Cargo.lock (e.g. --lockfile-path /tmp/temporary-lockfile/Cargo.lock). Note that providing --lockfile-path will ignore existing lockfile at the default path, and instead will @@ -124,8 +124,8 @@ requires the -Z unstable-options flag to enable (see

                                                                  -
                                                                  -v
                                                                  -
                                                                  --verbose
                                                                  +
                                                                  -v
                                                                  +
                                                                  --verbose

                                                                  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 term.verbose @@ -133,15 +133,15 @@ May also be specified with the term.verbose

                                                                  -
                                                                  -q
                                                                  -
                                                                  --quiet
                                                                  +
                                                                  -q
                                                                  +
                                                                  --quiet

                                                                  Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                                  -
                                                                  --color when
                                                                  +
                                                                  --color when

                                                                  Control when colored output is used. Valid values:

                                                                  • auto (default): Automatically detect if color support is available on the @@ -160,7 +160,7 @@ terminal.
                                                                    • -
                                                                    +toolchain
                                                                    +
                                                                    +toolchain

                                                                    If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -169,14 +169,14 @@ for more information about how toolchain overrides work.

                                                                    -
                                                                    --config KEY=VALUE or PATH
                                                                    +
                                                                    --config KEY=VALUE or PATH

                                                                    Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                                    -
                                                                    -C PATH
                                                                    +
                                                                    -C PATH

                                                                    Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -188,13 +188,13 @@ requires the -Z unstable-options flag to enable (see

                                                                    -
                                                                    -h
                                                                    -
                                                                    --help
                                                                    +
                                                                    -h
                                                                    +
                                                                    --help

                                                                    Prints help information.

                                                                    -
                                                                    -Z flag
                                                                    +
                                                                    -Z flag

                                                                    Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                                    diff --git a/src/doc/src/commands/cargo-version.md b/src/doc/src/commands/cargo-version.md index c58dfeb74a3..e9625955fec 100644 --- a/src/doc/src/commands/cargo-version.md +++ b/src/doc/src/commands/cargo-version.md @@ -16,8 +16,8 @@ Displays the version of Cargo.
                                                                    -
                                                                    -v
                                                                    -
                                                                    --verbose
                                                                    +
                                                                    -v
                                                                    +
                                                                    --verbose

                                                                    Display additional version information.

                                                                    diff --git a/src/doc/src/commands/cargo-yank.md b/src/doc/src/commands/cargo-yank.md index f7a499c38ee..213b8984a17 100644 --- a/src/doc/src/commands/cargo-yank.md +++ b/src/doc/src/commands/cargo-yank.md @@ -81,18 +81,18 @@ from keeping or even spreading the leaked credentials.
                                                                    -
                                                                    --vers version
                                                                    -
                                                                    --version version
                                                                    +
                                                                    --vers version
                                                                    +
                                                                    --version version

                                                                    The version to yank or un-yank.

                                                                    -
                                                                    --undo
                                                                    +
                                                                    --undo

                                                                    Undo a yank, putting a version back into the index.

                                                                    -
                                                                    --token token
                                                                    +
                                                                    --token token

                                                                    API token to use when authenticating. This overrides the token stored in the credentials file (which is created by cargo-login(1)).

                                                                    Cargo config environment variables can be @@ -104,12 +104,12 @@ of the registry in all capital letters.

                                                                    -
                                                                    --index index
                                                                    +
                                                                    --index index

                                                                    The URL of the registry index to use.

                                                                    -
                                                                    --registry registry
                                                                    +
                                                                    --registry registry

                                                                    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to @@ -123,8 +123,8 @@ which is defined by the registry.default config key which defaults

                                                                    -
                                                                    -v
                                                                    -
                                                                    --verbose
                                                                    +
                                                                    -v
                                                                    +
                                                                    --verbose

                                                                    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 term.verbose @@ -132,15 +132,15 @@ May also be specified with the term.verbose

                                                                    -
                                                                    -q
                                                                    -
                                                                    --quiet
                                                                    +
                                                                    -q
                                                                    +
                                                                    --quiet

                                                                    Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                                    -
                                                                    --color when
                                                                    +
                                                                    --color when

                                                                    Control when colored output is used. Valid values:

                                                                    • auto (default): Automatically detect if color support is available on the @@ -159,7 +159,7 @@ terminal.
                                                                      • -
                                                                      +toolchain
                                                                      +
                                                                      +toolchain

                                                                      If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -168,14 +168,14 @@ for more information about how toolchain overrides work.

                                                                      -
                                                                      --config KEY=VALUE or PATH
                                                                      +
                                                                      --config KEY=VALUE or PATH

                                                                      Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                                      -
                                                                      -C PATH
                                                                      +
                                                                      -C PATH

                                                                      Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -187,13 +187,13 @@ requires the -Z unstable-options flag to enable (see

                                                                      -
                                                                      -h
                                                                      -
                                                                      --help
                                                                      +
                                                                      -h
                                                                      +
                                                                      --help

                                                                      Prints help information.

                                                                      -
                                                                      -Z flag
                                                                      +
                                                                      -Z flag

                                                                      Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                                      diff --git a/src/doc/src/commands/cargo.md b/src/doc/src/commands/cargo.md index 675de3373cb..03676e24927 100644 --- a/src/doc/src/commands/cargo.md +++ b/src/doc/src/commands/cargo.md @@ -137,20 +137,20 @@ available at .
                                                                      -
                                                                      -V
                                                                      -
                                                                      --version
                                                                      +
                                                                      -V
                                                                      +
                                                                      --version

                                                                      Print version info and exit. If used with --verbose, prints extra information.

                                                                      -
                                                                      --list
                                                                      +
                                                                      --list

                                                                      List all installed Cargo subcommands. If used with --verbose, prints extra information.

                                                                      -
                                                                      --explain code
                                                                      +
                                                                      --explain code

                                                                      Run rustc --explain CODE which will print out a detailed explanation of an error message (for example, E0004).

                                                                      @@ -162,8 +162,8 @@ error message (for example, E0004).

                                                                      -
                                                                      -v
                                                                      -
                                                                      --verbose
                                                                      +
                                                                      -v
                                                                      +
                                                                      --verbose

                                                                      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 term.verbose @@ -171,15 +171,15 @@ May also be specified with the term.verbose

                                                                      -
                                                                      -q
                                                                      -
                                                                      --quiet
                                                                      +
                                                                      -q
                                                                      +
                                                                      --quiet

                                                                      Do not print cargo log messages. May also be specified with the term.quiet config value.

                                                                      -
                                                                      --color when
                                                                      +
                                                                      --color when

                                                                      Control when colored output is used. Valid values:

                                                                      • auto (default): Automatically detect if color support is available on the @@ -197,7 +197,7 @@ terminal.
                                                                        • ### Manifest Options
                                                                        -
                                                                        --locked
                                                                        +
                                                                        --locked

                                                                        Asserts that the exact same dependencies and versions are used as when the existing Cargo.lock file was originally generated. Cargo will exit with an error when either of the following scenarios arises:

                                                                        @@ -210,7 +210,7 @@ such as in CI pipelines.

                                                                        -
                                                                        --offline
                                                                        +
                                                                        --offline

                                                                        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 @@ -224,7 +224,7 @@ offline.

                                                                        -
                                                                        --frozen
                                                                        +
                                                                        --frozen

                                                                        Equivalent to specifying both --locked and --offline.

                                                                        @@ -234,7 +234,7 @@ offline.

                                                                        -
                                                                        +toolchain
                                                                        +
                                                                        +toolchain

                                                                        If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). @@ -243,14 +243,14 @@ for more information about how toolchain overrides work.

                                                                        -
                                                                        --config KEY=VALUE or PATH
                                                                        +
                                                                        --config KEY=VALUE or PATH

                                                                        Overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section for more information.

                                                                        -
                                                                        -C PATH
                                                                        +
                                                                        -C PATH

                                                                        Changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must @@ -262,13 +262,13 @@ requires the -Z unstable-options flag to enable (see

                                                                        -
                                                                        -h
                                                                        -
                                                                        --help
                                                                        +
                                                                        -h
                                                                        +
                                                                        --help

                                                                        Prints help information.

                                                                        -
                                                                        -Z flag
                                                                        +
                                                                        -Z flag

                                                                        Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

                                                                        diff --git a/src/doc/theme/cargo.css b/src/doc/theme/cargo.css index 28748ad1651..d59a5dca5b3 100644 --- a/src/doc/theme/cargo.css +++ b/src/doc/theme/cargo.css @@ -3,3 +3,8 @@ dd > p { space before the definition. This can removed after updating to mdbook 0.5. */ margin-top: 0; } + +/* Override mdbook's link color for option links. */ +a.option-anchor, a.option-anchor > * { + color: var(--fg) !important; +}