Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Hide cargo-fetch description in offline man page #13364

Merged
merged 1 commit into from
Jan 31, 2024
Merged

doc: Hide cargo-fetch description in offline man page #13364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/doc/man/generated_txt/cargo-fetch.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@ OPTIONS
Beware that this may result in different dependency resolution than
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beware that this may result in different dependency resolution than
Comment online mode

Haven't tested it. If this statement is true, we may want to keep this, as it makes a huge difference between with and without --offline.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the cargo-fetch(1)
command to download dependencies before going offline.

I may have taken too big a step, and the original problem may have just been to remove this

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.
indicated in the local copy of the index.

May also be specified with the net.offline config value
<https://doc.rust-lang.org/cargo/reference/config.html>.
Expand Down
4 changes: 3 additions & 1 deletion src/doc/man/includes/options-locked.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,10 @@ 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.
{{#if (ne command "fetch")}}
See the {{man "cargo-fetch" 1}} command to download dependencies before going
offline.
{{/if}}

May also be specified with the `net.offline` [config value](../reference/config.html).
{{/option}}
{{/option}}
4 changes: 1 addition & 3 deletions src/doc/src/commands/cargo-fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,7 @@ the network is not available. With this flag, Cargo will attempt to
proceed without the network if possible.</p>
<p>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 <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going
offline.</p>
if there might be a newer version as indicated in the local copy of the index.</p>
<p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</dd>

</dl>
Expand Down
2 changes: 0 additions & 2 deletions src/etc/man/cargo-fetch.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,6 @@ 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 \fBcargo\-fetch\fR(1) command to download dependencies before going
offline.
.sp
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
.RE
Expand Down