Skip to content

Commit d56af31

Browse files
borsbors
committed
Auto merge of #6934 - ehuss:stabilize-offline, r=alexcrichton
Stabilize offline mode. This stabilizes the `--offline` flag as detailed at #5655 (comment). It also adds the `net.offline` config value. Closes #5655 Closes #4686
2 parents 02f93ea + 309eb87 commit d56af31

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+803
-97
lines changed

‎src/bin/cargo/cli.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ Available unstable (nightly-only) flags:
3232
-Z avoid-dev-deps -- Avoid installing dev-dependencies if possible
3333
-Z minimal-versions -- Install minimal dependency versions instead of maximum
3434
-Z no-index-update -- Do not update the registry, avoids a network request for benchmarking
35-
-Z offline -- Offline mode that does not perform network requests
3635
-Z unstable-options -- Allow the usage of unstable options such as --registry
3736
-Z config-profile -- Read profiles from .cargo/config files
3837
-Z install-upgrade -- `cargo install` will upgrade instead of failing
@@ -168,6 +167,7 @@ fn execute_subcommand(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
168167
&args.value_of("color").map(|s| s.to_string()),
169168
args.is_present("frozen"),
170169
args.is_present("locked"),
170+
args.is_present("offline"),
171171
arg_target_dir,
172172
&args
173173
.values_of_lossy("unstable-features")
@@ -239,6 +239,7 @@ See 'cargo help <command>' for more information on a specific command.\n",
239239
)
240240
.arg(opt("frozen", "Require Cargo.lock and cache are up to date").global(true))
241241
.arg(opt("locked", "Require Cargo.lock is up to date").global(true))
242+
.arg(opt("offline", "Run without accessing the network").global(true))
242243
.arg(
243244
Arg::with_name("unstable-features")
244245
.help("Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details")

‎src/cargo/core/features.rs

-2
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,6 @@ impl Features {
322322
pub struct CliUnstable {
323323
pub print_im_a_teapot: bool,
324324
pub unstable_options: bool,
325-
pub offline: bool,
326325
pub no_index_update: bool,
327326
pub avoid_dev_deps: bool,
328327
pub minimal_versions: bool,
@@ -367,7 +366,6 @@ impl CliUnstable {
367366
match k {
368367
"print-im-a-teapot" => self.print_im_a_teapot = parse_bool(v)?,
369368
"unstable-options" => self.unstable_options = true,
370-
"offline" => self.offline = true,
371369
"no-index-update" => self.no_index_update = true,
372370
"avoid-dev-deps" => self.avoid_dev_deps = true,
373371
"minimal-versions" => self.minimal_versions = true,

‎src/cargo/core/resolver/errors.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -299,9 +299,9 @@ pub(super) fn activation_error(
299299
};
300300

301301
if let Some(config) = config {
302-
if config.cli_unstable().offline {
302+
if config.offline() {
303303
msg.push_str(
304-
"\nAs a reminder, you're using offline mode (-Z offline) \
304+
"\nAs a reminder, you're using offline mode (--offline) \
305305
which can sometimes cause surprising resolution failures, \
306306
if this error is too confusing you may wish to retry \
307307
without the offline flag.",

‎src/cargo/ops/cargo_generate_lockfile.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ pub fn update_lockfile(ws: &Workspace<'_>, opts: &UpdateOptions<'_>) -> CargoRes
3636
failure::bail!("you can't generate a lockfile for an empty workspace.")
3737
}
3838

39-
if opts.config.cli_unstable().offline {
39+
if opts.config.offline() {
4040
failure::bail!("you can't update in the offline mode");
4141
}
4242

‎src/cargo/ops/lockfile.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ pub fn write_pkg_lockfile(ws: &Workspace<'_>, resolve: &Resolve) -> CargoResult<
4747
}
4848

4949
if !ws.config().lock_update_allowed() {
50-
if ws.config().cli_unstable().offline {
50+
if ws.config().offline() {
5151
failure::bail!("can't update in the offline mode");
5252
}
5353

‎src/cargo/sources/git/source.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,9 @@ impl<'cfg> Source for GitSource<'cfg> {
158158
let git_path = self.config.assert_package_cache_locked(&git_path);
159159
let db_path = git_path.join("db").join(&self.ident);
160160

161-
if self.config.cli_unstable().offline && !db_path.exists() {
161+
if self.config.offline() && !db_path.exists() {
162162
failure::bail!(
163-
"can't checkout from '{}': you are in the offline mode (-Z offline)",
163+
"can't checkout from '{}': you are in the offline mode (--offline)",
164164
self.remote.url()
165165
);
166166
}
@@ -172,7 +172,7 @@ impl<'cfg> Source for GitSource<'cfg> {
172172
let actual_rev = self.remote.rev_for(&db_path, &self.reference);
173173
let should_update = actual_rev.is_err() || self.source_id.precise().is_none();
174174

175-
let (db, actual_rev) = if should_update && !self.config.cli_unstable().offline {
175+
let (db, actual_rev) = if should_update && !self.config.offline() {
176176
self.config.shell().status(
177177
"Updating",
178178
format!("git repository `{}`", self.remote.url()),

‎src/cargo/sources/registry/index.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ impl<'cfg> RegistryIndex<'cfg> {
363363
yanked_whitelist: &HashSet<PackageId>,
364364
f: &mut dyn FnMut(Summary),
365365
) -> CargoResult<()> {
366-
if self.config.cli_unstable().offline
366+
if self.config.offline()
367367
&& self.query_inner_with_online(dep, load, yanked_whitelist, f, false)? != 0
368368
{
369369
return Ok(());

‎src/cargo/sources/registry/remote.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ impl<'cfg> RegistryData for RemoteRegistry<'cfg> {
182182
}
183183

184184
fn update_index(&mut self) -> CargoResult<()> {
185-
if self.config.cli_unstable().offline {
185+
if self.config.offline() {
186186
if self.repo()?.is_empty()? {
187187
// An empty repository is guaranteed to fail, since hitting
188188
// this path means we need at least one crate. This is an

‎src/cargo/util/config.rs

+19-3
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,15 @@ pub struct Config {
5252
rustdoc: LazyCell<PathBuf>,
5353
/// Whether we are printing extra verbose messages
5454
extra_verbose: bool,
55-
/// `frozen` is set if we shouldn't access the network
55+
/// `frozen` is the same as `locked`, but additionally will not access the
56+
/// network to determine if the lock file is out-of-date.
5657
frozen: bool,
57-
/// `locked` is set if we should not update lock files
58+
/// `locked` is set if we should not update lock files. If the lock file
59+
/// is missing, or needs to be updated, an error is produced.
5860
locked: bool,
61+
/// `offline` is set if we should never access the network, but otherwise
62+
/// continue operating if possible.
63+
offline: bool,
5964
/// A global static IPC control mechanism (used for managing parallel builds)
6065
jobserver: Option<jobserver::Client>,
6166
/// Cli flags of the form "-Z something"
@@ -119,6 +124,7 @@ impl Config {
119124
extra_verbose: false,
120125
frozen: false,
121126
locked: false,
127+
offline: false,
122128
jobserver: unsafe {
123129
if GLOBAL_JOBSERVER.is_null() {
124130
None
@@ -560,6 +566,7 @@ impl Config {
560566
color: &Option<String>,
561567
frozen: bool,
562568
locked: bool,
569+
offline: bool,
563570
target_dir: &Option<PathBuf>,
564571
unstable_flags: &[String],
565572
) -> CargoResult<()> {
@@ -604,6 +611,11 @@ impl Config {
604611
self.extra_verbose = extra_verbose;
605612
self.frozen = frozen;
606613
self.locked = locked;
614+
self.offline = offline
615+
|| self
616+
.get::<Option<bool>>("net.offline")
617+
.unwrap_or(None)
618+
.unwrap_or(false);
607619
self.target_dir = cli_target_dir;
608620
self.cli_flags.parse(unstable_flags)?;
609621

@@ -619,7 +631,11 @@ impl Config {
619631
}
620632

621633
pub fn network_allowed(&self) -> bool {
622-
!self.frozen() && !self.cli_unstable().offline
634+
!self.frozen() && !self.offline()
635+
}
636+
637+
pub fn offline(&self) -> bool {
638+
self.offline
623639
}
624640

625641
pub fn frozen(&self) -> bool {

‎src/doc/man/cargo-fetch.adoc

+4
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ file before fetching the dependencies.
2323

2424
If `--target` is not specified, then all target dependencies are fetched.
2525

26+
See also the link:https://crates.io/crates/cargo-prefetch[cargo-prefetch]
27+
plugin which adds a command to download popular crates. This may be useful if
28+
you plan to use Cargo without a network with the `--offline` flag.
29+
2630
== OPTIONS
2731

2832
=== Fetch options

‎src/doc/man/cargo-install.adoc

+4
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ include::options-target-triple.adoc[]
100100
*--debug*::
101101
Build with the `dev` profile instead the `release` profile.
102102

103+
=== Manifest Options
104+
105+
include::options-locked.adoc[]
106+
103107
=== Miscellaneous Options
104108

105109
include::options-jobs.adoc[]

‎src/doc/man/generated/cargo-bench.html

+17
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,23 @@ <h3 id="cargo_bench_manifest_options">Manifest Options</h3>
341341
access.</p>
342342
</div>
343343
</dd>
344+
<dt class="hdlist1"><strong>--offline</strong></dt>
345+
<dd>
346+
<p>Prevents Cargo from accessing the network for any reason. Without this
347+
flag, Cargo will stop with an error if it needs to access the network and
348+
the network is not available. With this flag, Cargo will attempt to
349+
proceed without the network if possible.</p>
350+
<div class="paragraph">
351+
<p>Beware that this may result in different dependency resolution than online
352+
mode. Cargo will restrict itself to crates that are downloaded locally, even
353+
if there might be a newer version as indicated in the local copy of the index.
354+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
355+
offline.</p>
356+
</div>
357+
<div class="paragraph">
358+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
359+
</div>
360+
</dd>
344361
</dl>
345362
</div>
346363
</div>

‎src/doc/man/generated/cargo-build.html

+17
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,23 @@ <h3 id="cargo_build_manifest_options">Manifest Options</h3>
286286
access.</p>
287287
</div>
288288
</dd>
289+
<dt class="hdlist1"><strong>--offline</strong></dt>
290+
<dd>
291+
<p>Prevents Cargo from accessing the network for any reason. Without this
292+
flag, Cargo will stop with an error if it needs to access the network and
293+
the network is not available. With this flag, Cargo will attempt to
294+
proceed without the network if possible.</p>
295+
<div class="paragraph">
296+
<p>Beware that this may result in different dependency resolution than online
297+
mode. Cargo will restrict itself to crates that are downloaded locally, even
298+
if there might be a newer version as indicated in the local copy of the index.
299+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
300+
offline.</p>
301+
</div>
302+
<div class="paragraph">
303+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
304+
</div>
305+
</dd>
289306
</dl>
290307
</div>
291308
</div>

‎src/doc/man/generated/cargo-check.html

+17
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,23 @@ <h3 id="cargo_check_manifest_options">Manifest Options</h3>
277277
access.</p>
278278
</div>
279279
</dd>
280+
<dt class="hdlist1"><strong>--offline</strong></dt>
281+
<dd>
282+
<p>Prevents Cargo from accessing the network for any reason. Without this
283+
flag, Cargo will stop with an error if it needs to access the network and
284+
the network is not available. With this flag, Cargo will attempt to
285+
proceed without the network if possible.</p>
286+
<div class="paragraph">
287+
<p>Beware that this may result in different dependency resolution than online
288+
mode. Cargo will restrict itself to crates that are downloaded locally, even
289+
if there might be a newer version as indicated in the local copy of the index.
290+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
291+
offline.</p>
292+
</div>
293+
<div class="paragraph">
294+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
295+
</div>
296+
</dd>
280297
</dl>
281298
</div>
282299
</div>

‎src/doc/man/generated/cargo-clean.html

+17
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,23 @@ <h3 id="cargo_clean_manifest_options">Manifest Options</h3>
141141
access.</p>
142142
</div>
143143
</dd>
144+
<dt class="hdlist1"><strong>--offline</strong></dt>
145+
<dd>
146+
<p>Prevents Cargo from accessing the network for any reason. Without this
147+
flag, Cargo will stop with an error if it needs to access the network and
148+
the network is not available. With this flag, Cargo will attempt to
149+
proceed without the network if possible.</p>
150+
<div class="paragraph">
151+
<p>Beware that this may result in different dependency resolution than online
152+
mode. Cargo will restrict itself to crates that are downloaded locally, even
153+
if there might be a newer version as indicated in the local copy of the index.
154+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
155+
offline.</p>
156+
</div>
157+
<div class="paragraph">
158+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
159+
</div>
160+
</dd>
144161
</dl>
145162
</div>
146163
</div>

‎src/doc/man/generated/cargo-doc.html

+17
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,23 @@ <h3 id="cargo_doc_manifest_options">Manifest Options</h3>
245245
access.</p>
246246
</div>
247247
</dd>
248+
<dt class="hdlist1"><strong>--offline</strong></dt>
249+
<dd>
250+
<p>Prevents Cargo from accessing the network for any reason. Without this
251+
flag, Cargo will stop with an error if it needs to access the network and
252+
the network is not available. With this flag, Cargo will attempt to
253+
proceed without the network if possible.</p>
254+
<div class="paragraph">
255+
<p>Beware that this may result in different dependency resolution than online
256+
mode. Cargo will restrict itself to crates that are downloaded locally, even
257+
if there might be a newer version as indicated in the local copy of the index.
258+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
259+
offline.</p>
260+
</div>
261+
<div class="paragraph">
262+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
263+
</div>
264+
</dd>
248265
</dl>
249266
</div>
250267
</div>

‎src/doc/man/generated/cargo-fetch.html

+22
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ <h2 id="cargo_fetch_description">DESCRIPTION</h2>
2626
<div class="paragraph">
2727
<p>If <code>--target</code> is not specified, then all target dependencies are fetched.</p>
2828
</div>
29+
<div class="paragraph">
30+
<p>See also the <a href="https://crates.io/crates/cargo-prefetch">cargo-prefetch</a>
31+
plugin which adds a command to download popular crates. This may be useful if
32+
you plan to use Cargo without a network with the <code>--offline</code> flag.</p>
33+
</div>
2934
</div>
3035
</div>
3136
<div class="sect1">
@@ -113,6 +118,23 @@ <h3 id="cargo_fetch_manifest_options">Manifest Options</h3>
113118
access.</p>
114119
</div>
115120
</dd>
121+
<dt class="hdlist1"><strong>--offline</strong></dt>
122+
<dd>
123+
<p>Prevents Cargo from accessing the network for any reason. Without this
124+
flag, Cargo will stop with an error if it needs to access the network and
125+
the network is not available. With this flag, Cargo will attempt to
126+
proceed without the network if possible.</p>
127+
<div class="paragraph">
128+
<p>Beware that this may result in different dependency resolution than online
129+
mode. Cargo will restrict itself to crates that are downloaded locally, even
130+
if there might be a newer version as indicated in the local copy of the index.
131+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
132+
offline.</p>
133+
</div>
134+
<div class="paragraph">
135+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
136+
</div>
137+
</dd>
116138
</dl>
117139
</div>
118140
</div>

‎src/doc/man/generated/cargo-fix.html

+17
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,23 @@ <h3 id="cargo_fix_manifest_options">Manifest Options</h3>
348348
access.</p>
349349
</div>
350350
</dd>
351+
<dt class="hdlist1"><strong>--offline</strong></dt>
352+
<dd>
353+
<p>Prevents Cargo from accessing the network for any reason. Without this
354+
flag, Cargo will stop with an error if it needs to access the network and
355+
the network is not available. With this flag, Cargo will attempt to
356+
proceed without the network if possible.</p>
357+
<div class="paragraph">
358+
<p>Beware that this may result in different dependency resolution than online
359+
mode. Cargo will restrict itself to crates that are downloaded locally, even
360+
if there might be a newer version as indicated in the local copy of the index.
361+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
362+
offline.</p>
363+
</div>
364+
<div class="paragraph">
365+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
366+
</div>
367+
</dd>
351368
</dl>
352369
</div>
353370
</div>

‎src/doc/man/generated/cargo-generate-lockfile.html

+17
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,23 @@ <h3 id="cargo_generate_lockfile_manifest_options">Manifest Options</h3>
9191
access.</p>
9292
</div>
9393
</dd>
94+
<dt class="hdlist1"><strong>--offline</strong></dt>
95+
<dd>
96+
<p>Prevents Cargo from accessing the network for any reason. Without this
97+
flag, Cargo will stop with an error if it needs to access the network and
98+
the network is not available. With this flag, Cargo will attempt to
99+
proceed without the network if possible.</p>
100+
<div class="paragraph">
101+
<p>Beware that this may result in different dependency resolution than online
102+
mode. Cargo will restrict itself to crates that are downloaded locally, even
103+
if there might be a newer version as indicated in the local copy of the index.
104+
See the <a href="commands/cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
105+
offline.</p>
106+
</div>
107+
<div class="paragraph">
108+
<p>May also be specified with the <code>net.offline</code> <a href="reference/config.html">config value</a>.</p>
109+
</div>
110+
</dd>
94111
</dl>
95112
</div>
96113
</div>

0 commit comments

Comments
 (0)