diff options
Diffstat (limited to 'src/doc/man/includes/options-locked.md')
-rw-r--r-- | src/doc/man/includes/options-locked.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/doc/man/includes/options-locked.md b/src/doc/man/includes/options-locked.md new file mode 100644 index 0000000..c9ac952 --- /dev/null +++ b/src/doc/man/includes/options-locked.md @@ -0,0 +1,25 @@ +{{#option "`--frozen`" "`--locked`"}} +Either of these flags requires that the `Cargo.lock` file is +up-to-date. If the lock file is missing, or it needs to be updated, Cargo will +exit with an error. The `--frozen` flag also prevents Cargo from +attempting to access the network to determine if it is out-of-date. + +These may be used in environments where you want to assert that the +`Cargo.lock` file is up-to-date (such as a CI build) or want to avoid network +access. +{{/option}} + +{{#option "`--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 {{man "cargo-fetch" 1}} command to download dependencies before going +offline. + +May also be specified with the `net.offline` [config value](../reference/config.html). +{{/option}} |