From b119b891df93f128abef634215cd8f967c3cd120 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Mon, 15 Jul 2019 16:10:06 -0700 Subject: [PATCH] Update mdbook to 0.3. This updates to mdbook 0.3 which uses relative links, which are much better (the pages mostly work when viewing on GitHub for example). --- .travis.yml | 2 +- src/doc/README.md | 2 +- src/doc/asciidoc-extension.rb | 9 +-- src/doc/book.toml | 4 ++ src/doc/man/generated/cargo-bench.html | 24 +++---- src/doc/man/generated/cargo-build.html | 22 +++--- src/doc/man/generated/cargo-check.html | 22 +++--- src/doc/man/generated/cargo-clean.html | 18 ++--- src/doc/man/generated/cargo-doc.html | 22 +++--- src/doc/man/generated/cargo-fetch.html | 14 ++-- src/doc/man/generated/cargo-fix.html | 24 +++---- .../generated/cargo-generate-lockfile.html | 14 ++-- src/doc/man/generated/cargo-help.html | 2 +- src/doc/man/generated/cargo-init.html | 14 ++-- src/doc/man/generated/cargo-install.html | 20 +++--- .../man/generated/cargo-locate-project.html | 10 +-- src/doc/man/generated/cargo-login.html | 12 ++-- src/doc/man/generated/cargo-metadata.html | 14 ++-- src/doc/man/generated/cargo-new.html | 14 ++-- src/doc/man/generated/cargo-owner.html | 18 ++--- src/doc/man/generated/cargo-package.html | 22 +++--- src/doc/man/generated/cargo-pkgid.html | 12 ++-- src/doc/man/generated/cargo-publish.html | 30 ++++---- src/doc/man/generated/cargo-run.html | 22 +++--- src/doc/man/generated/cargo-rustc.html | 24 +++---- src/doc/man/generated/cargo-rustdoc.html | 22 +++--- src/doc/man/generated/cargo-search.html | 10 +-- src/doc/man/generated/cargo-test.html | 22 +++--- src/doc/man/generated/cargo-uninstall.html | 14 ++-- src/doc/man/generated/cargo-update.html | 16 ++--- src/doc/man/generated/cargo-vendor.html | 25 +++++-- .../man/generated/cargo-verify-project.html | 12 ++-- src/doc/man/generated/cargo-version.html | 2 +- src/doc/man/generated/cargo-yank.html | 16 ++--- src/doc/man/generated/cargo.html | 72 +++++++++---------- src/doc/src/appendix/glossary.md | 44 ++++++------ src/doc/src/faq.md | 8 +-- src/doc/src/getting-started/first-steps.md | 2 +- src/doc/src/getting-started/index.md | 4 +- src/doc/src/guide/cargo-toml-vs-cargo-lock.md | 4 +- src/doc/src/guide/dependencies.md | 2 +- src/doc/src/guide/index.md | 18 ++--- src/doc/src/guide/project-layout.md | 2 +- src/doc/src/guide/tests.md | 2 +- src/doc/src/index.md | 8 +-- src/doc/src/reference/build-scripts.md | 6 +- src/doc/src/reference/config.md | 10 +-- .../src/reference/environment-variables.md | 10 +-- src/doc/src/reference/index.md | 20 +++--- src/doc/src/reference/manifest.md | 28 ++++---- src/doc/src/reference/publishing.md | 16 ++--- src/doc/src/reference/registries.md | 14 ++-- src/doc/src/reference/source-replacement.md | 8 +-- .../src/reference/specifying-dependencies.md | 18 ++--- src/doc/src/reference/unstable.md | 2 +- 55 files changed, 425 insertions(+), 403 deletions(-) diff --git a/.travis.yml b/.travis.yml index 1eceab89b0d..020002e5a26 100644 --- a/.travis.yml +++ b/.travis.yml @@ -42,7 +42,7 @@ matrix: ALT=i686-unknown-linux-gnu rust: nightly install: - - travis_retry curl -Lf https://github.com/rust-lang-nursery/mdBook/releases/download/v0.1.7/mdbook-v0.1.7-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=$HOME/.cargo/bin + - travis_retry curl -Lf https://github.com/rust-lang-nursery/mdBook/releases/download/v0.3.1/mdbook-v0.3.1-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=$HOME/.cargo/bin script: - cargo test --features=deny-warnings || travis_terminate 1 - cargo doc --no-deps || travis_terminate 1 diff --git a/src/doc/README.md b/src/doc/README.md index 983c9669355..d4d334658bc 100644 --- a/src/doc/README.md +++ b/src/doc/README.md @@ -5,7 +5,7 @@ Building the book requires [mdBook]. To get it: -[mdBook]: https://github.com/azerupi/mdBook +[mdBook]: https://github.com/rust-lang-nursery/mdBook ```console $ cargo install mdbook diff --git a/src/doc/asciidoc-extension.rb b/src/doc/asciidoc-extension.rb index 6e662639c1f..87f4f2a2731 100644 --- a/src/doc/asciidoc-extension.rb +++ b/src/doc/asciidoc-extension.rb @@ -29,9 +29,9 @@ def process parent, target, attrs elsif manname == 'rustdoc' html_target = 'https://doc.rust-lang.org/rustdoc/index.html' elsif manname == 'cargo' - html_target = 'commands/index.html' + html_target = 'index.html' else - html_target = %(commands/#{manname}.html) + html_target = %(#{manname}.html) end %(#{(create_anchor parent, text, type: :link, target: html_target).render}) elsif parent.document.backend == 'manpage' @@ -44,8 +44,8 @@ def process parent, target, attrs # Creates a link to something in the cargo documentation. # -# For HTML this creates a relative link (using mdbook's 0.1's base-style -# links). For the man page it gives a direct link to doc.rust-lang.org. +# For HTML this creates a relative link. For the man page it gives a direct +# link to doc.rust-lang.org. # # Usage # @@ -60,6 +60,7 @@ class LinkCargoInlineMacro < Extensions::InlineMacroProcessor def process parent, target, attrs text = attrs['text'] if parent.document.basebackend? 'html' + target = %(../#{target}) parent.document.register :links, target %(#{(create_anchor parent, text, type: :link, target: target).render}) elsif parent.document.backend == 'manpage' diff --git a/src/doc/book.toml b/src/doc/book.toml index 1f21e1e2e7b..8ba2656ec44 100644 --- a/src/doc/book.toml +++ b/src/doc/book.toml @@ -1,2 +1,6 @@ +[book] title = "The Cargo Book" author = "Alex Crichton, Steve Klabnik and Carol Nichols, with Contributions from the Rust Community" + +[output.html] +git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src" diff --git a/src/doc/man/generated/cargo-bench.html b/src/doc/man/generated/cargo-bench.html index 668821915b4..dc00b1fe104 100644 --- a/src/doc/man/generated/cargo-bench.html +++ b/src/doc/man/generated/cargo-bench.html @@ -80,7 +80,7 @@

Package Selection

-p SPEC…​
--package SPEC…​
-

Benchmark only the specified packages. See cargo-pkgid(1) for the +

Benchmark only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.

--all
@@ -230,7 +230,7 @@

Compilation Options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

@@ -244,7 +244,7 @@

Output Options

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

@@ -270,7 +270,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -296,7 +296,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

--message-format FMT
@@ -351,11 +351,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -391,7 +391,7 @@

Miscellaneous Options

--jobs N

Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

@@ -405,7 +405,7 @@

PROFILES

Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

@@ -416,7 +416,7 @@

PROFILES

If you need a debug build of a benchmark, try building it with -cargo-build(1) which will use the test profile which is by default +cargo-build(1) which will use the test profile which is by default unoptimized and includes debug information. You can then run the debug-enabled benchmark manually.

@@ -426,7 +426,7 @@

PROFILES

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -477,7 +477,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-test(1)

+

