cargo/src/doc/man/generated_txt/cargo-update.txt at 7a33639876112bf5335fdffb920ee9d121a96706 · weihanglo/cargo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
CARGO-UPDATE(1)

NAME
       cargo-update — Update dependencies as recorded in the local lock file

SYNOPSIS
       cargo update [options] spec

DESCRIPTION
       This command will update dependencies in the Cargo.lock file to the
       latest version. If the Cargo.lock file does not exist, it will be
       created with the latest available versions.

OPTIONS
   Update Options
       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
           the lockfile will be performed. This means that only the dependency
           specified by SPEC will be updated. Its transitive dependencies will
           be updated only if SPEC cannot be updated without updating
           dependencies. All other dependencies will remain locked at their
           currently recorded versions.

           If spec is not specified, all dependencies are updated.

       --recursive
           When used with spec, dependencies of spec are forced to update as
           well. Cannot be used with --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).

           While not recommended, you can specify a yanked version of a package
           (nightly only). When possible, try other non-yanked
           SemVer-compatible versions or seek help from the maintainers of the
           package.

           A compatible pre-release version can also be specified even when the
           version requirement in Cargo.toml doesn’t contain any pre-release
           identifier (nightly only).

       -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 numbers in Cargo.toml.

       --dry-run
           Displays what would be updated, but doesn’t actually write the
           lockfile.

   Display Options
       -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
           config value
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       -q, --quiet
           Do not print cargo log messages. May also be specified with the
           term.quiet config value
           <https://doc.rust-lang.org/cargo/reference/config.html>.

       --color when
           Control when colored output is used. Valid values:

           o  auto (default): Automatically detect if color support is
              available on the terminal.

           o  always: Always display colors.

           o  never: Never display colors.

           May also be specified with the term.color config value
           <https://doc.rust-lang.org/cargo/reference/config.html>.

   Manifest Options
       --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 specification in packages.

       --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:

           o  The lock file is missing.

           o  Cargo attempted to change the lock file due to a different
              dependency resolution.

           It may be used in environments where deterministic builds are
           desired, such as in CI pipelines.

       --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 proceed without the network if possible.

           Beware that this may result in different dependency resolution than
           online mode. Cargo will restrict itself to crates that are
           downloaded locally, even if there might be a newer version as
           indicated in the local copy of the index. See the cargo-fetch(1)
           command to download dependencies before going offline.

           May also be specified with the net.offline config value
           <https://doc.rust-lang.org/cargo/reference/config.html>.

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

   Common Options
       +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). See the rustup documentation
           <https://rust-lang.github.io/rustup/overrides.html> for more
           information about how toolchain overrides work.

       --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
           <https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides>
           for more information.

       -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 appear before the command name, for example cargo -C
           path/to/my-project build.

           This option is only available on the nightly channel
           <https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and
           requires the -Z unstable-options flag to enable (see #10098
           <https://github.com/rust-lang/cargo/issues/10098>).

       -h, --help
           Prints help information.

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

ENVIRONMENT
       See the reference
       <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
       for details on environment variables that Cargo reads.

EXIT STATUS
       o  0: Cargo succeeded.

       o  101: Cargo failed to complete.

EXAMPLES
       1. Update all dependencies in the lockfile:

              cargo update

       2. Update only specific dependencies:

              cargo update foo bar

       3. Set a specific dependency to a specific version:

              cargo update foo --precise 1.2.3

SEE ALSO
       cargo(1), cargo-generate-lockfile(1)