color when Control when colored output is used.

May also be specified with the term.quiet config value. q -quiet Do not print cargo log messages. May also be specified with the term.verbose config value. Includes extra output such as dependency warnings and build script output. May be specified twice for “very verbose” output which Display Options -v -verbose Use verbose output. Specified with the CARGO_TARGET_DIR environment variable, or theĭefaults to target in the root of the workspace. Output Options -target-dir directory Directory for all generated artifacts and intermediate files. json (unstable, requires -Zunstable-options): Emit machine-readable JSON.HTML output is suitable for human consumption only,Īnd does not provide machine-readable timing data. Also writeĪ report to the same directory with a timestamp in the filename if you want Target/cargo-timings directory with a report of the compilation. html (unstable, requires -Zunstable-options): Write a human-readable file cargo-timing.html to the.Specifying an output format (rather than the default) is unstable and requires Accepts an optional comma-separated list of outputįormats -timings without an argument will default to -timings=html. timings= fmts Output information how long each compilation takes, and track concurrency Required Rust version as configured in the project’s rust-version field. ignore-rust-version Document the target even if the selected Rust compiler is older than the See the the reference for more details on profiles. profile name Document with the given profile. See also the -profile option for choosing a specific profile by name. r -release Document optimized artifacts with the release profile. See theīuild cache documentation for more details. Target artifacts are placed in a separate directory.

Note that specifying this flag makes Cargo run in a different mode where the This may also be specified with the build.target config value. This flag may be specified multiple times. Compilation Options -target triple Document for the given architecture. no-default-features Do not activate the default feature of the selected packages. all-features Activate all available features of all selected packages. This flag mayīe specified multiple times, which enables all specified features. Members may be enabled with package-name/feature-name syntax. F features -features features Space or comma separated list of features to activate. When noįeature options are given, the default feature is activated for everyįor more details. The feature flags allow you to control which features are enabled. This flag may be specified multiple timesĪnd supports common Unix glob patterns. example name… Document the specified example. bin name… Document the specified binary. Using target selection options will ignore the docįlag and will always document the given target. The default behavior can be changed by setting doc = false for the target in If its name is the same as the lib target. When no target selection options are given, cargo doc will document allīinary and library targets of the selected package. Single quotes or double quotes around each pattern. However, to avoid your shellĪccidentally expanding glob patterns before Cargo handles them, you must use This flag may be specified multiple times and supportsĬommon Unix glob patterns like *, ? and. exclude SPEC… Exclude the specified packages. workspace Document all members in the workspace. However, to avoid your shell accidentallyĮxpanding glob patterns before Cargo handles them, you must use single quotes orĭouble quotes around each pattern. This flag may be specified multiple times and supports common Unix p spec… -package spec… Document only the specified packages. workspace), and a non-virtual workspace will include only the root crate itself. Virtual workspace will include all workspace members (equivalent to passing The default members of a workspace can be set explicitly with the

The workspaces default members are selected, otherwise only the package defined If the manifest is the root of a workspace then Package Selectionīy default, when no package selection options are given, the packages selectedĭepend on the selected manifest file (based on the current working directory if This will be enabled by default if documenting a binary target. document-private-items Include non-public items in the documentation. no-deps Do not build documentation for dependencies. This will use your defaultīrowser unless you define another one in the BROWSER environment variable OPTIONS Documentation Options -open Open the docs in a browser after building them. Is placed in target/doc in rustdoc’s usual format.

Cargo-doc - Build a package’s documentation SYNOPSISīuild the documentation for the local package and all dependencies.

Rust lang docs