cargo(1), cargo-test(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-build.html b/src/doc/man/generated/cargo-build.html index c008fc59d88..593d454caa5 100644 --- a/src/doc/man/generated/cargo-build.html +++ b/src/doc/man/generated/cargo-build.html @@ -36,7 +36,7 @@

Package Selection

-p SPEC…​
--package SPEC…​
-

Build only the specified packages. See cargo-pkgid(1) for the +

Build only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.

--all
@@ -159,7 +159,7 @@

Compilation Options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

--release
@@ -178,7 +178,7 @@

Output Options

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

--out-dir DIRECTORY
@@ -204,7 +204,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -230,7 +230,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

--message-format FMT
@@ -296,11 +296,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -331,7 +331,7 @@

Miscellaneous Options

--jobs N

Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

@@ -345,7 +345,7 @@

PROFILES

Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

@@ -389,7 +389,7 @@

PROFILES

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -440,7 +440,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-rustc(1)

+

cargo(1), cargo-rustc(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-check.html b/src/doc/man/generated/cargo-check.html index 1dcdfa8ac2a..01e43427099 100644 --- a/src/doc/man/generated/cargo-check.html +++ b/src/doc/man/generated/cargo-check.html @@ -40,7 +40,7 @@

Package Selection

-p SPEC…​
--package SPEC…​
-

Check only the specified packages. See cargo-pkgid(1) for the +

Check only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.

--all
@@ -163,7 +163,7 @@

Compilation Options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

--release
@@ -190,7 +190,7 @@

Output Options

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

@@ -206,7 +206,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -232,7 +232,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

--message-format FMT
@@ -287,11 +287,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -322,7 +322,7 @@

Miscellaneous Options

--jobs N

Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

@@ -336,7 +336,7 @@

PROFILES

Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

@@ -380,7 +380,7 @@

PROFILES

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -431,7 +431,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-build(1)

+

cargo(1), cargo-build(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-clean.html b/src/doc/man/generated/cargo-clean.html index 90952b2a8e4..5a9208babc3 100644 --- a/src/doc/man/generated/cargo-clean.html +++ b/src/doc/man/generated/cargo-clean.html @@ -37,7 +37,7 @@

Package Selection

--package SPEC…​

Clean only the specified packages. This flag may be specified -multiple times. See cargo-pkgid(1) for the SPEC format.

+multiple times. See cargo-pkgid(1) for the SPEC format.

@@ -60,7 +60,7 @@

Clean Options

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

--target TRIPLE
@@ -71,7 +71,7 @@

Clean Options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

@@ -87,7 +87,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -113,7 +113,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

@@ -151,11 +151,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -184,7 +184,7 @@

Common Options

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -235,7 +235,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-build(1)

+

cargo(1), cargo-build(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-doc.html b/src/doc/man/generated/cargo-doc.html index 5c0b6d621f6..1b07f0f94b2 100644 --- a/src/doc/man/generated/cargo-doc.html +++ b/src/doc/man/generated/cargo-doc.html @@ -56,7 +56,7 @@

Package Selection

-p SPEC…​
--package SPEC…​
-

Document only the specified packages. See cargo-pkgid(1) for the +

Document only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.

--all
@@ -139,7 +139,7 @@

Compilation Options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

--release
@@ -158,7 +158,7 @@

Output Options

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

@@ -174,7 +174,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -200,7 +200,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

--message-format FMT
@@ -255,11 +255,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -290,7 +290,7 @@

Miscellaneous Options

--jobs N

Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

@@ -304,7 +304,7 @@

PROFILES

Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

@@ -348,7 +348,7 @@

PROFILES

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -392,7 +392,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-rustdoc(1), rustdoc(1)

+

cargo(1), cargo-rustdoc(1), rustdoc(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-fetch.html b/src/doc/man/generated/cargo-fetch.html index 716d0b3942a..3a1e304702d 100644 --- a/src/doc/man/generated/cargo-fetch.html +++ b/src/doc/man/generated/cargo-fetch.html @@ -48,7 +48,7 @@

Fetch options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

@@ -64,7 +64,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -90,7 +90,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

@@ -128,11 +128,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -161,7 +161,7 @@

Common Options

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -204,7 +204,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-update(1), cargo-generate-lockfile(1)

+

cargo(1), cargo-update(1), cargo-generate-lockfile(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-fix.html b/src/doc/man/generated/cargo-fix.html index e7c15215d7f..3f870dad4e0 100644 --- a/src/doc/man/generated/cargo-fix.html +++ b/src/doc/man/generated/cargo-fix.html @@ -22,7 +22,7 @@

DESCRIPTION

to worry about any breakage.

-

Executing cargo fix will under the hood execute cargo-check(1). Any warnings +

Executing cargo fix will under the hood execute cargo-check(1). Any warnings applicable to your crate will be automatically fixed (if possible) and all remaining warnings will be displayed when the check process is finished. For example if you’d like to prepare for the 2018 edition, you can do so by @@ -111,7 +111,7 @@

Package Selection

-p SPEC…​
--package SPEC…​
-

Fix only the specified packages. See cargo-pkgid(1) for the +

Fix only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.

--all
@@ -234,7 +234,7 @@

Compilation Options

list of supported targets.

This may also be specified with the build.target -config value.

+config value.

--release
@@ -261,7 +261,7 @@

Output Options

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

@@ -277,7 +277,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -303,7 +303,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

--message-format FMT
@@ -358,11 +358,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -393,7 +393,7 @@

Miscellaneous Options

--jobs N

Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

@@ -407,7 +407,7 @@

PROFILES

Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

@@ -451,7 +451,7 @@

PROFILES

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -510,7 +510,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-check(1)

+

cargo(1), cargo-check(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-generate-lockfile.html b/src/doc/man/generated/cargo-generate-lockfile.html index 1d223f35d1a..8cd2c8f65e5 100644 --- a/src/doc/man/generated/cargo-generate-lockfile.html +++ b/src/doc/man/generated/cargo-generate-lockfile.html @@ -19,7 +19,7 @@

DESCRIPTION

manifest changes or dependency updates.

-

See also cargo-update(1) which is also capable of creating a Cargo.lock +

See also cargo-update(1) which is also capable of creating a Cargo.lock lockfile and has more options for controlling update behavior.

@@ -37,7 +37,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -63,7 +63,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

@@ -101,11 +101,11 @@

Manifest Options

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 +See the cargo-fetch(1) command to download dependencies before going offline.

-

May also be specified with the net.offline config value.

+

May also be specified with the net.offline config value.

@@ -134,7 +134,7 @@

Common Options

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -177,7 +177,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-update(1)

+

cargo(1), cargo-update(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-help.html b/src/doc/man/generated/cargo-help.html index 29c367ccd24..0bdceebd1c9 100644 --- a/src/doc/man/generated/cargo-help.html +++ b/src/doc/man/generated/cargo-help.html @@ -47,7 +47,7 @@

EXAMPLES

SEE ALSO

-

cargo(1)

+

cargo(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-init.html b/src/doc/man/generated/cargo-init.html index 979b330a4d4..3af33f63677 100644 --- a/src/doc/man/generated/cargo-init.html +++ b/src/doc/man/generated/cargo-init.html @@ -85,11 +85,11 @@

DESCRIPTION

-

See the reference for more information about +

See the reference for more information about configuration files.

-

See cargo-new(1) for a similar command which will create a new package in +

See cargo-new(1) for a similar command which will create a new package in a new directory.

@@ -131,7 +131,7 @@

Init Options

This sets the publish field in Cargo.toml to the given registry name which will restrict publishing only to that registry.

-

Registry names are defined in Cargo config files. +

Registry names are defined in Cargo config files. If not specified, the default registry defined by the registry.default config key is used. If the default registry is not set and --registry is not used, the publish field will not be set which means that publishing will not @@ -151,7 +151,7 @@

Display Options

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.

+config value.

-q
--quiet
@@ -177,7 +177,7 @@

Display Options

May also be specified with the term.color -config value.

+config value.

@@ -206,7 +206,7 @@

Common Options

ENVIRONMENT

-

See the reference for +

See the reference for details on environment variables that Cargo reads.

@@ -249,7 +249,7 @@

EXAMPLES

SEE ALSO

-

cargo(1), cargo-new(1)

+

cargo(1), cargo-new(1)

\ No newline at end of file diff --git a/src/doc/man/generated/cargo-install.html b/src/doc/man/generated/cargo-install.html index 922eedab8df..5c567e898c6 100644 --- a/src/doc/man/generated/cargo-install.html +++ b/src/doc/man/generated/cargo-install.html @@ -34,7 +34,7 @@

DESCRIPTION

CARGO_INSTALL_ROOT environment variable

  • -

    install.root Cargo config value

    +

    install.root Cargo config value

  • CARGO_HOME environment variable

    @@ -147,7 +147,7 @@

    Install Options

    --registry REGISTRY
    -

    Name of the registry to use. Registry names are defined in Cargo config files. +

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

    @@ -192,7 +192,7 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --debug
    @@ -229,11 +229,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -247,7 +247,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -263,7 +263,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -289,7 +289,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -318,7 +318,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -369,7 +369,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-uninstall(1), cargo-search(1), cargo-publish(1)

    +

    cargo(1), cargo-uninstall(1), cargo-search(1), cargo-publish(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-locate-project.html b/src/doc/man/generated/cargo-locate-project.html index 42dfa876b66..f4d8d8b971f 100644 --- a/src/doc/man/generated/cargo-locate-project.html +++ b/src/doc/man/generated/cargo-locate-project.html @@ -18,7 +18,7 @@

    DESCRIPTION

    Cargo.toml manifest.

    -

    See also cargo-metadata(1) which is capable of returning the path to a +

    See also cargo-metadata(1) which is capable of returning the path to a workspace root.

    @@ -36,7 +36,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -62,7 +62,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -103,7 +103,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -146,7 +146,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-metadata(1)

    +

    cargo(1), cargo-metadata(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-login.html b/src/doc/man/generated/cargo-login.html index b44377b34a4..d913311730e 100644 --- a/src/doc/man/generated/cargo-login.html +++ b/src/doc/man/generated/cargo-login.html @@ -15,7 +15,7 @@

    DESCRIPTION

    This command will save the API token to disk so that commands that require -authentication, such as cargo-publish(1), will be automatically +authentication, such as cargo-publish(1), will be automatically authenticated. The token is saved in $CARGO_HOME/credentials. CARGO_HOME defaults to .cargo in your home directory.

    @@ -39,7 +39,7 @@

    Login Options

    --registry REGISTRY
    -

    Name of the registry to use. Registry names are defined in Cargo config files. +

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

    @@ -56,7 +56,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -82,7 +82,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -111,7 +111,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -154,7 +154,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-publish(1)

    +

    cargo(1), cargo-publish(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-metadata.html b/src/doc/man/generated/cargo-metadata.html index 007f7ff81f9..9a0cfc7d314 100644 --- a/src/doc/man/generated/cargo-metadata.html +++ b/src/doc/man/generated/cargo-metadata.html @@ -35,7 +35,7 @@

    OUTPUT FORMAT

    -
    {
+
    {
     /* Array of all packages in the workspace.
        It also includes all feature-enabled dependencies unless --no-deps is used.
     */
@@ -313,7 +313,7 @@ 
    Display Options
    
 
    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.
    
+config value.
    
 
 
    -q
    
 
    --quiet
    
@@ -339,7 +339,7 @@ 
    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -377,11 +377,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -410,7 +410,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -453,7 +453,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1)

    +

    cargo(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-new.html b/src/doc/man/generated/cargo-new.html index adf6c46d7a8..87e7708479c 100644 --- a/src/doc/man/generated/cargo-new.html +++ b/src/doc/man/generated/cargo-new.html @@ -78,11 +78,11 @@

    DESCRIPTION

    -

    See the reference for more information about +

    See the reference for more information about configuration files.

    -

    See cargo-init(1) for a similar command which will create a new manifest +

    See cargo-init(1) for a similar command which will create a new manifest in an existing directory.

    @@ -124,7 +124,7 @@

    New Options

    This sets the publish field in Cargo.toml to the given registry name which will restrict publishing only to that registry.

    -

    Registry names are defined in Cargo config files. +

    Registry names are defined in Cargo config files. If not specified, the default registry defined by the registry.default config key is used. If the default registry is not set and --registry is not used, the publish field will not be set which means that publishing will not @@ -144,7 +144,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -170,7 +170,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -199,7 +199,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -242,7 +242,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-init(1)

    +

    cargo(1), cargo-init(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-owner.html b/src/doc/man/generated/cargo-owner.html index 21eab2e8d5a..80647ad62db 100644 --- a/src/doc/man/generated/cargo-owner.html +++ b/src/doc/man/generated/cargo-owner.html @@ -22,14 +22,14 @@

    DESCRIPTION

    This command requires you to be authenticated with either the --token option -or using cargo-login(1).

    +or using cargo-login(1).

    If the crate name is not specified, it will use the package name from the current directory.

    -

    See the reference for more +

    See the reference for more information about owners and publishing.

    @@ -59,9 +59,9 @@

    Owner Options

    --token TOKEN

    API token to use when authenticating. This overrides the token stored in -the credentials file (which is created by cargo-login(1)).

    +the credentials file (which is created by cargo-login(1)).

    -

    Cargo config environment variables can be +

    Cargo config environment variables can be used to override the tokens stored in the credentials file. The token for crates.io may be specified with the CARGO_REGISTRY_TOKEN environment variable. Tokens for other registries may be specified with environment @@ -75,7 +75,7 @@

    Owner Options

    --registry REGISTRY
    -

    Name of the registry to use. Registry names are defined in Cargo config files. +

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

    @@ -92,7 +92,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -118,7 +118,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -147,7 +147,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -206,7 +206,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-login(1), cargo-publish(1)

    +

    cargo(1), cargo-login(1), cargo-publish(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-package.html b/src/doc/man/generated/cargo-package.html index d6ed1cc7070..2061369de6f 100644 --- a/src/doc/man/generated/cargo-package.html +++ b/src/doc/man/generated/cargo-package.html @@ -45,7 +45,7 @@

    DESCRIPTION

  • Cargo.lock is automatically included if the package contains an -executable binary or example target. cargo-install(1) will use the +executable binary or example target. cargo-install(1) will use the packaged lock file if the --locked flag is used.

  • @@ -69,7 +69,7 @@

    DESCRIPTION

    fields in the manifest.

    -

    See the reference for more details about +

    See the reference for more details about packaging and publishing.

    @@ -114,14 +114,14 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --target-dir DIRECTORY

    Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

    @@ -185,11 +185,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -203,7 +203,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -219,7 +219,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -245,7 +245,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -274,7 +274,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -317,7 +317,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-publish(1)

    +

    cargo(1), cargo-publish(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-pkgid.html b/src/doc/man/generated/cargo-pkgid.html index 77f79d19b78..c2fcf99c65a 100644 --- a/src/doc/man/generated/cargo-pkgid.html +++ b/src/doc/man/generated/cargo-pkgid.html @@ -96,7 +96,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -122,7 +122,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -160,11 +160,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -193,7 +193,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -252,7 +252,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-generate-lockfile(1), cargo-metadata(1)

    +

    cargo(1), cargo-generate-lockfile(1), cargo-metadata(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-publish.html b/src/doc/man/generated/cargo-publish.html index 261e629cdaf..1aeadcc5014 100644 --- a/src/doc/man/generated/cargo-publish.html +++ b/src/doc/man/generated/cargo-publish.html @@ -33,7 +33,7 @@

    DESCRIPTION

  • -

    Create a .crate file by following the steps in cargo-package(1).

    +

    Create a .crate file by following the steps in cargo-package(1).

  • Upload the crate to the registry. Note that the server will perform @@ -43,10 +43,10 @@

    DESCRIPTION

    This command requires you to be authenticated with either the --token option -or using cargo-login(1).

    +or using cargo-login(1).

    -

    See the reference for more details about +

    See the reference for more details about packaging and publishing.

    @@ -65,9 +65,9 @@

    Publish Options

    --token TOKEN

    API token to use when authenticating. This overrides the token stored in -the credentials file (which is created by cargo-login(1)).

    +the credentials file (which is created by cargo-login(1)).

    -

    Cargo config environment variables can be +

    Cargo config environment variables can be used to override the tokens stored in the credentials file. The token for crates.io may be specified with the CARGO_REGISTRY_TOKEN environment variable. Tokens for other registries may be specified with environment @@ -89,7 +89,7 @@

    Publish Options

    --registry REGISTRY
    -

    Name of the registry to use. Registry names are defined in Cargo config files. +

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

    @@ -108,14 +108,14 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --target-dir DIRECTORY

    Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

    @@ -179,11 +179,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -197,7 +197,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -213,7 +213,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -239,7 +239,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -268,7 +268,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -311,7 +311,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-package(1), cargo-login(1)

    +

    cargo(1), cargo-package(1), cargo-login(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-run.html b/src/doc/man/generated/cargo-run.html index cbcb07c18ed..abadc739f9b 100644 --- a/src/doc/man/generated/cargo-run.html +++ b/src/doc/man/generated/cargo-run.html @@ -37,7 +37,7 @@

    Package Selection

    -p SPEC
    --package SPEC
    -

    The package to run. See cargo-pkgid(1) for +

    The package to run. See cargo-pkgid(1) for the SPEC format.

    @@ -102,7 +102,7 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --release
    @@ -121,7 +121,7 @@

    Output Options

    Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

    @@ -137,7 +137,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -163,7 +163,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    --message-format FMT
    @@ -218,11 +218,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -253,7 +253,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -267,7 +267,7 @@

    PROFILES

    Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

    @@ -311,7 +311,7 @@

    PROFILES

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -362,7 +362,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-build(1)

    +

    cargo(1), cargo-build(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-rustc.html b/src/doc/man/generated/cargo-rustc.html index 0b36614649d..37ff9606ca0 100644 --- a/src/doc/man/generated/cargo-rustc.html +++ b/src/doc/man/generated/cargo-rustc.html @@ -32,7 +32,7 @@

    DESCRIPTION

    target is compiled. To pass flags to all compiler processes spawned by Cargo, use the RUSTFLAGS environment variable or the build.rustflags -config value.

    +config value.

    @@ -50,7 +50,7 @@

    Package Selection

    -p SPEC
    --package SPEC
    -

    The package to build. See cargo-pkgid(1) for +

    The package to build. See cargo-pkgid(1) for the SPEC format.

    @@ -163,7 +163,7 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --release
    @@ -182,7 +182,7 @@

    Output Options

    Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

    @@ -198,7 +198,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -224,7 +224,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    --message-format FMT
    @@ -279,11 +279,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -314,7 +314,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -328,7 +328,7 @@

    PROFILES

    Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

    @@ -372,7 +372,7 @@

    PROFILES

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -424,7 +424,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-build(1), rustc(1)

    +

    cargo(1), cargo-build(1), rustc(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-rustdoc.html b/src/doc/man/generated/cargo-rustdoc.html index 3d3f92da92c..c0bc147e57a 100644 --- a/src/doc/man/generated/cargo-rustdoc.html +++ b/src/doc/man/generated/cargo-rustdoc.html @@ -61,7 +61,7 @@

    Package Selection

    -p SPEC
    --package SPEC
    -

    The package to document. See cargo-pkgid(1) for +

    The package to document. See cargo-pkgid(1) for the SPEC format.

    @@ -176,7 +176,7 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --release
    @@ -195,7 +195,7 @@

    Output Options

    Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

    @@ -211,7 +211,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -237,7 +237,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    --message-format FMT
    @@ -292,11 +292,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -327,7 +327,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -341,7 +341,7 @@

    PROFILES

    Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

    @@ -385,7 +385,7 @@

    PROFILES

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -428,7 +428,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-doc(1), rustdoc(1)

    +

    cargo(1), cargo-doc(1), rustdoc(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-search.html b/src/doc/man/generated/cargo-search.html index a2121216f2b..b2ec506a9fb 100644 --- a/src/doc/man/generated/cargo-search.html +++ b/src/doc/man/generated/cargo-search.html @@ -37,7 +37,7 @@

    Search Options

    --registry REGISTRY
    -

    Name of the registry to use. Registry names are defined in Cargo config files. +

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

    @@ -54,7 +54,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -80,7 +80,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -109,7 +109,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -152,7 +152,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-install(1), cargo-publish(1)

    +

    cargo(1), cargo-install(1), cargo-publish(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-test.html b/src/doc/man/generated/cargo-test.html index f527078646f..0419c076a02 100644 --- a/src/doc/man/generated/cargo-test.html +++ b/src/doc/man/generated/cargo-test.html @@ -86,7 +86,7 @@

    Package Selection

    -p SPEC…​
    --package SPEC…​
    -

    Test only the specified packages. See cargo-pkgid(1) for the +

    Test only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.

    --all
    @@ -250,7 +250,7 @@

    Compilation Options

    list of supported targets.

    This may also be specified with the build.target -config value.

    +config value.

    --release
    @@ -269,7 +269,7 @@

    Output Options

    Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the -build.target-dir config value. Defaults +build.target-dir config value. Defaults to target in the root of the workspace.

    @@ -295,7 +295,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -321,7 +321,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    --message-format FMT
    @@ -376,11 +376,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -421,7 +421,7 @@

    Miscellaneous Options

    --jobs N

    Number of parallel jobs to run. May also be specified with the -build.jobs config value. Defaults to +build.jobs config value. Defaults to the number of CPUs.

    @@ -435,7 +435,7 @@

    PROFILES

    Profiles may be used to configure compiler options such as optimization levels and debug settings. See -the reference +the reference for more details.

    @@ -488,7 +488,7 @@

    PROFILES

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -539,7 +539,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-bench(1)

    +

    cargo(1), cargo-bench(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-uninstall.html b/src/doc/man/generated/cargo-uninstall.html index bde65fc38aa..ef24a2edc56 100644 --- a/src/doc/man/generated/cargo-uninstall.html +++ b/src/doc/man/generated/cargo-uninstall.html @@ -14,9 +14,9 @@

    SYNOPSIS

    DESCRIPTION

    -

    This command removes a package installed with cargo-install(1). The SPEC +

    This command removes a package installed with cargo-install(1). The SPEC argument is a package ID specification of the package to remove (see -cargo-pkgid(1)).

    +cargo-pkgid(1)).

    By default all binaries are removed for a crate but the --bin and @@ -34,7 +34,7 @@

    DESCRIPTION

    CARGO_INSTALL_ROOT environment variable

  • -

    install.root Cargo config value

    +

    install.root Cargo config value

  • CARGO_HOME environment variable

    @@ -79,7 +79,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -105,7 +105,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -134,7 +134,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -177,7 +177,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-install(1)

    +

    cargo(1), cargo-install(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-update.html b/src/doc/man/generated/cargo-update.html index c647272c7f3..496ddda42e0 100644 --- a/src/doc/man/generated/cargo-update.html +++ b/src/doc/man/generated/cargo-update.html @@ -16,7 +16,7 @@

    DESCRIPTION

    This command will update dependencies in the Cargo.lock file to the latest version. It requires that the Cargo.lock file already exists as generated -by commands such as cargo-build(1) or cargo-generate-lockfile(1).

    +by commands such as cargo-build(1) or cargo-generate-lockfile(1).

    @@ -31,7 +31,7 @@

    Update Options

    --package SPEC…​

    Update only the specified packages. This flag may be specified -multiple times. See cargo-pkgid(1) for the SPEC format.

    +multiple times. See cargo-pkgid(1) for the SPEC format.

    If packages are specified with the -p flag, then a conservative update of the lockfile will be performed. This means that only the dependency specified @@ -71,7 +71,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -97,7 +97,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -135,11 +135,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -168,7 +168,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -227,7 +227,7 @@

    EXAMPLES

    SEE ALSO

    -

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

    +

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

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-vendor.html b/src/doc/man/generated/cargo-vendor.html index 87ead76249b..95927267455 100644 --- a/src/doc/man/generated/cargo-vendor.html +++ b/src/doc/man/generated/cargo-vendor.html @@ -74,7 +74,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -100,7 +100,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -133,6 +133,23 @@

    Common Options

    access.

    +
    --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.

    +
    +
    @@ -142,7 +159,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -201,7 +218,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1)

    +

    cargo(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-verify-project.html b/src/doc/man/generated/cargo-verify-project.html index 7a08b4679ba..9c5dc876e2e 100644 --- a/src/doc/man/generated/cargo-verify-project.html +++ b/src/doc/man/generated/cargo-verify-project.html @@ -45,7 +45,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -71,7 +71,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -109,11 +109,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -142,7 +142,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -185,7 +185,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-package(1)

    +

    cargo(1), cargo-package(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-version.html b/src/doc/man/generated/cargo-version.html index 96332d4ea52..2c84a33d0c6 100644 --- a/src/doc/man/generated/cargo-version.html +++ b/src/doc/man/generated/cargo-version.html @@ -70,7 +70,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1)

    +

    cargo(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo-yank.html b/src/doc/man/generated/cargo-yank.html index 4e1d00965e8..ba6c1ab8fed 100644 --- a/src/doc/man/generated/cargo-yank.html +++ b/src/doc/man/generated/cargo-yank.html @@ -25,7 +25,7 @@

    DESCRIPTION

    This command requires you to be authenticated with either the --token option -or using cargo-login(1).

    +or using cargo-login(1).

    If the crate name is not specified, it will use the package name from the @@ -51,9 +51,9 @@

    Owner Options

    --token TOKEN

    API token to use when authenticating. This overrides the token stored in -the credentials file (which is created by cargo-login(1)).

    +the credentials file (which is created by cargo-login(1)).

    -

    Cargo config environment variables can be +

    Cargo config environment variables can be used to override the tokens stored in the credentials file. The token for crates.io may be specified with the CARGO_REGISTRY_TOKEN environment variable. Tokens for other registries may be specified with environment @@ -67,7 +67,7 @@

    Owner Options

    --registry REGISTRY
    -

    Name of the registry to use. Registry names are defined in Cargo config files. +

    Name of the registry to use. Registry names are defined in Cargo config files. If not specified, the default registry is used, which is defined by the registry.default config key which defaults to crates-io.

    @@ -84,7 +84,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -110,7 +110,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -139,7 +139,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -182,7 +182,7 @@

    EXAMPLES

    SEE ALSO

    -

    cargo(1), cargo-login(1), cargo-publish(1)

    +

    cargo(1), cargo-login(1), cargo-publish(1)

    \ No newline at end of file diff --git a/src/doc/man/generated/cargo.html b/src/doc/man/generated/cargo.html index f5b02a30739..c501206d302 100644 --- a/src/doc/man/generated/cargo.html +++ b/src/doc/man/generated/cargo.html @@ -30,47 +30,47 @@

    COMMANDS

    Build Commands

    -
    cargo-bench(1)
    +
    cargo-bench(1)

    Execute benchmarks of a package.

    -
    cargo-build(1)
    +
    cargo-build(1)

    Compile a package.

    -
    cargo-check(1)
    +
    cargo-check(1)

    Check a local package and all of its dependencies for errors.

    -
    cargo-clean(1)
    +
    cargo-clean(1)

    Remove artifacts that Cargo has generated in the past.

    -
    cargo-doc(1)
    +
    cargo-doc(1)

    Build a package’s documentation.

    -
    cargo-fetch(1)
    +
    cargo-fetch(1)

    Fetch dependencies of a package from the network.

    -
    cargo-fix(1)
    +
    cargo-fix(1)

    Automatically fix lint warnings reported by rustc.

    -
    cargo-run(1)
    +
    cargo-run(1)

    Run a binary or example of the local package.

    -
    cargo-rustc(1)
    +
    cargo-rustc(1)

    Compile a package, and pass extra options to the compiler.

    -
    cargo-rustdoc(1)
    +
    cargo-rustdoc(1)

    Build a package’s documentation, using specified custom flags.

    -
    cargo-test(1)
    +
    cargo-test(1)

    Execute unit and integration tests of a package.

    @@ -81,28 +81,28 @@

    Build Commands

    Manifest Commands

    -
    cargo-generate-lockfile(1)
    +
    cargo-generate-lockfile(1)

    Generate Cargo.lock for a project.

    -
    cargo-locate-project(1)
    +
    cargo-locate-project(1)

    Print a JSON representation of a Cargo.toml file’s location.

    -
    cargo-metadata(1)
    +
    cargo-metadata(1)

    Output the resolved dependencies of a package, the concrete used versions including overrides, in machine-readable format.

    -
    cargo-pkgid(1)
    +
    cargo-pkgid(1)

    Print a fully qualified package specification.

    -
    cargo-update(1)
    +
    cargo-update(1)

    Update dependencies as recorded in the local lock file.

    -
    cargo-verify-project(1)
    +
    cargo-verify-project(1)

    Check correctness of crate manifest.

    @@ -113,23 +113,23 @@

    Manifest Commands

    Package Commands

    -
    cargo-init(1)
    +
    cargo-init(1)

    Create a new Cargo package in an existing directory.

    -
    cargo-install(1)
    +
    cargo-install(1)

    Build and install a Rust binary.

    -
    cargo-new(1)
    +
    cargo-new(1)

    Create a new Cargo package.

    -
    cargo-search(1)
    +
    cargo-search(1)

    Search packages in crates.io.

    -
    cargo-uninstall(1)
    +
    cargo-uninstall(1)

    Remove a Rust binary.

    @@ -140,23 +140,23 @@

    Package Commands

    Publishing Commands

    -
    cargo-login(1)
    +
    cargo-login(1)

    Save an API token from the registry locally.

    -
    cargo-owner(1)
    +
    cargo-owner(1)

    Manage the owners of a crate on the registry.

    -
    cargo-package(1)
    +
    cargo-package(1)

    Assemble the local package into a distributable tarball.

    -
    cargo-publish(1)
    +
    cargo-publish(1)

    Upload a package to the registry.

    -
    cargo-yank(1)
    +
    cargo-yank(1)

    Remove a pushed crate from the index.

    @@ -167,11 +167,11 @@

    Publishing Commands

    General Commands

    -
    cargo-help(1)
    +
    cargo-help(1)

    Display help information about Cargo.

    -
    cargo-version(1)
    +
    cargo-version(1)

    Show version information.

    @@ -216,7 +216,7 @@

    Display Options

    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.

    +config value.

    -q
    --quiet
    @@ -242,7 +242,7 @@

    Display Options

    May also be specified with the term.color -config value.

    +config value.

    @@ -275,11 +275,11 @@

    Manifest Options

    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 +See the cargo-fetch(1) command to download dependencies before going offline.

    -

    May also be specified with the net.offline config value.

    +

    May also be specified with the net.offline config value.

    @@ -308,7 +308,7 @@

    Common Options

    ENVIRONMENT

    -

    See the reference for +

    See the reference for details on environment variables that Cargo reads.

    @@ -343,12 +343,12 @@

    FILES

    $CARGO_HOME/bin/
    -

    Binaries installed by cargo-install(1) will be located here. If using +

    Binaries installed by cargo-install(1) will be located here. If using rustup, executables distributed with Rust are also located here.

    $CARGO_HOME/config
    -

    The global configuration file. See the reference +

    The global configuration file. See the reference for more information about configuration files.

    .cargo/config
    diff --git a/src/doc/src/appendix/glossary.md b/src/doc/src/appendix/glossary.md index 35b53386d1d..4bd44c54c3c 100644 --- a/src/doc/src/appendix/glossary.md +++ b/src/doc/src/appendix/glossary.md @@ -172,27 +172,27 @@ The *workspace root* is the directory where the workspace's `Cargo.toml` manifest is located. -[Cargo.toml vs Cargo.lock]: guide/cargo-toml-vs-cargo-lock.html -[Directory Sources]: reference/source-replacement.html#directory-sources -[Local Registry Sources]: reference/source-replacement.html#local-registry-sources -[Source Replacement]: reference/source-replacement.html -[cargo-unstable]: reference/unstable.html -[config option]: reference/config.html -[directory layout]: reference/manifest.html#the-project-layout -[edition guide]: ../edition-guide/index.html -[edition-field]: reference/manifest.html#the-edition-field-optional -[environment variable]: reference/environment-variables.html -[feature]: reference/manifest.html#the-features-section -[git dependency]: reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories -[git source]: reference/source-replacement.html -[integration-tests]: reference/manifest.html#integration-tests -[manifest]: reference/manifest.html -[path dependency]: reference/specifying-dependencies.html#specifying-path-dependencies -[path overrides]: reference/specifying-dependencies.html#overriding-with-local-dependencies -[pkgid-spec]: reference/pkgid-spec.html +[Cargo.toml vs Cargo.lock]: ../guide/cargo-toml-vs-cargo-lock.md +[Directory Sources]: ../reference/source-replacement.md#directory-sources +[Local Registry Sources]: ../reference/source-replacement.md#local-registry-sources +[Source Replacement]: ../reference/source-replacement.md +[cargo-unstable]: ../reference/unstable.md +[config option]: ../reference/config.md +[directory layout]: ../reference/manifest.md#the-project-layout +[edition guide]: ../../edition-guide/index.html +[edition-field]: ../reference/manifest.md#the-edition-field-optional +[environment variable]: ../reference/environment-variables.md +[feature]: ../reference/manifest.md#the-features-section +[git dependency]: ../reference/specifying-dependencies.md#specifying-dependencies-from-git-repositories +[git source]: ../reference/source-replacement.md +[integration-tests]: ../reference/manifest.md#integration-tests +[manifest]: ../reference/manifest.md +[path dependency]: ../reference/specifying-dependencies.md#specifying-path-dependencies +[path overrides]: ../reference/specifying-dependencies.md#overriding-with-local-dependencies +[pkgid-spec]: ../reference/pkgid-spec.md [rustdoc-unstable]: https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html -[target-feature]: ../reference/attributes/codegen.html#the-target_feature-attribute -[targets]: reference/manifest.html#configuring-a-target +[target-feature]: ../../reference/attributes/codegen.html#the-target_feature-attribute +[targets]: ../reference/manifest.md#configuring-a-target [unstable-book]: https://doc.rust-lang.org/nightly/unstable-book/index.html -[virtual]: reference/manifest.html#virtual-manifest -[workspace]: reference/manifest.html#the-workspace-section +[virtual]: ../reference/manifest.md#virtual-manifest +[workspace]: ../reference/manifest.md#the-workspace-section diff --git a/src/doc/src/faq.md b/src/doc/src/faq.md index 108dfc20530..0aa179454e1 100644 --- a/src/doc/src/faq.md +++ b/src/doc/src/faq.md @@ -50,7 +50,7 @@ Cargo handles compiling Rust code, but we know that many Rust packages link against C code. We also know that there are decades of tooling built up around compiling languages other than Rust. -Our solution: Cargo allows a package to [specify a script](reference/build-scripts.html) +Our solution: Cargo allows a package to [specify a script](reference/build-scripts.md) (written in Rust) to run before invoking `rustc`. Rust is leveraged to implement platform-specific configuration and refactor out common build functionality among packages. @@ -74,7 +74,7 @@ on the platform. Cargo also supports [platform-specific dependencies][target-deps], and we plan to support more per-platform configuration in `Cargo.toml` in the future. -[target-deps]: reference/specifying-dependencies.html#platform-specific-dependencies +[target-deps]: reference/specifying-dependencies.md#platform-specific-dependencies In the longer-term, we’re looking at ways to conveniently cross-compile packages using Cargo. @@ -83,7 +83,7 @@ packages using Cargo. We support environments through the use of [profiles][profile] to support: -[profile]: reference/manifest.html#the-profile-sections +[profile]: reference/manifest.md#the-profile-sections * environment-specific flags (like `-g --opt-level=0` for development and `--opt-level=3` for production). @@ -190,4 +190,4 @@ shouldn't be necessary. For more information about vendoring, see documentation on [source replacement][replace]. -[replace]: reference/source-replacement.html +[replace]: reference/source-replacement.md diff --git a/src/doc/src/getting-started/first-steps.md b/src/doc/src/getting-started/first-steps.md index 0a3b730dc00..9c0a46b4071 100644 --- a/src/doc/src/getting-started/first-steps.md +++ b/src/doc/src/getting-started/first-steps.md @@ -70,4 +70,4 @@ Hello, world! ### Going further -For more details on using Cargo, check out the [Cargo Guide](guide/index.html) +For more details on using Cargo, check out the [Cargo Guide](../guide/index.md) diff --git a/src/doc/src/getting-started/index.md b/src/doc/src/getting-started/index.md index 22a7315cf11..ed775db70b6 100644 --- a/src/doc/src/getting-started/index.md +++ b/src/doc/src/getting-started/index.md @@ -2,5 +2,5 @@ To get started with Cargo, install Cargo (and Rust) and set up your first crate. -* [Installation](getting-started/installation.html) -* [First steps with Cargo](getting-started/first-steps.html) +* [Installation](installation.md) +* [First steps with Cargo](first-steps.md) diff --git a/src/doc/src/guide/cargo-toml-vs-cargo-lock.md b/src/doc/src/guide/cargo-toml-vs-cargo-lock.md index 15cee96cfab..12711247830 100644 --- a/src/doc/src/guide/cargo-toml-vs-cargo-lock.md +++ b/src/doc/src/guide/cargo-toml-vs-cargo-lock.md @@ -13,7 +13,7 @@ If you’re building a non-end product, such as a rust library that other rust p like command-line tool or an application, or a system library with crate-type of `staticlib` or `cdylib`, check `Cargo.lock` into `git`. If you're curious about why that is, see ["Why do binaries have `Cargo.lock` in version control, but not libraries?" in the -FAQ](faq.html#why-do-binaries-have-cargolock-in-version-control-but-not-libraries). +FAQ](../faq.md#why-do-binaries-have-cargolock-in-version-control-but-not-libraries). Let’s dig in a little bit more. @@ -99,5 +99,5 @@ $ cargo update -p rand # updates just “rand” This will write out a new `Cargo.lock` with the new version information. Note that the argument to `cargo update` is actually a -[Package ID Specification](reference/pkgid-spec.html) and `rand` is just a short +[Package ID Specification](../reference/pkgid-spec.md) and `rand` is just a short specification. diff --git a/src/doc/src/guide/dependencies.md b/src/doc/src/guide/dependencies.md index c9bc4b92d5b..a6d129a359d 100644 --- a/src/doc/src/guide/dependencies.md +++ b/src/doc/src/guide/dependencies.md @@ -20,7 +20,7 @@ time = "0.1.12" ``` The version string is a [semver] version requirement. The [specifying -dependencies](reference/specifying-dependencies.html) docs have more information about +dependencies](../reference/specifying-dependencies.md) docs have more information about the options you have here. [semver]: https://github.com/steveklabnik/semver#requirements diff --git a/src/doc/src/guide/index.md b/src/doc/src/guide/index.md index 08fb1c6d950..f40e25a7beb 100644 --- a/src/doc/src/guide/index.md +++ b/src/doc/src/guide/index.md @@ -3,12 +3,12 @@ This guide will give you all that you need to know about how to use Cargo to develop Rust packages. -* [Why Cargo Exists](guide/why-cargo-exists.html) -* [Creating a New Package](guide/creating-a-new-project.html) -* [Working on an Existing Cargo Package](guide/working-on-an-existing-project.html) -* [Dependencies](guide/dependencies.html) -* [Package Layout](guide/project-layout.html) -* [Cargo.toml vs Cargo.lock](guide/cargo-toml-vs-cargo-lock.html) -* [Tests](guide/tests.html) -* [Continuous Integration](guide/continuous-integration.html) -* [Build Cache](guide/build-cache.html) +* [Why Cargo Exists](why-cargo-exists.md) +* [Creating a New Package](creating-a-new-project.md) +* [Working on an Existing Cargo Package](working-on-an-existing-project.md) +* [Dependencies](dependencies.md) +* [Package Layout](project-layout.md) +* [Cargo.toml vs Cargo.lock](cargo-toml-vs-cargo-lock.md) +* [Tests](tests.md) +* [Continuous Integration](continuous-integration.md) +* [Build Cache](build-cache.md) diff --git a/src/doc/src/guide/project-layout.md b/src/doc/src/guide/project-layout.md index 516f0659330..6c9f4a7719c 100644 --- a/src/doc/src/guide/project-layout.md +++ b/src/doc/src/guide/project-layout.md @@ -32,4 +32,4 @@ Cargo package: * Benchmarks go in the `benches` directory. These are explained in more detail in the [manifest -description](reference/manifest.html#the-project-layout). +description](../reference/manifest.md#the-project-layout). diff --git a/src/doc/src/guide/tests.md b/src/doc/src/guide/tests.md index 7fe4bd15dbe..cebba75c2b3 100644 --- a/src/doc/src/guide/tests.md +++ b/src/doc/src/guide/tests.md @@ -36,4 +36,4 @@ examples you’ve included and will also test the examples in your documentation. Please see the [testing guide][testing] in the Rust documentation for more details. -[testing]: ../book/ch11-00-testing.html +[testing]: ../../book/ch11-00-testing.html diff --git a/src/doc/src/index.md b/src/doc/src/index.md index d3af5326ea5..66cb784f49c 100644 --- a/src/doc/src/index.md +++ b/src/doc/src/index.md @@ -10,20 +10,20 @@ to this book on [GitHub]. ### Sections -**[Getting Started](getting-started/index.html)** +**[Getting Started](getting-started/index.md)** To get started with Cargo, install Cargo (and Rust) and set up your first crate. -**[Cargo Guide](guide/index.html)** +**[Cargo Guide](guide/index.md)** The guide will give you all you need to know about how to use Cargo to develop Rust packages. -**[Cargo Reference](reference/index.html)** +**[Cargo Reference](reference/index.md)** The reference covers the details of various areas of Cargo. -**[Frequently Asked Questions](faq.html)** +**[Frequently Asked Questions](faq.md)** [rust]: https://www.rust-lang.org/ [crates.io]: https://crates.io/ diff --git a/src/doc/src/reference/build-scripts.md b/src/doc/src/reference/build-scripts.md index c7f9e9b2964..9d1c9f4062a 100644 --- a/src/doc/src/reference/build-scripts.md +++ b/src/doc/src/reference/build-scripts.md @@ -41,7 +41,7 @@ all passed in the form of [environment variables][env]. In addition to environment variables, the build script’s current directory is the source directory of the build script’s package. -[env]: reference/environment-variables.html +[env]: environment-variables.md ### Outputs of the Build Script @@ -174,7 +174,7 @@ In other words, it’s forbidden to have two packages link to the same native library. Note, however, that there are [conventions in place][star-sys] to alleviate this. -[star-sys]: #a-sys-packages +[star-sys]: #-sys-packages As mentioned above in the output format, each build script can generate an arbitrary set of metadata in the form of key-value pairs. This metadata is @@ -195,7 +195,7 @@ prevent running the build script in question altogether and instead supply the metadata ahead of time. To override a build script, place the following configuration in any acceptable -Cargo [configuration location](reference/config.html). +Cargo [configuration location](config.md). ```toml [target.x86_64-unknown-linux-gnu.foo] diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index 5c1866d143f..1d9a55cdc57 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -2,7 +2,7 @@ This document will explain how Cargo’s configuration system works, as well as available keys or configuration. For configuration of a package through its -manifest, see the [manifest format](reference/manifest.html). +manifest, see the [manifest format](manifest.md). ### Hierarchical structure @@ -196,7 +196,7 @@ be specified with environment variables of the form `CARGO_REGISTRIES_NAME_TOKEN` where `NAME` is the name of the registry in all capital letters. -[`cargo login`]: commands/cargo-login.html -[`cargo publish`]: commands/cargo-publish.html -[env]: reference/environment-variables.html -[source]: reference/source-replacement.html +[`cargo login`]: ../commands/cargo-login.md +[`cargo publish`]: ../commands/cargo-publish.md +[env]: environment-variables.md +[source]: source-replacement.md diff --git a/src/doc/src/reference/environment-variables.md b/src/doc/src/reference/environment-variables.md index 6af04e1f6e8..7f63a48d652 100644 --- a/src/doc/src/reference/environment-variables.md +++ b/src/doc/src/reference/environment-variables.md @@ -38,7 +38,7 @@ system: Note that Cargo will also read environment variables for `.cargo/config` configuration values, as described in [that documentation][config-env] -[config-env]: reference/config.html#environment-variables +[config-env]: config.md#environment-variables ### Environment variables Cargo sets for crates @@ -130,11 +130,11 @@ let out_dir = env::var("OUT_DIR").unwrap(); about [cargo configuration][cargo-config] for more information. -[links]: reference/build-scripts.html#the-links-manifest-key -[configuration]: ../reference/conditional-compilation.html +[links]: build-scripts.md#the-links-manifest-key +[configuration]: ../../reference/conditional-compilation.html [jobserver]: https://www.gnu.org/software/make/manual/html_node/Job-Slots.html -[cargo-config]: reference/config.html -[Target Triple]: appendix/glossary.html#target +[cargo-config]: config.md +[Target Triple]: ../appendix/glossary.md#target ### Environment variables Cargo sets for 3rd party subcommands diff --git a/src/doc/src/reference/index.md b/src/doc/src/reference/index.md index c4c46b75c31..a9bf76c8537 100644 --- a/src/doc/src/reference/index.md +++ b/src/doc/src/reference/index.md @@ -2,13 +2,13 @@ The reference covers the details of various areas of Cargo. -* [Specifying Dependencies](reference/specifying-dependencies.html) -* [The Manifest Format](reference/manifest.html) -* [Configuration](reference/config.html) -* [Environment Variables](reference/environment-variables.html) -* [Build Scripts](reference/build-scripts.html) -* [Publishing on crates.io](reference/publishing.html) -* [Package ID Specifications](reference/pkgid-spec.html) -* [Source Replacement](reference/source-replacement.html) -* [External Tools](reference/external-tools.html) -* [Unstable Features](reference/unstable.html) +* [Specifying Dependencies](specifying-dependencies.md) +* [The Manifest Format](manifest.md) +* [Configuration](config.md) +* [Environment Variables](environment-variables.md) +* [Build Scripts](build-scripts.md) +* [Publishing on crates.io](publishing.md) +* [Package ID Specifications](pkgid-spec.md) +* [Source Replacement](source-replacement.md) +* [External Tools](external-tools.md) +* [Unstable Features](unstable.md) diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index 9fc641584cb..bf9d885ab23 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -27,7 +27,7 @@ a keyword. [crates.io][cratesio] imposes even more restrictions, such as enforcing only ASCII characters, not a reserved name, not a special Windows name such as "nul", is not too long, etc. -[alphanumeric]: ../std/primitive.char.html#method.is_alphanumeric +[alphanumeric]: ../../std/primitive.char.html#method.is_alphanumeric #### The `version` field @@ -77,7 +77,7 @@ This field specifies a file in the package root which is a [build script] for building native code. More information can be found in the [build script guide][build script]. -[build script]: reference/build-scripts.html +[build script]: build-scripts.md ```toml [package] @@ -91,7 +91,7 @@ This field specifies the name of a native library that is being linked to. More information can be found in the [`links`][links] section of the build script guide. -[links]: reference/build-scripts.html#the-links-manifest-key +[links]: build-scripts.md#the-links-manifest-key ```toml [package] @@ -377,7 +377,7 @@ default-run = "a" ### Dependency sections -See the [specifying dependencies page](reference/specifying-dependencies.html) for +See the [specifying dependencies page](specifying-dependencies.md) for information on the `[dependencies]`, `[dev-dependencies]`, `[build-dependencies]`, and target-specific `[target.*.dependencies]` sections. @@ -710,7 +710,7 @@ may be composed of single files or directories with a `main.rs` file. To structure your code after you've created the files and folders for your package, you should remember to use Rust's module system, which you can read about in [the -book](../book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html). +book](../../book/ch07-00-managing-growing-projects-with-packages-crates-and-modules.html). See [Configuring a target](#configuring-a-target) below for more details on manually configuring target settings. See [Target @@ -731,7 +731,7 @@ You can run individual executable examples with the command `cargo run --example Specify `crate-type` to make an example be compiled as a library (additional information about crate types is available in -[The Rust Reference](../reference/linkage.html)): +[The Rust Reference](../../reference/linkage.html)): ```toml [[example]] @@ -909,7 +909,7 @@ The available options are `dylib`, `rlib`, `staticlib`, `cdylib`, and `proc-macro`. You can read more about the different crate types in the -[Rust Reference Manual](../reference/linkage.html) +[Rust Reference Manual](../../reference/linkage.html) ### The `[patch]` Section @@ -953,7 +953,7 @@ technical specification of this feature. [RFC 1969]: https://github.com/rust-lang/rfcs/pull/1969 [crates.io]: https://crates.io/ -[replace]: reference/specifying-dependencies.html#overriding-dependencies +[replace]: specifying-dependencies.md#overriding-dependencies ### The `[replace]` Section @@ -967,7 +967,7 @@ other copies. The syntax is similar to the `[dependencies]` section: ``` Each key in the `[replace]` table is a [package ID -specification](reference/pkgid-spec.html), which allows arbitrarily choosing a node in the +specification](pkgid-spec.md), which allows arbitrarily choosing a node in the dependency graph to override. The value of each key is the same as the `[dependencies]` syntax for specifying dependencies, except that you can't specify features. Note that when a crate is overridden the copy it's overridden @@ -977,11 +977,11 @@ source (e.g., git or a local path). More information about overriding dependencies can be found in the [overriding dependencies][replace] section of the documentation. -[`cargo build`]: commands/cargo-build.html -[`cargo init`]: commands/cargo-init.html -[`cargo new`]: commands/cargo-new.html -[`cargo run`]: commands/cargo-run.html -[`cargo test`]: commands/cargo-test.html +[`cargo build`]: ../commands/cargo-build.md +[`cargo init`]: ../commands/cargo-init.md +[`cargo new`]: ../commands/cargo-new.md +[`cargo run`]: ../commands/cargo-run.md +[`cargo test`]: ../commands/cargo-test.md [spdx-2.1-license-expressions]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 [spdx-license-list-2.4]: https://github.com/spdx/license-list-data/tree/v2.4 [spdx-license-list]: https://spdx.org/licenses/ diff --git a/src/doc/src/reference/publishing.md b/src/doc/src/reference/publishing.md index 8a63786313a..daba1a0beaa 100644 --- a/src/doc/src/reference/publishing.md +++ b/src/doc/src/reference/publishing.md @@ -31,7 +31,7 @@ Keep in mind that crate names on [crates.io] are allocated on a first-come-first serve basis. Once a crate name is taken, it cannot be used for another crate. Check out the [metadata you can -specify](reference/manifest.html#package-metadata) in `Cargo.toml` to ensure +specify](manifest.md#package-metadata) in `Cargo.toml` to ensure your crate can be discovered more easily! Before publishing, make sure you have filled out the following fields: @@ -84,7 +84,7 @@ $ cargo package --list Cargo will automatically ignore files ignored by your version control system when packaging, but if you want to specify an extra set of files to ignore you can use the [`exclude` -key](reference/manifest.html#the-exclude-and-include-fields-optional) in the +key](manifest.md#the-exclude-and-include-fields-optional) in the manifest: ```toml @@ -123,7 +123,7 @@ And that’s it, you’ve now published your first crate! In order to release a new version, change the `version` value specified in your `Cargo.toml` manifest. Keep in mind [the semver -rules](reference/manifest.html#the-version-field), and consult [RFC 1105] for +rules](manifest.md#the-version-field), and consult [RFC 1105] for what constitutes a semver-breaking change. Then run [`cargo publish`] as described above to upload the new version. @@ -227,7 +227,7 @@ actively denying third party access. To check this, you can go to: where `:org` is the name of the organization (e.g., `rust-lang`). You may see something like: -![Organization Access Control](images/org-level-acl.png) +![Organization Access Control](../images/org-level-acl.png) Where you may choose to explicitly remove [crates.io] from your organization’s blacklist, or simply press the “Remove Restrictions” button to allow all third @@ -237,13 +237,13 @@ Alternatively, when [crates.io] requested the `read:org` scope, you could have explicitly whitelisted [crates.io] querying the org in question by pressing the “Grant Access” button next to its name: -![Authentication Access Control](images/auth-level-acl.png) +![Authentication Access Control](../images/auth-level-acl.png) [RFC 1105]: https://github.com/rust-lang/rfcs/blob/master/text/1105-api-evolution.md [Rust API Guidelines]: https://rust-lang-nursery.github.io/api-guidelines/ -[`cargo login`]: commands/cargo-login.html -[`cargo package`]: commands/cargo-package.html -[`cargo publish`]: commands/cargo-publish.html +[`cargo login`]: ../commands/cargo-login.md +[`cargo package`]: ../commands/cargo-package.md +[`cargo publish`]: ../commands/cargo-publish.md [crates.io]: https://crates.io/ [oauth-scopes]: https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ diff --git a/src/doc/src/reference/registries.md b/src/doc/src/reference/registries.md index cda41f280b3..868bb45a209 100644 --- a/src/doc/src/reference/registries.md +++ b/src/doc/src/reference/registries.md @@ -580,11 +580,11 @@ The "login" endpoint is not an actual API request. It exists solely for the [`cargo login`] command to display a URL to instruct a user to visit in a web browser to log in and retrieve an API token. -[Source Replacement]: reference/source-replacement.html -[`cargo login`]: commands/cargo-login.html -[`cargo package`]: commands/cargo-package.html -[`cargo publish`]: commands/cargo-publish.html -[alphanumeric]: ../std/primitive.char.html#method.is_alphanumeric -[config]: reference/config.html +[Source Replacement]: source-replacement.md +[`cargo login`]: ../commands/cargo-login.md +[`cargo package`]: ../commands/cargo-package.md +[`cargo publish`]: ../commands/cargo-publish.md +[alphanumeric]: ../../std/primitive.char.html#method.is_alphanumeric +[config]: config.md [crates.io]: https://crates.io/ -[publishing documentation]: reference/publishing.html#cargo-owner +[publishing documentation]: publishing.md#cargo-owner diff --git a/src/doc/src/reference/source-replacement.md b/src/doc/src/reference/source-replacement.md index 802f41d6277..49f048ecba1 100644 --- a/src/doc/src/reference/source-replacement.md +++ b/src/doc/src/reference/source-replacement.md @@ -25,9 +25,9 @@ patching a dependency or a private registry. Cargo supports patching dependencies through the usage of [the `[replace]` key][replace-section], and private registry support is described in [Registries][registries]. -[replace-section]: reference/manifest.html#the-replace-section -[overriding]: reference/specifying-dependencies.html#overriding-dependencies -[registries]: reference/registries.html +[replace-section]: manifest.md#the-replace-section +[overriding]: specifying-dependencies.md#overriding-dependencies +[registries]: registries.md ### Configuration @@ -72,7 +72,7 @@ git = "https://example.com/path/to/repo" # rev = "313f44e8" ``` -[config]: reference/config.html +[config]: config.md ### Registry Sources diff --git a/src/doc/src/reference/specifying-dependencies.md b/src/doc/src/reference/specifying-dependencies.md index da28bd07206..5e99f3d6626 100644 --- a/src/doc/src/reference/specifying-dependencies.md +++ b/src/doc/src/reference/specifying-dependencies.md @@ -12,7 +12,7 @@ to do each of these. Cargo is configured to look for dependencies on [crates.io] by default. Only the name and a version string are required in this case. In [the cargo -guide](guide/index.html), we specified a dependency on the `time` crate: +guide](../guide/index.md), we specified a dependency on the `time` crate: ```toml [dependencies] @@ -114,7 +114,7 @@ to the name of the registry to use. some-crate = { version = "1.0", registry = "my-registry" } ``` -[registries documentation]: reference/registries.html +[registries documentation]: registries.md ### Specifying dependencies from `git` repositories @@ -144,7 +144,7 @@ rand = { git = "https://github.com/rust-lang-nursery/rand", branch = "next" } ### Specifying path dependencies -Over time, our `hello_world` package from [the guide](guide/index.html) has +Over time, our `hello_world` package from [the guide](../guide/index.md) has grown significantly in size! It’s gotten to the point that we probably want to split out a separate crate for others to use. To do this Cargo supports **path dependencies** which are typically sub-crates that live within one repository. @@ -209,8 +209,8 @@ section][patch-section]. Historically some of these scenarios have been solved with [the `[replace]` section][replace-section], but we'll document the `[patch]` section here. -[patch-section]: reference/manifest.html#the-patch-section -[replace-section]: reference/manifest.html#the-replace-section +[patch-section]: manifest.md#the-patch-section +[replace-section]: manifest.md#the-replace-section ### Testing a bugfix @@ -412,7 +412,7 @@ Path overrides are specified through `.cargo/config` instead of `Cargo.toml`, and you can find [more documentation about this configuration][config-docs]. Inside of `.cargo/config` you'll specify a key called `paths`: -[config-docs]: reference/config.html +[config-docs]: config.md ```toml paths = ["/path/to/uuid"] @@ -441,7 +441,7 @@ Cargo how to find local unpublished crates. Platform-specific dependencies take the same format, but are listed under a `target` section. Normally Rust-like [`#[cfg]` -syntax](../reference/conditional-compilation.html) will be used to define +syntax](../../reference/conditional-compilation.html) will be used to define these sections: ```toml @@ -469,7 +469,7 @@ run `rustc --print=cfg --target=x86_64-pc-windows-msvc`. Unlike in your Rust source code, you cannot use `[target.'cfg(feature = "my_crate")'.dependencies]` to add dependencies based on optional crate features. -Use [the `[features]` section](reference/manifest.html#the-features-section) +Use [the `[features]` section](manifest.md#the-features-section) instead. In addition to `#[cfg]` syntax, Cargo also supports listing out the full target @@ -560,7 +560,7 @@ features = ["secure-password", "civet"] ``` More information about features can be found in the -[manifest documentation](reference/manifest.html#the-features-section). +[manifest documentation](manifest.md#the-features-section). ### Renaming dependencies in `Cargo.toml` diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md index d524e94337a..5ec4e191614 100644 --- a/src/doc/src/reference/unstable.md +++ b/src/doc/src/reference/unstable.md @@ -102,7 +102,7 @@ Overrides can only be specified for dev and release profiles. Profiles can be specified in `.cargo/config` files. The `-Z config-profile` command-line flag is required to use this feature. The format is the same as in a `Cargo.toml` manifest. If found in multiple config files, settings will -be merged using the regular [config hierarchy](reference/config.html#hierarchical-structure). +be merged using the regular [config hierarchy](config.md#hierarchical-structure). Config settings take precedence over manifest settings. ```toml