From 02d7942c544669508bf9935edd208d306c185413 Mon Sep 17 00:00:00 2001 From: Enyium <123484196+Enyium@users.noreply.github.com> Date: Thu, 9 Feb 2023 23:39:38 +0100 Subject: [PATCH 1/5] Fix typos. --- src/doc/book.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/doc/book.toml b/src/doc/book.toml index 350d00dc9a5..fdbba067ee9 100644 --- a/src/doc/book.toml +++ b/src/doc/book.toml @@ -1,6 +1,6 @@ [book] title = "The Cargo Book" -author = "Alex Crichton, Steve Klabnik and Carol Nichols, with Contributions from the Rust Community" +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" From 2a4ec9f2f18c277ecefb54e2ffd77fa200a1233d Mon Sep 17 00:00:00 2001 From: Enyium <123484196+Enyium@users.noreply.github.com> Date: Sun, 12 Feb 2023 12:18:31 +0100 Subject: [PATCH 2/5] Update `pulldown-cmark` to next breaking version. --- crates/mdman/Cargo.lock | 12 ++++++------ crates/mdman/Cargo.toml | 2 +- crates/mdman/src/format/man.rs | 10 +++++----- crates/mdman/src/format/text.rs | 14 +++++++------- crates/mdman/src/util.rs | 2 +- crates/mdman/tests/compare/expected/formatting.1 | 10 ++-------- crates/mdman/tests/compare/expected/formatting.txt | 6 +----- 7 files changed, 23 insertions(+), 33 deletions(-) diff --git a/crates/mdman/Cargo.lock b/crates/mdman/Cargo.lock index 50948b5eca4..bb67460dd96 100644 --- a/crates/mdman/Cargo.lock +++ b/crates/mdman/Cargo.lock @@ -17,9 +17,9 @@ checksum = "6b602bfe940d21c130f3895acd65221e8a61270debe89d628b9cb4e3ccb8569b" [[package]] name = "bitflags" -version = "1.2.1" +version = "1.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cf1de2fe8c75bc145a2f577add951f8134889b4795d47466a54a5c846d691693" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" [[package]] name = "block-buffer" @@ -178,9 +178,9 @@ dependencies = [ [[package]] name = "memchr" -version = "2.3.3" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3728d817d99e5ac407411fa471ff9800a778d88a24685968b36824eaf4bee400" +checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d" [[package]] name = "opaque-debug" @@ -269,9 +269,9 @@ dependencies = [ [[package]] name = "pulldown-cmark" -version = "0.7.2" +version = "0.9.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ca36dea94d187597e104a5c8e4b07576a8a45aa5db48a65e12940d3eb7461f55" +checksum = "2d9cc634bc78768157b5cbfe988ffcd1dcba95cd2b2f03a88316c08c6d00ed63" dependencies = [ "bitflags", "memchr", diff --git a/crates/mdman/Cargo.toml b/crates/mdman/Cargo.toml index bae299f4525..28c8518e620 100644 --- a/crates/mdman/Cargo.toml +++ b/crates/mdman/Cargo.toml @@ -8,7 +8,7 @@ description = "Creates a man page page from markdown." [dependencies] anyhow = "1.0.31" handlebars = { version = "3.2.1", features = ["dir_source"] } -pulldown-cmark = { version = "0.7.2", default-features = false } +pulldown-cmark = { version = "0.9.2", default-features = false } same-file = "1.0.6" serde_json = "1.0.56" url = "2.2.2" diff --git a/crates/mdman/src/format/man.rs b/crates/mdman/src/format/man.rs index 1962be2fe55..5df81787122 100644 --- a/crates/mdman/src/format/man.rs +++ b/crates/mdman/src/format/man.rs @@ -3,7 +3,7 @@ use crate::util::{header_text, parse_name_and_section}; use crate::EventIter; use anyhow::{bail, Error}; -use pulldown_cmark::{Alignment, Event, LinkType, Tag}; +use pulldown_cmark::{Alignment, Event, HeadingLevel, LinkType, Tag}; use std::fmt::Write; use url::Url; @@ -122,10 +122,10 @@ impl<'e> ManRenderer<'e> { self.output.push_str(".sp\n"); } } - Tag::Heading(n) => { - if n == 1 { + Tag::Heading(level, ..) => { + if level == HeadingLevel::H1 { self.push_top_header()?; - } else if n == 2 { + } else if level == HeadingLevel::H2 { // Section header let text = header_text(&mut self.parser)?; self.flush(); @@ -255,7 +255,7 @@ impl<'e> ManRenderer<'e> { Event::End(tag) => { match &tag { Tag::Paragraph => self.flush(), - Tag::Heading(_n) => {} + Tag::Heading(..) => {} Tag::BlockQuote => { self.flush(); // restore left margin, restore line length diff --git a/crates/mdman/src/format/text.rs b/crates/mdman/src/format/text.rs index 2c6a4ff1747..ae07985a607 100644 --- a/crates/mdman/src/format/text.rs +++ b/crates/mdman/src/format/text.rs @@ -3,7 +3,7 @@ use crate::util::{header_text, unwrap}; use crate::EventIter; use anyhow::{bail, Error}; -use pulldown_cmark::{Alignment, Event, LinkType, Tag}; +use pulldown_cmark::{Alignment, Event, HeadingLevel, LinkType, Tag}; use std::fmt::Write; use std::mem; use url::Url; @@ -116,24 +116,24 @@ impl<'e> TextRenderer<'e> { self.flush(); } } - Tag::Heading(n) => { + Tag::Heading(level, ..) => { self.flush(); - if n == 1 { + if level == HeadingLevel::H1 { let text = header_text(&mut self.parser)?; self.push_to_line(&text.to_uppercase()); self.hard_break(); self.hard_break(); - } else if n == 2 { + } else if level == HeadingLevel::H2 { let text = header_text(&mut self.parser)?; self.push_to_line(&text.to_uppercase()); self.flush(); self.indent = 7; } else { let text = header_text(&mut self.parser)?; - self.push_indent((n as usize - 2) * 3); + self.push_indent((level as usize - 2) * 3); self.push_to_line(&text); self.flush(); - self.indent = (n as usize - 1) * 3 + 1; + self.indent = (level as usize - 1) * 3 + 1; } } Tag::BlockQuote => { @@ -223,7 +223,7 @@ impl<'e> TextRenderer<'e> { self.flush(); self.hard_break(); } - Tag::Heading(_n) => {} + Tag::Heading(..) => {} Tag::BlockQuote => { self.indent -= 3; } diff --git a/crates/mdman/src/util.rs b/crates/mdman/src/util.rs index e85f22093a7..a4c71ad38af 100644 --- a/crates/mdman/src/util.rs +++ b/crates/mdman/src/util.rs @@ -31,7 +31,7 @@ pub fn header_text<'e>(parser: &mut EventIter<'e>) -> Result, Error> e => bail!("expected plain text in man header, got {:?}", e), }; match parser.next() { - Some((Event::End(Tag::Heading(_)), _range)) => { + Some((Event::End(Tag::Heading(..)), _range)) => { return Ok(text); } e => bail!("expected plain text in man header, got {:?}", e), diff --git a/crates/mdman/tests/compare/expected/formatting.1 b/crates/mdman/tests/compare/expected/formatting.1 index dbd24526289..120859287c6 100644 --- a/crates/mdman/tests/compare/expected/formatting.1 +++ b/crates/mdman/tests/compare/expected/formatting.1 @@ -66,14 +66,8 @@ With a second paragraph inside it .sp .RS 4 \h'-04'\(bu\h'+02'Milk -.sp -.RS 4 -\h'-04' 5.\h'+01'Don't start at one. -.RE -.sp -.RS 4 -\h'-04' 6.\h'+01'tamarind -.RE +5. Don't start at one. +6. tamarind .RE .RE .sp diff --git a/crates/mdman/tests/compare/expected/formatting.txt b/crates/mdman/tests/compare/expected/formatting.txt index 865b714b630..87bbb87dc12 100644 --- a/crates/mdman/tests/compare/expected/formatting.txt +++ b/crates/mdman/tests/compare/expected/formatting.txt @@ -43,11 +43,7 @@ LISTS o Eggs - o Milk - - 5. Don't start at one. - - 6. tamarind + o Milk 5. Don't start at one. 6. tamarind 2. Second element From 0263ef43798929043b01f391760bdfb0a41523f7 Mon Sep 17 00:00:00 2001 From: Enyium <123484196+Enyium@users.noreply.github.com> Date: Sun, 12 Feb 2023 06:03:25 +0100 Subject: [PATCH 3/5] Enable smart punctuation in mdBook. --- .github/workflows/contrib.yml | 2 +- crates/mdman/Cargo.lock | 2 ++ crates/mdman/src/format/man.rs | 10 ++++++++-- crates/mdman/src/lib.rs | 1 + crates/mdman/tests/compare/expected/formatting.1 | 2 +- crates/mdman/tests/compare/expected/formatting.txt | 2 +- crates/mdman/tests/compare/expected/options.1 | 4 ++-- crates/mdman/tests/compare/expected/options.md | 2 +- crates/mdman/tests/compare/expected/options.txt | 4 ++-- src/doc/book.toml | 1 + src/doc/contrib/book.toml | 1 + 11 files changed, 21 insertions(+), 10 deletions(-) diff --git a/.github/workflows/contrib.yml b/.github/workflows/contrib.yml index 1872ae11ce6..ee1529194c4 100644 --- a/.github/workflows/contrib.yml +++ b/.github/workflows/contrib.yml @@ -19,7 +19,7 @@ jobs: - name: Install mdbook run: | mkdir mdbook - curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.9/mdbook-v0.4.9-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.26/mdbook-v0.4.26-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook echo `pwd`/mdbook >> $GITHUB_PATH - name: Deploy docs run: | diff --git a/crates/mdman/Cargo.lock b/crates/mdman/Cargo.lock index bb67460dd96..2ce8af0d1ae 100644 --- a/crates/mdman/Cargo.lock +++ b/crates/mdman/Cargo.lock @@ -1,5 +1,7 @@ # This file is automatically @generated by Cargo. # It is not intended for manual editing. +version = 3 + [[package]] name = "ansi_term" version = "0.11.0" diff --git a/crates/mdman/src/format/man.rs b/crates/mdman/src/format/man.rs index 5df81787122..9767fdd5186 100644 --- a/crates/mdman/src/format/man.rs +++ b/crates/mdman/src/format/man.rs @@ -400,12 +400,20 @@ impl<'e> ManRenderer<'e> { } fn escape(s: &str) -> Result { + // Note: Possible source on output escape sequences: https://man7.org/linux/man-pages/man7/groff_char.7.html. + // Otherwise, use generic escaping in the form `\[u1EE7]` or `\[u1F994]`. + let mut replaced = s .replace('\\', "\\(rs") .replace('-', "\\-") .replace('\u{00A0}', "\\ ") // non-breaking space (non-stretchable) .replace('–', "\\[en]") // \u{2013} en-dash .replace('—', "\\[em]") // \u{2014} em-dash + .replace('‘', "\\[oq]") // \u{2018} left single quote + .replace('’', "\\[cq]") // \u{2019} right single quote or apostrophe + .replace('“', "\\[lq]") // \u{201C} left double quote + .replace('”', "\\[rq]") // \u{201D} right double quote + .replace('…', "\\[u2026]") // \u{2026} ellipsis .replace('│', "|") // \u{2502} box drawing light vertical (could use \[br]) .replace('├', "|") // \u{251C} box drawings light vertical and right .replace('└', "`") // \u{2514} box drawings light up and right @@ -413,8 +421,6 @@ fn escape(s: &str) -> Result { ; if replaced.starts_with('.') { replaced = format!("\\&.{}", &replaced[1..]); - } else if replaced.starts_with('\'') { - replaced = format!("\\(aq{}", &replaced[1..]); } if let Some(ch) = replaced.chars().find(|ch| { diff --git a/crates/mdman/src/lib.rs b/crates/mdman/src/lib.rs index 0b17be59010..01c3c8d3154 100644 --- a/crates/mdman/src/lib.rs +++ b/crates/mdman/src/lib.rs @@ -69,6 +69,7 @@ pub(crate) fn md_parser(input: &str, url: Option) -> EventIter { options.insert(Options::ENABLE_TABLES); options.insert(Options::ENABLE_FOOTNOTES); options.insert(Options::ENABLE_STRIKETHROUGH); + options.insert(Options::ENABLE_SMART_PUNCTUATION); let parser = Parser::new_ext(input, options); let parser = parser.into_offset_iter(); // Translate all links to include the base url. diff --git a/crates/mdman/tests/compare/expected/formatting.1 b/crates/mdman/tests/compare/expected/formatting.1 index 120859287c6..076c5135a64 100644 --- a/crates/mdman/tests/compare/expected/formatting.1 +++ b/crates/mdman/tests/compare/expected/formatting.1 @@ -66,7 +66,7 @@ With a second paragraph inside it .sp .RS 4 \h'-04'\(bu\h'+02'Milk -5. Don't start at one. +5. Don\[cq]t start at one. 6. tamarind .RE .RE diff --git a/crates/mdman/tests/compare/expected/formatting.txt b/crates/mdman/tests/compare/expected/formatting.txt index 87bbb87dc12..face4a3cced 100644 --- a/crates/mdman/tests/compare/expected/formatting.txt +++ b/crates/mdman/tests/compare/expected/formatting.txt @@ -43,7 +43,7 @@ LISTS o Eggs - o Milk 5. Don't start at one. 6. tamarind + o Milk 5. Don’t start at one. 6. tamarind 2. Second element diff --git a/crates/mdman/tests/compare/expected/options.1 b/crates/mdman/tests/compare/expected/options.1 index 2d75cd25e9d..d362421e9f0 100644 --- a/crates/mdman/tests/compare/expected/options.1 +++ b/crates/mdman/tests/compare/expected/options.1 @@ -12,7 +12,7 @@ my\-command \- A brief description .br \fBmy\-command\fR (\fB\-m\fR | \fB\-M\fR) [\fIoldbranch\fR] \fInewbranch\fR .br -\fBmy\-command\fR (\fB\-d\fR | \fB\-D\fR) [\fB\-r\fR] \fIbranchname\fR\&... +\fBmy\-command\fR (\fB\-d\fR | \fB\-D\fR) [\fB\-r\fR] \fIbranchname\fR\[u2026] .SH "DESCRIPTION" A description of the command. .sp @@ -49,7 +49,7 @@ Demo \fIemphasis\fR, \fBstrong\fR, ~~strike~~ This has multiple flags. .RE .sp -\fInamed\-arg...\fR +\fInamed\-arg\[u2026]\fR .RS 4 A named argument. .RE diff --git a/crates/mdman/tests/compare/expected/options.md b/crates/mdman/tests/compare/expected/options.md index d8b8276f6e0..19b0b443b64 100644 --- a/crates/mdman/tests/compare/expected/options.md +++ b/crates/mdman/tests/compare/expected/options.md @@ -37,7 +37,7 @@ A description of the command.
This has multiple flags.
-
named-arg...
+
named-arg…
A named argument.
diff --git a/crates/mdman/tests/compare/expected/options.txt b/crates/mdman/tests/compare/expected/options.txt index 32ccfd249b8..9bfdec67c95 100644 --- a/crates/mdman/tests/compare/expected/options.txt +++ b/crates/mdman/tests/compare/expected/options.txt @@ -7,7 +7,7 @@ SYNOPSIS my-command [--abc | --xyz] name my-command [-f file] my-command (-m | -M) [oldbranch] newbranch - my-command (-d | -D) [-r] branchname... + my-command (-d | -D) [-r] branchname… DESCRIPTION A description of the command. @@ -29,7 +29,7 @@ OPTIONS -p spec, --package spec This has multiple flags. - named-arg... + named-arg… A named argument. Common Options diff --git a/src/doc/book.toml b/src/doc/book.toml index fdbba067ee9..1dd1f8e0f37 100644 --- a/src/doc/book.toml +++ b/src/doc/book.toml @@ -3,5 +3,6 @@ title = "The Cargo Book" author = "Alex Crichton, Steve Klabnik and Carol Nichols, with contributions from the Rust community" [output.html] +curly-quotes = true # Enable smart-punctuation feature for more than quotes. git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src" edit-url-template = "https://github.com/rust-lang/cargo/edit/master/src/doc/{path}" diff --git a/src/doc/contrib/book.toml b/src/doc/contrib/book.toml index 543d58576bd..d6697f37f5c 100644 --- a/src/doc/contrib/book.toml +++ b/src/doc/contrib/book.toml @@ -3,6 +3,7 @@ title = "Cargo Contributor Guide" authors = ["Eric Huss"] [output.html] +curly-quotes = true # Enable smart-punctuation feature for more than quotes. git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/contrib/src" [output.html.redirect] From bed7dfb5fa0d15dcde02b34285ad55b7f8ded711 Mon Sep 17 00:00:00 2001 From: Enyium <123484196+Enyium@users.noreply.github.com> Date: Thu, 9 Feb 2023 23:49:22 +0100 Subject: [PATCH 4/5] Ensure em dashes are recognizable in markup. Also correct some hyphens to em dashes. --- src/doc/contrib/src/architecture/codebase.md | 52 ++-- src/doc/contrib/src/architecture/packages.md | 16 +- src/doc/contrib/src/issues.md | 10 +- src/doc/contrib/src/tests/writing.md | 16 +- src/doc/man/cargo-add.md | 2 +- src/doc/man/cargo-bench.md | 4 +- src/doc/man/cargo-build.md | 2 +- src/doc/man/cargo-check.md | 2 +- src/doc/man/cargo-clean.md | 2 +- src/doc/man/cargo-doc.md | 2 +- src/doc/man/cargo-fetch.md | 2 +- src/doc/man/cargo-fix.md | 2 +- src/doc/man/cargo-generate-lockfile.md | 2 +- src/doc/man/cargo-help.md | 2 +- src/doc/man/cargo-init.md | 2 +- src/doc/man/cargo-install.md | 2 +- src/doc/man/cargo-locate-project.md | 2 +- src/doc/man/cargo-login.md | 2 +- src/doc/man/cargo-metadata.md | 2 +- src/doc/man/cargo-new.md | 2 +- src/doc/man/cargo-owner.md | 2 +- src/doc/man/cargo-package.md | 2 +- src/doc/man/cargo-pkgid.md | 2 +- src/doc/man/cargo-publish.md | 2 +- src/doc/man/cargo-remove.md | 2 +- src/doc/man/cargo-report.md | 4 +- src/doc/man/cargo-run.md | 2 +- src/doc/man/cargo-rustc.md | 8 +- src/doc/man/cargo-rustdoc.md | 2 +- src/doc/man/cargo-search.md | 2 +- src/doc/man/cargo-test.md | 6 +- src/doc/man/cargo-tree.md | 36 +-- src/doc/man/cargo-uninstall.md | 2 +- src/doc/man/cargo-update.md | 2 +- src/doc/man/cargo-vendor.md | 2 +- src/doc/man/cargo-verify-project.md | 2 +- src/doc/man/cargo-version.md | 2 +- src/doc/man/cargo-yank.md | 2 +- src/doc/man/cargo.md | 2 +- src/doc/src/appendix/glossary.md | 24 +- src/doc/src/index.md | 6 +- .../src/reference/build-script-examples.md | 10 +- src/doc/src/reference/build-scripts.md | 32 +-- .../src/reference/environment-variables.md | 240 +++++++++--------- src/doc/src/reference/features.md | 2 +- src/doc/src/reference/manifest.md | 90 +++---- src/doc/src/reference/profiles.md | 8 +- src/doc/src/reference/resolver.md | 2 +- src/doc/src/reference/semver.md | 6 +- src/doc/src/reference/source-replacement.md | 4 +- .../src/reference/specifying-dependencies.md | 4 +- src/doc/src/reference/timings.md | 6 +- src/doc/src/reference/unstable.md | 102 ++++---- src/doc/src/reference/workspaces.md | 22 +- 54 files changed, 385 insertions(+), 385 deletions(-) diff --git a/src/doc/contrib/src/architecture/codebase.md b/src/doc/contrib/src/architecture/codebase.md index 7e3b077fa92..45c6e0e2f1d 100644 --- a/src/doc/contrib/src/architecture/codebase.md +++ b/src/doc/contrib/src/architecture/codebase.md @@ -3,73 +3,73 @@ This is a very high-level overview of the Cargo codebase. * [`src/bin/cargo`](https://github.com/rust-lang/cargo/tree/master/src/bin/cargo) - — Cargo is split in a library and a binary. This is the binary side that + --- Cargo is split in a library and a binary. This is the binary side that handles argument parsing, and then calls into the library to perform the appropriate subcommand. Each Cargo subcommand is a separate module here. See [SubCommands](subcommands.md). * [`src/cargo/ops`](https://github.com/rust-lang/cargo/tree/master/src/cargo/ops) - — Every major operation is implemented here. This is where the binary CLI + --- Every major operation is implemented here. This is where the binary CLI usually calls into to perform the appropriate action. * [`src/cargo/ops/cargo_compile/mod.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/ops/cargo_compile/mod.rs) - — This is the entry point for all the compilation commands. This is a + --- This is the entry point for all the compilation commands. This is a good place to start if you want to follow how compilation starts and flows to completion. * [`src/cargo/core/resolver`](https://github.com/rust-lang/cargo/tree/master/src/cargo/core/resolver) - — This is the dependency and feature resolvers. + --- This is the dependency and feature resolvers. * [`src/cargo/core/compiler`](https://github.com/rust-lang/cargo/tree/master/src/cargo/core/compiler) - — This is the code responsible for running `rustc` and `rustdoc`. + --- This is the code responsible for running `rustc` and `rustdoc`. * [`src/cargo/core/compiler/build_context/mod.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/build_context/mod.rs) - — The `BuildContext` is the result of the "front end" of the build + --- The `BuildContext` is the result of the "front end" of the build process. This contains the graph of work to perform and any settings necessary for `rustc`. After this is built, the next stage of building is handled in `Context`. * [`src/cargo/core/compiler/context`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/context/mod.rs) - — The `Context` is the mutable state used during the build process. This + --- The `Context` is the mutable state used during the build process. This is the core of the build process, and everything is coordinated through this. * [`src/cargo/core/compiler/fingerprint.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/fingerprint.rs) - — The `fingerprint` module contains all the code that handles detecting + --- The `fingerprint` module contains all the code that handles detecting if a crate needs to be recompiled. * [`src/cargo/core/source`](https://github.com/rust-lang/cargo/tree/master/src/cargo/core/source) - — The `Source` trait is an abstraction over different sources of packages. + --- The `Source` trait is an abstraction over different sources of packages. Sources are uniquely identified by a `SourceId`. Sources are implemented in the [`src/cargo/sources`](https://github.com/rust-lang/cargo/tree/master/src/cargo/sources) directory. * [`src/cargo/util`](https://github.com/rust-lang/cargo/tree/master/src/cargo/util) - — This directory contains generally-useful utility modules. + --- This directory contains generally-useful utility modules. * [`src/cargo/util/config`](https://github.com/rust-lang/cargo/tree/master/src/cargo/util/config) - — This directory contains the config parser. It makes heavy use of + --- This directory contains the config parser. It makes heavy use of [serde](https://serde.rs/) to merge and translate config values. The `Config` is usually accessed from the [`Workspace`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/workspace.rs), though references to it are scattered around for more convenient access. * [`src/cargo/util/toml`](https://github.com/rust-lang/cargo/tree/master/src/cargo/util/toml) - — This directory contains the code for parsing `Cargo.toml` files. + --- This directory contains the code for parsing `Cargo.toml` files. * [`src/cargo/ops/lockfile.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/ops/lockfile.rs) - — This is where `Cargo.lock` files are loaded and saved. + --- This is where `Cargo.lock` files are loaded and saved. * [`src/doc`](https://github.com/rust-lang/cargo/tree/master/src/doc) - — This directory contains Cargo's documentation and man pages. + --- This directory contains Cargo's documentation and man pages. * [`src/etc`](https://github.com/rust-lang/cargo/tree/master/src/etc) - — These are files that get distributed in the `etc` directory in the Rust release. + --- These are files that get distributed in the `etc` directory in the Rust release. The man pages are auto-generated by a script in the `src/doc` directory. * [`crates`](https://github.com/rust-lang/cargo/tree/master/crates) - — A collection of independent crates used by Cargo. + --- A collection of independent crates used by Cargo. ## Extra crates @@ -77,32 +77,32 @@ Some functionality is split off into separate crates, usually in the [`crates`](https://github.com/rust-lang/cargo/tree/master/crates) directory. * [`cargo-platform`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-platform) - — This library handles parsing `cfg` expressions. + --- This library handles parsing `cfg` expressions. * [`cargo-test-macro`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-test-macro) - — This is a proc-macro used by the test suite to define tests. More + --- This is a proc-macro used by the test suite to define tests. More information can be found at [`cargo_test` attribute](../tests/writing.md#cargo_test-attribute). * [`cargo-test-support`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-test-support) - — This contains a variety of code to support [writing + --- This contains a variety of code to support [writing tests](../tests/writing.md). * [`cargo-util`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-util) - — This contains general utility code that is shared between cargo and the + --- This contains general utility code that is shared between cargo and the testsuite. * [`crates-io`](https://github.com/rust-lang/cargo/tree/master/crates/crates-io) - — This contains code for accessing the crates.io API. + --- This contains code for accessing the crates.io API. * [`credential`](https://github.com/rust-lang/cargo/tree/master/crates/credential) - — This subdirectory contains several packages for implementing the + --- This subdirectory contains several packages for implementing the experimental [credential-process](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process) feature. -* [`home`](https://github.com/rust-lang/cargo/tree/master/crates/home) — This library is shared between cargo and rustup and is used for finding their home directories. +* [`home`](https://github.com/rust-lang/cargo/tree/master/crates/home) --- This library is shared between cargo and rustup and is used for finding their home directories. This is not directly depended upon with a `path` dependency; cargo uses the version from crates.io. It is intended to be versioned and published independently of Rust's release system. Whenever a change needs to be made, bump the version in Cargo.toml and `cargo publish` it manually, and then update cargo's `Cargo.toml` to depend on the new version. -* [`mdman`](https://github.com/rust-lang/cargo/tree/master/crates/mdman) — - This is a utility for generating cargo's man pages. See [Building the man +* [`mdman`](https://github.com/rust-lang/cargo/tree/master/crates/mdman) + --- This is a utility for generating cargo's man pages. See [Building the man pages](https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages) for more information. * [`resolver-tests`](https://github.com/rust-lang/cargo/tree/master/crates/resolver-tests) - — This is a dedicated package that defines tests for the [dependency + --- This is a dedicated package that defines tests for the [dependency resolver](../architecture/packages.md#resolver). diff --git a/src/doc/contrib/src/architecture/packages.md b/src/doc/contrib/src/architecture/packages.md index dc7deefbb8d..626714bf468 100644 --- a/src/doc/contrib/src/architecture/packages.md +++ b/src/doc/contrib/src/architecture/packages.md @@ -16,27 +16,27 @@ actually compiled by `rustc`. There are several data structures that are important to understand how packages are found and loaded: -* [`Package`] — A package, which is a `Cargo.toml` manifest and its associated +* [`Package`] --- A package, which is a `Cargo.toml` manifest and its associated source files. - * [`PackageId`] — A unique identifier for a package. -* [`Source`] — An abstraction for something that can fetch packages (a remote + * [`PackageId`] --- A unique identifier for a package. +* [`Source`] --- An abstraction for something that can fetch packages (a remote registry, a git repo, the local filesystem, etc.). Check out the [source implementations] for all the details about registries, indexes, git dependencies, etc. - * [`SourceId`] — A unique identifier for a source. -* [`SourceMap`] — Map of all available sources. -* [`PackageRegistry`] — This is the main interface for how the dependency + * [`SourceId`] --- A unique identifier for a source. +* [`SourceMap`] --- Map of all available sources. +* [`PackageRegistry`] --- This is the main interface for how the dependency resolver finds packages. It contains the `SourceMap`, and handles things like the `[patch]` table. The `Registry` trait provides a generic interface to the `PackageRegistry`, but this is only used for providing an alternate implementation of the `PackageRegistry` for testing. The dependency resolver sends a query to the `PackageRegistry` to "get me all packages that match this dependency declaration". -* [`Summary`] — A summary is a subset of a [`Manifest`], and is essentially +* [`Summary`] --- A summary is a subset of a [`Manifest`], and is essentially the information that can be found in a registry index. Queries against the `PackageRegistry` yields a `Summary`. The resolver uses the summary information to build the dependency graph. -* [`PackageSet`] — Contains all of the `Package` objects. This works with the +* [`PackageSet`] --- Contains all of the `Package` objects. This works with the [`Downloads`] struct to coordinate downloading packages. It has a reference to the `SourceMap` to get the `Source` objects which tell the `Downloads` struct which URLs to fetch. diff --git a/src/doc/contrib/src/issues.md b/src/doc/contrib/src/issues.md index 30e2d8316f2..8fc69544c61 100644 --- a/src/doc/contrib/src/issues.md +++ b/src/doc/contrib/src/issues.md @@ -26,11 +26,11 @@ If you file in the wrong tracker, someone will either transfer it to the correct one or ask you to move it. Some other repositories that may be relevant are: -* [`rust-lang/rust`] — Home for the [`rustc`] compiler and [`rustdoc`]. -* [`rust-lang/rustup`] — Home for the [`rustup`] toolchain installer. -* [`rust-lang/rustfmt`] — Home for the `rustfmt` tool, which also includes `cargo fmt`. -* [`rust-lang/rust-clippy`] — Home for the `clippy` tool, which also includes `cargo clippy`. -* [`rust-lang/crates.io`] — Home for the [crates.io] website. +* [`rust-lang/rust`] --- Home for the [`rustc`] compiler and [`rustdoc`]. +* [`rust-lang/rustup`] --- Home for the [`rustup`] toolchain installer. +* [`rust-lang/rustfmt`] --- Home for the `rustfmt` tool, which also includes `cargo fmt`. +* [`rust-lang/rust-clippy`] --- Home for the `clippy` tool, which also includes `cargo clippy`. +* [`rust-lang/crates.io`] --- Home for the [crates.io] website. Issues with [`cargo fix`] can be tricky to know where they should be filed, since the fixes are driven by `rustc`, processed by [`rustfix`], and the diff --git a/src/doc/contrib/src/tests/writing.md b/src/doc/contrib/src/tests/writing.md index 51fc6a74e53..b08d8b92541 100644 --- a/src/doc/contrib/src/tests/writing.md +++ b/src/doc/contrib/src/tests/writing.md @@ -77,34 +77,34 @@ They are listed in parentheses separated with commas, such as: The options it supports are: -* `nightly` — This will cause the test to be ignored if not running on the nightly toolchain. +* `nightly` --- This will cause the test to be ignored if not running on the nightly toolchain. This is useful for tests that use unstable options in `rustc` or `rustdoc`. These tests are run in Cargo's CI, but are disabled in rust-lang/rust's CI due to the difficulty of updating both repos simultaneously. A `reason` field is required to explain why it is nightly-only. -* `build_std_real` — This is a "real" `-Zbuild-std` test (in the `build_std` integration test). +* `build_std_real` --- This is a "real" `-Zbuild-std` test (in the `build_std` integration test). This only runs on nightly, and only if the environment variable `CARGO_RUN_BUILD_STD_TESTS` is set (these tests on run on Linux). -* `build_std_mock` — This is a "mock" `-Zbuild-std` test (which uses a mock standard library). +* `build_std_mock` --- This is a "mock" `-Zbuild-std` test (which uses a mock standard library). This only runs on nightly, and is disabled for windows-gnu. -* `requires_` — This indicates a command that is required to be installed to be run. +* `requires_` --- This indicates a command that is required to be installed to be run. For example, `requires_rustfmt` means the test will only run if the executable `rustfmt` is installed. These tests are *always* run on CI. This is mainly used to avoid requiring contributors from having every dependency installed. -* `>=1.64` — This indicates that the test will only run with the given version of `rustc` or newer. +* `>=1.64` --- This indicates that the test will only run with the given version of `rustc` or newer. This can be used when a new `rustc` feature has been stabilized that the test depends on. If this is specified, a `reason` is required to explain why it is being checked. -* `public_network_test` — This tests contacts the public internet. +* `public_network_test` --- This tests contacts the public internet. These tests are disabled unless the `CARGO_PUBLIC_NETWORK_TESTS` environment variable is set. Use of this should be *extremely rare*, please avoid using it if possible. The hosts it contacts should have a relatively high confidence that they are reliable and stable (such as github.com), especially in CI. The tests should be carefully considered for developer security and privacy as well. -* `container_test` — This indicates that it is a test that uses Docker. +* `container_test` --- This indicates that it is a test that uses Docker. These tests are disabled unless the `CARGO_CONTAINER_TESTS` environment variable is set. This requires that you have Docker installed. The SSH tests also assume that you have OpenSSH installed. These should work on Linux, macOS, and Windows where possible. Unfortunately these tests are not run in CI for macOS or Windows (no Docker on macOS, and Windows does not support Linux images). See [`crates/cargo-test-support/src/containers.rs`](https://github.com/rust-lang/cargo/blob/master/crates/cargo-test-support/src/containers.rs) for more on writing these tests. -* `ignore_windows="reason"` — Indicates that the test should be ignored on windows for the given reason. +* `ignore_windows="reason"` --- Indicates that the test should be ignored on windows for the given reason. #### Testing Nightly Features diff --git a/src/doc/man/cargo-add.md b/src/doc/man/cargo-add.md index cca9fb5b47f..07f8fd225d7 100644 --- a/src/doc/man/cargo-add.md +++ b/src/doc/man/cargo-add.md @@ -4,7 +4,7 @@ ## NAME -cargo-add - Add dependencies to a Cargo.toml manifest file +cargo-add --- Add dependencies to a Cargo.toml manifest file ## SYNOPSIS diff --git a/src/doc/man/cargo-bench.md b/src/doc/man/cargo-bench.md index 1155ac50b92..32c98dadaeb 100644 --- a/src/doc/man/cargo-bench.md +++ b/src/doc/man/cargo-bench.md @@ -5,7 +5,7 @@ ## NAME -cargo-bench - Execute benchmarks of a package +cargo-bench --- Execute benchmarks of a package ## SYNOPSIS @@ -69,7 +69,7 @@ debugger. When no target selection options are given, `cargo bench` will build the following targets of the selected packages: -- lib — used to link with binaries and benchmarks +- lib --- used to link with binaries and benchmarks - bins (only if benchmark targets are built and required features are available) - lib as a benchmark diff --git a/src/doc/man/cargo-build.md b/src/doc/man/cargo-build.md index 3b71ae6a317..98614444323 100644 --- a/src/doc/man/cargo-build.md +++ b/src/doc/man/cargo-build.md @@ -4,7 +4,7 @@ ## NAME -cargo-build - Compile the current package +cargo-build --- Compile the current package ## SYNOPSIS diff --git a/src/doc/man/cargo-check.md b/src/doc/man/cargo-check.md index 44a3d0fdc4d..055adff0d08 100644 --- a/src/doc/man/cargo-check.md +++ b/src/doc/man/cargo-check.md @@ -4,7 +4,7 @@ ## NAME -cargo-check - Check the current package +cargo-check --- Check the current package ## SYNOPSIS diff --git a/src/doc/man/cargo-clean.md b/src/doc/man/cargo-clean.md index be1fa1fce45..3222f7bb04b 100644 --- a/src/doc/man/cargo-clean.md +++ b/src/doc/man/cargo-clean.md @@ -4,7 +4,7 @@ ## NAME -cargo-clean - Remove generated artifacts +cargo-clean --- Remove generated artifacts ## SYNOPSIS diff --git a/src/doc/man/cargo-doc.md b/src/doc/man/cargo-doc.md index f8f517d9ae7..9d5b7764893 100644 --- a/src/doc/man/cargo-doc.md +++ b/src/doc/man/cargo-doc.md @@ -4,7 +4,7 @@ ## NAME -cargo-doc - Build a package's documentation +cargo-doc --- Build a package's documentation ## SYNOPSIS diff --git a/src/doc/man/cargo-fetch.md b/src/doc/man/cargo-fetch.md index 69ce103cae3..c31166a9b51 100644 --- a/src/doc/man/cargo-fetch.md +++ b/src/doc/man/cargo-fetch.md @@ -5,7 +5,7 @@ ## NAME -cargo-fetch - Fetch dependencies of a package from the network +cargo-fetch --- Fetch dependencies of a package from the network ## SYNOPSIS diff --git a/src/doc/man/cargo-fix.md b/src/doc/man/cargo-fix.md index e78ae34fd2e..64fe299446c 100644 --- a/src/doc/man/cargo-fix.md +++ b/src/doc/man/cargo-fix.md @@ -4,7 +4,7 @@ ## NAME -cargo-fix - Automatically fix lint warnings reported by rustc +cargo-fix --- Automatically fix lint warnings reported by rustc ## SYNOPSIS diff --git a/src/doc/man/cargo-generate-lockfile.md b/src/doc/man/cargo-generate-lockfile.md index a2b963cef44..3a2f52b3944 100644 --- a/src/doc/man/cargo-generate-lockfile.md +++ b/src/doc/man/cargo-generate-lockfile.md @@ -2,7 +2,7 @@ ## NAME -cargo-generate-lockfile - Generate the lockfile for a package +cargo-generate-lockfile --- Generate the lockfile for a package ## SYNOPSIS diff --git a/src/doc/man/cargo-help.md b/src/doc/man/cargo-help.md index edd8bc0cb1a..4a5a8f51575 100644 --- a/src/doc/man/cargo-help.md +++ b/src/doc/man/cargo-help.md @@ -2,7 +2,7 @@ ## NAME -cargo-help - Get help for a Cargo command +cargo-help --- Get help for a Cargo command ## SYNOPSIS diff --git a/src/doc/man/cargo-init.md b/src/doc/man/cargo-init.md index bdb5a82702e..cd8e623ca1c 100644 --- a/src/doc/man/cargo-init.md +++ b/src/doc/man/cargo-init.md @@ -2,7 +2,7 @@ ## NAME -cargo-init - Create a new Cargo package in an existing directory +cargo-init --- Create a new Cargo package in an existing directory ## SYNOPSIS diff --git a/src/doc/man/cargo-install.md b/src/doc/man/cargo-install.md index 118e3efdf03..56922bfc0c2 100644 --- a/src/doc/man/cargo-install.md +++ b/src/doc/man/cargo-install.md @@ -4,7 +4,7 @@ ## NAME -cargo-install - Build and install a Rust binary +cargo-install --- Build and install a Rust binary ## SYNOPSIS diff --git a/src/doc/man/cargo-locate-project.md b/src/doc/man/cargo-locate-project.md index 87cf9919f52..4ebf36d7d7c 100644 --- a/src/doc/man/cargo-locate-project.md +++ b/src/doc/man/cargo-locate-project.md @@ -2,7 +2,7 @@ ## NAME -cargo-locate-project - Print a JSON representation of a Cargo.toml file's location +cargo-locate-project --- Print a JSON representation of a Cargo.toml file's location ## SYNOPSIS diff --git a/src/doc/man/cargo-login.md b/src/doc/man/cargo-login.md index 0e361ab74a0..11c663c46c6 100644 --- a/src/doc/man/cargo-login.md +++ b/src/doc/man/cargo-login.md @@ -2,7 +2,7 @@ ## NAME -cargo-login - Save an API token from the registry locally +cargo-login --- Save an API token from the registry locally ## SYNOPSIS diff --git a/src/doc/man/cargo-metadata.md b/src/doc/man/cargo-metadata.md index 5197f03c200..4f9032d56cc 100644 --- a/src/doc/man/cargo-metadata.md +++ b/src/doc/man/cargo-metadata.md @@ -2,7 +2,7 @@ ## NAME -cargo-metadata - Machine-readable metadata about the current package +cargo-metadata --- Machine-readable metadata about the current package ## SYNOPSIS diff --git a/src/doc/man/cargo-new.md b/src/doc/man/cargo-new.md index d0ca9181224..ea6182ac37d 100644 --- a/src/doc/man/cargo-new.md +++ b/src/doc/man/cargo-new.md @@ -2,7 +2,7 @@ ## NAME -cargo-new - Create a new Cargo package +cargo-new --- Create a new Cargo package ## SYNOPSIS diff --git a/src/doc/man/cargo-owner.md b/src/doc/man/cargo-owner.md index 3787a4de045..32791696887 100644 --- a/src/doc/man/cargo-owner.md +++ b/src/doc/man/cargo-owner.md @@ -2,7 +2,7 @@ ## NAME -cargo-owner - Manage the owners of a crate on the registry +cargo-owner --- Manage the owners of a crate on the registry ## SYNOPSIS diff --git a/src/doc/man/cargo-package.md b/src/doc/man/cargo-package.md index d7f35c6234c..2000353cc47 100644 --- a/src/doc/man/cargo-package.md +++ b/src/doc/man/cargo-package.md @@ -5,7 +5,7 @@ ## NAME -cargo-package - Assemble the local package into a distributable tarball +cargo-package --- Assemble the local package into a distributable tarball ## SYNOPSIS diff --git a/src/doc/man/cargo-pkgid.md b/src/doc/man/cargo-pkgid.md index 761eede1dce..47ed133f9b5 100644 --- a/src/doc/man/cargo-pkgid.md +++ b/src/doc/man/cargo-pkgid.md @@ -2,7 +2,7 @@ ## NAME -cargo-pkgid - Print a fully qualified package specification +cargo-pkgid --- Print a fully qualified package specification ## SYNOPSIS diff --git a/src/doc/man/cargo-publish.md b/src/doc/man/cargo-publish.md index 560e3c10472..4ccb5b5298a 100644 --- a/src/doc/man/cargo-publish.md +++ b/src/doc/man/cargo-publish.md @@ -4,7 +4,7 @@ ## NAME -cargo-publish - Upload a package to the registry +cargo-publish --- Upload a package to the registry ## SYNOPSIS diff --git a/src/doc/man/cargo-remove.md b/src/doc/man/cargo-remove.md index b0150c1414e..0722e6e53de 100644 --- a/src/doc/man/cargo-remove.md +++ b/src/doc/man/cargo-remove.md @@ -4,7 +4,7 @@ ## NAME -cargo-remove - Remove dependencies from a Cargo.toml manifest file +cargo-remove --- Remove dependencies from a Cargo.toml manifest file ## SYNOPSIS diff --git a/src/doc/man/cargo-report.md b/src/doc/man/cargo-report.md index a505a014a33..ba33617dbb0 100644 --- a/src/doc/man/cargo-report.md +++ b/src/doc/man/cargo-report.md @@ -2,7 +2,7 @@ ## NAME -cargo-report - Generate and display various kinds of reports +cargo-report --- Generate and display various kinds of reports ## SYNOPSIS @@ -10,7 +10,7 @@ cargo-report - Generate and display various kinds of reports ### DESCRIPTION -Displays a report of the given _type_ - currently, only `future-incompat` is supported +Displays a report of the given _type_ --- currently, only `future-incompat` is supported ## OPTIONS diff --git a/src/doc/man/cargo-run.md b/src/doc/man/cargo-run.md index 4ec09f58da1..4b6b935242e 100644 --- a/src/doc/man/cargo-run.md +++ b/src/doc/man/cargo-run.md @@ -3,7 +3,7 @@ ## NAME -cargo-run - Run the current package +cargo-run --- Run the current package ## SYNOPSIS diff --git a/src/doc/man/cargo-rustc.md b/src/doc/man/cargo-rustc.md index 3ce5c193ab0..f3b37234c0c 100644 --- a/src/doc/man/cargo-rustc.md +++ b/src/doc/man/cargo-rustc.md @@ -4,7 +4,7 @@ ## NAME -cargo-rustc - Compile the current package, and pass extra options to the compiler +cargo-rustc --- Compile the current package, and pass extra options to the compiler ## SYNOPSIS @@ -55,13 +55,13 @@ Build with the given profile. The `rustc` subcommand will treat the following named profiles with special behaviors: -* `check` — Builds in the same way as the {{man "cargo-check" 1}} command with +* `check` --- Builds in the same way as the {{man "cargo-check" 1}} command with the `dev` profile. -* `test` — Builds in the same way as the {{man "cargo-test" 1}} command, +* `test` --- Builds in the same way as the {{man "cargo-test" 1}} command, enabling building in test mode which will enable tests and enable the `test` cfg option. See [rustc tests](https://doc.rust-lang.org/rustc/tests/index.html) for more detail. -* `bench` — Builds in the same was as the {{man "cargo-bench" 1}} command, +* `bench` --- Builds in the same was as the {{man "cargo-bench" 1}} command, similar to the `test` profile. See the [the reference](../reference/profiles.html) for more details on profiles. diff --git a/src/doc/man/cargo-rustdoc.md b/src/doc/man/cargo-rustdoc.md index 6c38780f324..23be579e9c6 100644 --- a/src/doc/man/cargo-rustdoc.md +++ b/src/doc/man/cargo-rustdoc.md @@ -4,7 +4,7 @@ ## NAME -cargo-rustdoc - Build a package's documentation, using specified custom flags +cargo-rustdoc --- Build a package's documentation, using specified custom flags ## SYNOPSIS diff --git a/src/doc/man/cargo-search.md b/src/doc/man/cargo-search.md index 5c7bcac3c2f..f3d87cb1278 100644 --- a/src/doc/man/cargo-search.md +++ b/src/doc/man/cargo-search.md @@ -2,7 +2,7 @@ ## NAME -cargo-search - Search packages in crates.io +cargo-search --- Search packages in crates.io ## SYNOPSIS diff --git a/src/doc/man/cargo-test.md b/src/doc/man/cargo-test.md index 7419b532397..0b6da16ca5e 100644 --- a/src/doc/man/cargo-test.md +++ b/src/doc/man/cargo-test.md @@ -5,7 +5,7 @@ ## NAME -cargo-test - Execute unit and integration tests of a package +cargo-test --- Execute unit and integration tests of a package ## SYNOPSIS @@ -70,10 +70,10 @@ on writing doc tests. When no target selection options are given, `cargo test` will build the following targets of the selected packages: -- lib — used to link with binaries, examples, integration tests, and doc tests +- lib --- used to link with binaries, examples, integration tests, and doc tests - bins (only if integration tests are built and required features are available) -- examples — to ensure they compile +- examples --- to ensure they compile - lib as a unit test - bins as unit tests - integration tests diff --git a/src/doc/man/cargo-tree.md b/src/doc/man/cargo-tree.md index 51b1d9e0e14..3e1da20df25 100644 --- a/src/doc/man/cargo-tree.md +++ b/src/doc/man/cargo-tree.md @@ -4,7 +4,7 @@ ## NAME -cargo-tree - Display a tree visualization of a dependency graph +cargo-tree --- Display a tree visualization of a dependency graph ## SYNOPSIS @@ -119,16 +119,16 @@ only one instance is built. {{#option "`-e` _kinds_" "`--edges` _kinds_" }} The dependency kinds to display. Takes a comma separated list of values: -- `all` — Show all edge kinds. -- `normal` — Show normal dependencies. -- `build` — Show build dependencies. -- `dev` — Show development dependencies. -- `features` — Show features enabled by each dependency. If this is the only +- `all` --- Show all edge kinds. +- `normal` --- Show normal dependencies. +- `build` --- Show build dependencies. +- `dev` --- Show development dependencies. +- `features` --- Show features enabled by each dependency. If this is the only kind given, then it will automatically include the other dependency kinds. -- `no-normal` — Do not include normal dependencies. -- `no-build` — Do not include build dependencies. -- `no-dev` — Do not include development dependencies. -- `no-proc-macro` — Do not include procedural macro dependencies. +- `no-normal` --- Do not include normal dependencies. +- `no-build` --- Do not include build dependencies. +- `no-dev` --- Do not include development dependencies. +- `no-proc-macro` --- Do not include procedural macro dependencies. The `normal`, `build`, `dev`, and `all` dependency kinds cannot be mixed with `no-normal`, `no-build`, or `no-dev` dependency kinds. @@ -158,19 +158,19 @@ Set the format string for each package. The default is "{p}". This is an arbitrary string which will be used to display each package. The following strings will be replaced with the corresponding value: -- `{p}` — The package name. -- `{l}` — The package license. -- `{r}` — The package repository URL. -- `{f}` — Comma-separated list of package features that are enabled. -- `{lib}` — The name, as used in a `use` statement, of the package's library. +- `{p}` --- The package name. +- `{l}` --- The package license. +- `{r}` --- The package repository URL. +- `{f}` --- Comma-separated list of package features that are enabled. +- `{lib}` --- The name, as used in a `use` statement, of the package's library. {{/option}} {{#option "`--prefix` _prefix_" }} Sets how each line is displayed. The _prefix_ value can be one of: -- `indent` (default) — Shows each line indented as a tree. -- `depth` — Show as a list, with the numeric depth printed before each entry. -- `none` — Show as a flat list. +- `indent` (default) --- Shows each line indented as a tree. +- `depth` --- Show as a list, with the numeric depth printed before each entry. +- `none` --- Show as a flat list. {{/option}} {{/options}} diff --git a/src/doc/man/cargo-uninstall.md b/src/doc/man/cargo-uninstall.md index 73c50c7a1de..b2ebd097fc3 100644 --- a/src/doc/man/cargo-uninstall.md +++ b/src/doc/man/cargo-uninstall.md @@ -2,7 +2,7 @@ ## NAME -cargo-uninstall - Remove a Rust binary +cargo-uninstall --- Remove a Rust binary ## SYNOPSIS diff --git a/src/doc/man/cargo-update.md b/src/doc/man/cargo-update.md index 54aa90ae846..e91606a6a09 100644 --- a/src/doc/man/cargo-update.md +++ b/src/doc/man/cargo-update.md @@ -2,7 +2,7 @@ ## NAME -cargo-update - Update dependencies as recorded in the local lock file +cargo-update --- Update dependencies as recorded in the local lock file ## SYNOPSIS diff --git a/src/doc/man/cargo-vendor.md b/src/doc/man/cargo-vendor.md index 9fd977951e7..b30d0d8dd22 100644 --- a/src/doc/man/cargo-vendor.md +++ b/src/doc/man/cargo-vendor.md @@ -2,7 +2,7 @@ ## NAME -cargo-vendor - Vendor all dependencies locally +cargo-vendor --- Vendor all dependencies locally ## SYNOPSIS diff --git a/src/doc/man/cargo-verify-project.md b/src/doc/man/cargo-verify-project.md index 99b749087b7..8b334fb14c5 100644 --- a/src/doc/man/cargo-verify-project.md +++ b/src/doc/man/cargo-verify-project.md @@ -2,7 +2,7 @@ ## NAME -cargo-verify-project - Check correctness of crate manifest +cargo-verify-project --- Check correctness of crate manifest ## SYNOPSIS diff --git a/src/doc/man/cargo-version.md b/src/doc/man/cargo-version.md index c6e4535323d..9bbadc9ea50 100644 --- a/src/doc/man/cargo-version.md +++ b/src/doc/man/cargo-version.md @@ -2,7 +2,7 @@ ## NAME -cargo-version - Show version information +cargo-version --- Show version information ## SYNOPSIS diff --git a/src/doc/man/cargo-yank.md b/src/doc/man/cargo-yank.md index 3b9185d6a65..8ad28ef243f 100644 --- a/src/doc/man/cargo-yank.md +++ b/src/doc/man/cargo-yank.md @@ -2,7 +2,7 @@ ## NAME -cargo-yank - Remove a pushed crate from the index +cargo-yank --- Remove a pushed crate from the index ## SYNOPSIS diff --git a/src/doc/man/cargo.md b/src/doc/man/cargo.md index 9f2c622da08..2d71fc4d75c 100644 --- a/src/doc/man/cargo.md +++ b/src/doc/man/cargo.md @@ -2,7 +2,7 @@ ## NAME -cargo - The Rust package manager +cargo --- The Rust package manager ## SYNOPSIS diff --git a/src/doc/src/appendix/glossary.md b/src/doc/src/appendix/glossary.md index 9ac0561e972..143736851b5 100644 --- a/src/doc/src/appendix/glossary.md +++ b/src/doc/src/appendix/glossary.md @@ -107,7 +107,7 @@ and version which is used for specifying dependencies between packages. A package contains multiple [*targets*](#target), each of which is a [*crate*](#crate). The `Cargo.toml` file describes the type of the crates (binary or library) within the package, along with some metadata about each -one -- how each is to be built, what their direct dependencies are, etc., as +one --- how each is to be built, what their direct dependencies are, etc., as described throughout this book. The *package root* is the directory where the package's `Cargo.toml` manifest @@ -162,14 +162,14 @@ A *source* is a provider that contains [*crates*](#crate) that may be included as dependencies for a [*package*](#package). There are several kinds of sources: -- **Registry source** — See [registry](#registry). -- **Local registry source** — A set of crates stored as compressed files on +- **Registry source** --- See [registry](#registry). +- **Local registry source** --- A set of crates stored as compressed files on the filesystem. See [Local Registry Sources]. -- **Directory source** — A set of crates stored as uncompressed files on the +- **Directory source** --- A set of crates stored as uncompressed files on the filesystem. See [Directory Sources]. -- **Path source** — An individual package located on the filesystem (such as a +- **Path source** --- An individual package located on the filesystem (such as a [path dependency]) or a set of multiple packages (such as [path overrides]). -- **Git source** — Packages located in a git repository (such as a [git +- **Git source** --- Packages located in a git repository (such as a [git dependency] or [git source]). See [Source Replacement] for more information. @@ -182,21 +182,21 @@ See [package ID specification](#package). The meaning of the term *target* depends on the context: -- **Cargo Target** — Cargo [*packages*](#package) consist of *targets* which +- **Cargo Target** --- Cargo [*packages*](#package) consist of *targets* which correspond to [*artifacts*](#artifact) that will be produced. Packages can have library, binary, example, test, and benchmark targets. The [list of targets][targets] are configured in the `Cargo.toml` [*manifest*](#manifest), often inferred automatically by the [directory layout] of the source files. -- **Target Directory** — Cargo places all built artifacts and intermediate +- **Target Directory** --- Cargo places all built artifacts and intermediate files in the *target* directory. By default this is a directory named `target` at the [*workspace*](#workspace) root, or the package root if not using a workspace. The directory may be changed with the `--target-dir` command-line option, the `CARGO_TARGET_DIR` [environment variable], or the `build.target-dir` [config option]. -- **Target Architecture** — The OS and machine architecture for the built +- **Target Architecture** --- The OS and machine architecture for the built artifacts are typically referred to as a *target*. -- **Target Triple** — A triple is a specific format for specifying a target +- **Target Triple** --- A triple is a specific format for specifying a target architecture. Triples may be referred to as a *target triple* which is the architecture for the artifact produced, and the *host triple* which is the architecture that the compiler is running on. The target triple can be @@ -221,11 +221,11 @@ The meaning of the term *target* depends on the context: Cargo *test targets* generate binaries which help verify proper operation and correctness of code. There are two types of test artifacts: -* **Unit test** — A *unit test* is an executable binary compiled directly from +* **Unit test** --- A *unit test* is an executable binary compiled directly from a library or a binary target. It contains the entire contents of the library or binary code, and runs `#[test]` annotated functions, intended to verify individual units of code. -* **Integration test target** — An [*integration test +* **Integration test target** --- An [*integration test target*][integration-tests] is an executable binary compiled from a *test target* which is a distinct [*crate*](#crate) whose source is located in the `tests` directory or specified by the [`[[test]]` table][targets] in the diff --git a/src/doc/src/index.md b/src/doc/src/index.md index 7085149295a..223600c8b3d 100644 --- a/src/doc/src/index.md +++ b/src/doc/src/index.md @@ -35,9 +35,9 @@ The commands will let you interact with Cargo using its command-line interface. * [Git Authentication](appendix/git-authentication.md) **Other Documentation:** -* [Changelog](https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md) — - Detailed notes about changes in Cargo in each release. -* [Rust documentation website](https://doc.rust-lang.org/) — Links to official +* [Changelog](https://github.com/rust-lang/cargo/blob/master/CHANGELOG.md) + --- Detailed notes about changes in Cargo in each release. +* [Rust documentation website](https://doc.rust-lang.org/) --- Links to official Rust documentation and tools. [def-crate]: ./appendix/glossary.md#crate '"crate" (glossary entry)' diff --git a/src/doc/src/reference/build-script-examples.md b/src/doc/src/reference/build-script-examples.md index bf49aeb1b74..5e8fae5bbd8 100644 --- a/src/doc/src/reference/build-script-examples.md +++ b/src/doc/src/reference/build-script-examples.md @@ -7,15 +7,15 @@ Check out the [`build-dependencies` keyword](https://crates.io/keywords/build-dependencies) to see what is available. The following is a sample of some popular crates[^†]: -* [`bindgen`](https://crates.io/crates/bindgen) — Automatically generate Rust +* [`bindgen`](https://crates.io/crates/bindgen) --- Automatically generate Rust FFI bindings to C libraries. -* [`cc`](https://crates.io/crates/cc) — Compiles C/C++/assembly. -* [`pkg-config`](https://crates.io/crates/pkg-config) — Detect system +* [`cc`](https://crates.io/crates/cc) --- Compiles C/C++/assembly. +* [`pkg-config`](https://crates.io/crates/pkg-config) --- Detect system libraries using the `pkg-config` utility. -* [`cmake`](https://crates.io/crates/cmake) — Runs the `cmake` build tool to build a native library. +* [`cmake`](https://crates.io/crates/cmake) --- Runs the `cmake` build tool to build a native library. * [`autocfg`](https://crates.io/crates/autocfg), [`rustc_version`](https://crates.io/crates/rustc_version), - [`version_check`](https://crates.io/crates/version_check) — These crates + [`version_check`](https://crates.io/crates/version_check) --- These crates provide ways to implement conditional compilation based on the current `rustc` such as the version of the compiler. diff --git a/src/doc/src/reference/build-scripts.md b/src/doc/src/reference/build-scripts.md index 0385ec5cb50..00023b6c2bb 100644 --- a/src/doc/src/reference/build-scripts.md +++ b/src/doc/src/reference/build-scripts.md @@ -99,36 +99,36 @@ configuration). The stderr output is also saved in that same directory. The following is a summary of the instructions that Cargo recognizes, with each one detailed below. -* [`cargo:rerun-if-changed=PATH`](#rerun-if-changed) — Tells Cargo when to +* [`cargo:rerun-if-changed=PATH`](#rerun-if-changed) --- Tells Cargo when to re-run the script. -* [`cargo:rerun-if-env-changed=VAR`](#rerun-if-env-changed) — Tells Cargo when +* [`cargo:rerun-if-env-changed=VAR`](#rerun-if-env-changed) --- Tells Cargo when to re-run the script. -* [`cargo:rustc-link-arg=FLAG`](#rustc-link-arg) — Passes custom flags to a +* [`cargo:rustc-link-arg=FLAG`](#rustc-link-arg) --- Passes custom flags to a linker for benchmarks, binaries, `cdylib` crates, examples, and tests. -* [`cargo:rustc-link-arg-bin=BIN=FLAG`](#rustc-link-arg-bin) — Passes custom +* [`cargo:rustc-link-arg-bin=BIN=FLAG`](#rustc-link-arg-bin) --- Passes custom flags to a linker for the binary `BIN`. -* [`cargo:rustc-link-arg-bins=FLAG`](#rustc-link-arg-bins) — Passes custom +* [`cargo:rustc-link-arg-bins=FLAG`](#rustc-link-arg-bins) --- Passes custom flags to a linker for binaries. -* [`cargo:rustc-link-arg-tests=FLAG`](#rustc-link-arg-tests) — Passes custom +* [`cargo:rustc-link-arg-tests=FLAG`](#rustc-link-arg-tests) --- Passes custom flags to a linker for tests. -* [`cargo:rustc-link-arg-examples=FLAG`](#rustc-link-arg-examples) — Passes custom +* [`cargo:rustc-link-arg-examples=FLAG`](#rustc-link-arg-examples) --- Passes custom flags to a linker for examples. -* [`cargo:rustc-link-arg-benches=FLAG`](#rustc-link-arg-benches) — Passes custom +* [`cargo:rustc-link-arg-benches=FLAG`](#rustc-link-arg-benches) --- Passes custom flags to a linker for benchmarks. -* [`cargo:rustc-link-lib=LIB`](#rustc-link-lib) — Adds a library to +* [`cargo:rustc-link-lib=LIB`](#rustc-link-lib) --- Adds a library to link. -* [`cargo:rustc-link-search=[KIND=]PATH`](#rustc-link-search) — Adds to the +* [`cargo:rustc-link-search=[KIND=]PATH`](#rustc-link-search) --- Adds to the library search path. -* [`cargo:rustc-flags=FLAGS`](#rustc-flags) — Passes certain flags to the +* [`cargo:rustc-flags=FLAGS`](#rustc-flags) --- Passes certain flags to the compiler. -* [`cargo:rustc-cfg=KEY[="VALUE"]`](#rustc-cfg) — Enables compile-time `cfg` +* [`cargo:rustc-cfg=KEY[="VALUE"]`](#rustc-cfg) --- Enables compile-time `cfg` settings. -* [`cargo:rustc-env=VAR=VALUE`](#rustc-env) — Sets an environment variable. -* [`cargo:rustc-cdylib-link-arg=FLAG`](#rustc-cdylib-link-arg) — Passes custom +* [`cargo:rustc-env=VAR=VALUE`](#rustc-env) --- Sets an environment variable. +* [`cargo:rustc-cdylib-link-arg=FLAG`](#rustc-cdylib-link-arg) --- Passes custom flags to a linker for cdylib crates. -* [`cargo:warning=MESSAGE`](#cargo-warning) — Displays a warning on the +* [`cargo:warning=MESSAGE`](#cargo-warning) --- Displays a warning on the terminal. -* [`cargo:KEY=VALUE`](#the-links-manifest-key) — Metadata, used by `links` +* [`cargo:KEY=VALUE`](#the-links-manifest-key) --- Metadata, used by `links` scripts. diff --git a/src/doc/src/reference/environment-variables.md b/src/doc/src/reference/environment-variables.md index f8110a0cfaa..2ed986fb5d2 100644 --- a/src/doc/src/reference/environment-variables.md +++ b/src/doc/src/reference/environment-variables.md @@ -9,73 +9,73 @@ with them: You can override these environment variables to change Cargo's behavior on your system: -* `CARGO_LOG` - Cargo uses the [`env_logger`] crate to display debug log messages. +* `CARGO_LOG` --- Cargo uses the [`env_logger`] crate to display debug log messages. The `CARGO_LOG` environment variable can be set to enable debug logging, with a value such as `trace`, `debug`, or `warn`. Usually it is only used during debugging. For more details refer to the [Debug logging]. -* `CARGO_HOME` — Cargo maintains a local cache of the registry index and of +* `CARGO_HOME` --- Cargo maintains a local cache of the registry index and of git checkouts of crates. By default these are stored under `$HOME/.cargo` (`%USERPROFILE%\.cargo` on Windows), but this variable overrides the location of this directory. Once a crate is cached it is not removed by the clean command. For more details refer to the [guide](../guide/cargo-home.md). -* `CARGO_TARGET_DIR` — Location of where to place all generated artifacts, +* `CARGO_TARGET_DIR` --- Location of where to place all generated artifacts, relative to the current working directory. See [`build.target-dir`] to set via config. -* `CARGO` - If set, Cargo will forward this value instead of setting it +* `CARGO` --- If set, Cargo will forward this value instead of setting it to its own auto-detected path when it builds crates and when it executes build scripts and external subcommands. This value is not directly executed by Cargo, and should always point at a command that behaves exactly like `cargo`, as that's what users of the variable will be expecting. -* `RUSTC` — Instead of running `rustc`, Cargo will execute this specified +* `RUSTC` --- Instead of running `rustc`, Cargo will execute this specified compiler instead. See [`build.rustc`] to set via config. -* `RUSTC_WRAPPER` — Instead of simply running `rustc`, Cargo will execute this +* `RUSTC_WRAPPER` --- Instead of simply running `rustc`, Cargo will execute this specified wrapper, passing as its command-line arguments the rustc invocation, with the first argument being the path to the actual rustc. Useful to set up a build cache tool such as `sccache`. See [`build.rustc-wrapper`] to set via config. Setting this to the empty string overwrites the config and resets cargo to not use a wrapper. -* `RUSTC_WORKSPACE_WRAPPER` — Instead of simply running `rustc`, for workspace +* `RUSTC_WORKSPACE_WRAPPER` --- Instead of simply running `rustc`, for workspace members Cargo will execute this specified wrapper, passing as its command-line arguments the rustc invocation, with the first argument being the path to the actual rustc. It affects the filename hash so that artifacts produced by the wrapper are cached separately. See [`build.rustc-workspace-wrapper`] to set via config. Setting this to the empty string overwrites the config and resets cargo to not use a wrapper for workspace members. -* `RUSTDOC` — Instead of running `rustdoc`, Cargo will execute this specified +* `RUSTDOC` --- Instead of running `rustdoc`, Cargo will execute this specified `rustdoc` instance instead. See [`build.rustdoc`] to set via config. -* `RUSTDOCFLAGS` — A space-separated list of custom flags to pass to all `rustdoc` +* `RUSTDOCFLAGS` --- A space-separated list of custom flags to pass to all `rustdoc` invocations that Cargo performs. In contrast with [`cargo rustdoc`], this is useful for passing a flag to *all* `rustdoc` instances. See [`build.rustdocflags`] for some more ways to set flags. This string is split by whitespace; for a more robust encoding of multiple arguments, see `CARGO_ENCODED_RUSTDOCFLAGS`. -* `CARGO_ENCODED_RUSTDOCFLAGS` - A list of custom flags separated by `0x1f` +* `CARGO_ENCODED_RUSTDOCFLAGS` --- A list of custom flags separated by `0x1f` (ASCII Unit Separator) to pass to all `rustdoc` invocations that Cargo performs. -* `RUSTFLAGS` — A space-separated list of custom flags to pass to all compiler +* `RUSTFLAGS` --- A space-separated list of custom flags to pass to all compiler invocations that Cargo performs. In contrast with [`cargo rustc`], this is useful for passing a flag to *all* compiler instances. See [`build.rustflags`] for some more ways to set flags. This string is split by whitespace; for a more robust encoding of multiple arguments, see `CARGO_ENCODED_RUSTFLAGS`. -* `CARGO_ENCODED_RUSTFLAGS` - A list of custom flags separated by `0x1f` +* `CARGO_ENCODED_RUSTFLAGS` --- A list of custom flags separated by `0x1f` (ASCII Unit Separator) to pass to all compiler invocations that Cargo performs. -* `CARGO_INCREMENTAL` — If this is set to 1 then Cargo will force [incremental +* `CARGO_INCREMENTAL` --- If this is set to 1 then Cargo will force [incremental compilation] to be enabled for the current compilation, and when set to 0 it will force disabling it. If this env var isn't present then cargo's defaults will otherwise be used. See also [`build.incremental`] config value. -* `CARGO_CACHE_RUSTC_INFO` — If this is set to 0 then Cargo will not try to cache +* `CARGO_CACHE_RUSTC_INFO` --- If this is set to 0 then Cargo will not try to cache compiler version information. -* `HTTPS_PROXY` or `https_proxy` or `http_proxy` — The HTTP proxy to use, see +* `HTTPS_PROXY` or `https_proxy` or `http_proxy` --- The HTTP proxy to use, see [`http.proxy`] for more detail. -* `HTTP_TIMEOUT` — The HTTP timeout in seconds, see [`http.timeout`] for more +* `HTTP_TIMEOUT` --- The HTTP timeout in seconds, see [`http.timeout`] for more detail. -* `TERM` — If this is set to `dumb`, it disables the progress bar. -* `BROWSER` — The web browser to execute to open documentation with [`cargo +* `TERM` --- If this is set to `dumb`, it disables the progress bar. +* `BROWSER` --- The web browser to execute to open documentation with [`cargo doc`]'s' `--open` flag, see [`doc.browser`] for more details. -* `RUSTFMT` — Instead of running `rustfmt`, +* `RUSTFMT` --- Instead of running `rustfmt`, [`cargo fmt`](https://github.com/rust-lang/rustfmt) will execute this specified `rustfmt` instance instead. @@ -85,56 +85,56 @@ Cargo reads environment variables for some configuration values. See the [configuration chapter][config-env] for more details. In summary, the supported environment variables are: -* `CARGO_ALIAS_` — Command aliases, see [`alias`]. -* `CARGO_BUILD_JOBS` — Number of parallel jobs, see [`build.jobs`]. -* `CARGO_BUILD_RUSTC` — The `rustc` executable, see [`build.rustc`]. -* `CARGO_BUILD_RUSTC_WRAPPER` — The `rustc` wrapper, see [`build.rustc-wrapper`]. -* `CARGO_BUILD_RUSTC_WORKSPACE_WRAPPER` — The `rustc` wrapper for workspace members only, see [`build.rustc-workspace-wrapper`]. -* `CARGO_BUILD_RUSTDOC` — The `rustdoc` executable, see [`build.rustdoc`]. -* `CARGO_BUILD_TARGET` — The default target platform, see [`build.target`]. -* `CARGO_BUILD_TARGET_DIR` — The default output directory, see [`build.target-dir`]. -* `CARGO_BUILD_RUSTFLAGS` — Extra `rustc` flags, see [`build.rustflags`]. -* `CARGO_BUILD_RUSTDOCFLAGS` — Extra `rustdoc` flags, see [`build.rustdocflags`]. -* `CARGO_BUILD_INCREMENTAL` — Incremental compilation, see [`build.incremental`]. -* `CARGO_BUILD_DEP_INFO_BASEDIR` — Dep-info relative directory, see [`build.dep-info-basedir`]. -* `CARGO_CARGO_NEW_VCS` — The default source control system with [`cargo new`], see [`cargo-new.vcs`]. -* `CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY` - How often we should generate a future incompat report notification, see [`future-incompat-report.frequency`]. -* `CARGO_HTTP_DEBUG` — Enables HTTP debugging, see [`http.debug`]. -* `CARGO_HTTP_PROXY` — Enables HTTP proxy, see [`http.proxy`]. -* `CARGO_HTTP_TIMEOUT` — The HTTP timeout, see [`http.timeout`]. -* `CARGO_HTTP_CAINFO` — The TLS certificate Certificate Authority file, see [`http.cainfo`]. -* `CARGO_HTTP_CHECK_REVOKE` — Disables TLS certificate revocation checks, see [`http.check-revoke`]. -* `CARGO_HTTP_SSL_VERSION` — The TLS version to use, see [`http.ssl-version`]. -* `CARGO_HTTP_LOW_SPEED_LIMIT` — The HTTP low-speed limit, see [`http.low-speed-limit`]. -* `CARGO_HTTP_MULTIPLEXING` — Whether HTTP/2 multiplexing is used, see [`http.multiplexing`]. -* `CARGO_HTTP_USER_AGENT` — The HTTP user-agent header, see [`http.user-agent`]. -* `CARGO_INSTALL_ROOT` — The default directory for [`cargo install`], see [`install.root`]. -* `CARGO_NET_RETRY` — Number of times to retry network errors, see [`net.retry`]. -* `CARGO_NET_GIT_FETCH_WITH_CLI` — Enables the use of the `git` executable to fetch, see [`net.git-fetch-with-cli`]. -* `CARGO_NET_OFFLINE` — Offline mode, see [`net.offline`]. -* `CARGO_PROFILE__BUILD_OVERRIDE_` — Override build script profile, see [`profile..build-override`]. -* `CARGO_PROFILE__CODEGEN_UNITS` — Set code generation units, see [`profile..codegen-units`]. -* `CARGO_PROFILE__DEBUG` — What kind of debug info to include, see [`profile..debug`]. -* `CARGO_PROFILE__DEBUG_ASSERTIONS` — Enable/disable debug assertions, see [`profile..debug-assertions`]. -* `CARGO_PROFILE__INCREMENTAL` — Enable/disable incremental compilation, see [`profile..incremental`]. -* `CARGO_PROFILE__LTO` — Link-time optimization, see [`profile..lto`]. -* `CARGO_PROFILE__OVERFLOW_CHECKS` — Enable/disable overflow checks, see [`profile..overflow-checks`]. -* `CARGO_PROFILE__OPT_LEVEL` — Set the optimization level, see [`profile..opt-level`]. -* `CARGO_PROFILE__PANIC` — The panic strategy to use, see [`profile..panic`]. -* `CARGO_PROFILE__RPATH` — The rpath linking option, see [`profile..rpath`]. -* `CARGO_PROFILE__SPLIT_DEBUGINFO` — Controls debug file output behavior, see [`profile..split-debuginfo`]. -* `CARGO_REGISTRIES__INDEX` — URL of a registry index, see [`registries..index`]. -* `CARGO_REGISTRIES__TOKEN` — Authentication token of a registry, see [`registries..token`]. -* `CARGO_REGISTRY_DEFAULT` — Default registry for the `--registry` flag, see [`registry.default`]. -* `CARGO_REGISTRY_TOKEN` — Authentication token for [crates.io], see [`registry.token`]. -* `CARGO_TARGET__LINKER` — The linker to use, see [`target..linker`]. The triple must be [converted to uppercase and underscores](config.md#environment-variables). -* `CARGO_TARGET__RUNNER` — The executable runner, see [`target..runner`]. -* `CARGO_TARGET__RUSTFLAGS` — Extra `rustc` flags for a target, see [`target..rustflags`]. -* `CARGO_TERM_QUIET` — Quiet mode, see [`term.quiet`]. -* `CARGO_TERM_VERBOSE` — The default terminal verbosity, see [`term.verbose`]. -* `CARGO_TERM_COLOR` — The default color mode, see [`term.color`]. -* `CARGO_TERM_PROGRESS_WHEN` — The default progress bar showing mode, see [`term.progress.when`]. -* `CARGO_TERM_PROGRESS_WIDTH` — The default progress bar width, see [`term.progress.width`]. +* `CARGO_ALIAS_` --- Command aliases, see [`alias`]. +* `CARGO_BUILD_JOBS` --- Number of parallel jobs, see [`build.jobs`]. +* `CARGO_BUILD_RUSTC` --- The `rustc` executable, see [`build.rustc`]. +* `CARGO_BUILD_RUSTC_WRAPPER` --- The `rustc` wrapper, see [`build.rustc-wrapper`]. +* `CARGO_BUILD_RUSTC_WORKSPACE_WRAPPER` --- The `rustc` wrapper for workspace members only, see [`build.rustc-workspace-wrapper`]. +* `CARGO_BUILD_RUSTDOC` --- The `rustdoc` executable, see [`build.rustdoc`]. +* `CARGO_BUILD_TARGET` --- The default target platform, see [`build.target`]. +* `CARGO_BUILD_TARGET_DIR` --- The default output directory, see [`build.target-dir`]. +* `CARGO_BUILD_RUSTFLAGS` --- Extra `rustc` flags, see [`build.rustflags`]. +* `CARGO_BUILD_RUSTDOCFLAGS` --- Extra `rustdoc` flags, see [`build.rustdocflags`]. +* `CARGO_BUILD_INCREMENTAL` --- Incremental compilation, see [`build.incremental`]. +* `CARGO_BUILD_DEP_INFO_BASEDIR` --- Dep-info relative directory, see [`build.dep-info-basedir`]. +* `CARGO_CARGO_NEW_VCS` --- The default source control system with [`cargo new`], see [`cargo-new.vcs`]. +* `CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY` --- How often we should generate a future incompat report notification, see [`future-incompat-report.frequency`]. +* `CARGO_HTTP_DEBUG` --- Enables HTTP debugging, see [`http.debug`]. +* `CARGO_HTTP_PROXY` --- Enables HTTP proxy, see [`http.proxy`]. +* `CARGO_HTTP_TIMEOUT` --- The HTTP timeout, see [`http.timeout`]. +* `CARGO_HTTP_CAINFO` --- The TLS certificate Certificate Authority file, see [`http.cainfo`]. +* `CARGO_HTTP_CHECK_REVOKE` --- Disables TLS certificate revocation checks, see [`http.check-revoke`]. +* `CARGO_HTTP_SSL_VERSION` --- The TLS version to use, see [`http.ssl-version`]. +* `CARGO_HTTP_LOW_SPEED_LIMIT` --- The HTTP low-speed limit, see [`http.low-speed-limit`]. +* `CARGO_HTTP_MULTIPLEXING` --- Whether HTTP/2 multiplexing is used, see [`http.multiplexing`]. +* `CARGO_HTTP_USER_AGENT` --- The HTTP user-agent header, see [`http.user-agent`]. +* `CARGO_INSTALL_ROOT` --- The default directory for [`cargo install`], see [`install.root`]. +* `CARGO_NET_RETRY` --- Number of times to retry network errors, see [`net.retry`]. +* `CARGO_NET_GIT_FETCH_WITH_CLI` --- Enables the use of the `git` executable to fetch, see [`net.git-fetch-with-cli`]. +* `CARGO_NET_OFFLINE` --- Offline mode, see [`net.offline`]. +* `CARGO_PROFILE__BUILD_OVERRIDE_` --- Override build script profile, see [`profile..build-override`]. +* `CARGO_PROFILE__CODEGEN_UNITS` --- Set code generation units, see [`profile..codegen-units`]. +* `CARGO_PROFILE__DEBUG` --- What kind of debug info to include, see [`profile..debug`]. +* `CARGO_PROFILE__DEBUG_ASSERTIONS` --- Enable/disable debug assertions, see [`profile..debug-assertions`]. +* `CARGO_PROFILE__INCREMENTAL` --- Enable/disable incremental compilation, see [`profile..incremental`]. +* `CARGO_PROFILE__LTO` --- Link-time optimization, see [`profile..lto`]. +* `CARGO_PROFILE__OVERFLOW_CHECKS` --- Enable/disable overflow checks, see [`profile..overflow-checks`]. +* `CARGO_PROFILE__OPT_LEVEL` --- Set the optimization level, see [`profile..opt-level`]. +* `CARGO_PROFILE__PANIC` --- The panic strategy to use, see [`profile..panic`]. +* `CARGO_PROFILE__RPATH` --- The rpath linking option, see [`profile..rpath`]. +* `CARGO_PROFILE__SPLIT_DEBUGINFO` --- Controls debug file output behavior, see [`profile..split-debuginfo`]. +* `CARGO_REGISTRIES__INDEX` --- URL of a registry index, see [`registries..index`]. +* `CARGO_REGISTRIES__TOKEN` --- Authentication token of a registry, see [`registries..token`]. +* `CARGO_REGISTRY_DEFAULT` --- Default registry for the `--registry` flag, see [`registry.default`]. +* `CARGO_REGISTRY_TOKEN` --- Authentication token for [crates.io], see [`registry.token`]. +* `CARGO_TARGET__LINKER` --- The linker to use, see [`target..linker`]. The triple must be [converted to uppercase and underscores](config.md#environment-variables). +* `CARGO_TARGET__RUNNER` --- The executable runner, see [`target..runner`]. +* `CARGO_TARGET__RUSTFLAGS` --- Extra `rustc` flags for a target, see [`target..rustflags`]. +* `CARGO_TERM_QUIET` --- Quiet mode, see [`term.quiet`]. +* `CARGO_TERM_VERBOSE` --- The default terminal verbosity, see [`term.verbose`]. +* `CARGO_TERM_COLOR` --- The default color mode, see [`term.color`]. +* `CARGO_TERM_PROGRESS_WHEN` --- The default progress bar showing mode, see [`term.progress.when`]. +* `CARGO_TERM_PROGRESS_WIDTH` --- The default progress bar width, see [`term.progress.width`]. [`cargo doc`]: ../commands/cargo-doc.md [`cargo install`]: ../commands/cargo-install.md @@ -214,44 +214,44 @@ let version = env!("CARGO_PKG_VERSION"); Note that if one of these values is not provided in the manifest, the corresponding environment variable is set to the empty string, `""`. -* `CARGO` — Path to the `cargo` binary performing the build. -* `CARGO_MANIFEST_DIR` — The directory containing the manifest of your package. -* `CARGO_PKG_VERSION` — The full version of your package. -* `CARGO_PKG_VERSION_MAJOR` — The major version of your package. -* `CARGO_PKG_VERSION_MINOR` — The minor version of your package. -* `CARGO_PKG_VERSION_PATCH` — The patch version of your package. -* `CARGO_PKG_VERSION_PRE` — The pre-release version of your package. -* `CARGO_PKG_AUTHORS` — Colon separated list of authors from the manifest of your package. -* `CARGO_PKG_NAME` — The name of your package. -* `CARGO_PKG_DESCRIPTION` — The description from the manifest of your package. -* `CARGO_PKG_HOMEPAGE` — The home page from the manifest of your package. -* `CARGO_PKG_REPOSITORY` — The repository from the manifest of your package. -* `CARGO_PKG_LICENSE` — The license from the manifest of your package. -* `CARGO_PKG_LICENSE_FILE` — The license file from the manifest of your package. -* `CARGO_PKG_RUST_VERSION` — The Rust version from the manifest of your package. +* `CARGO` --- Path to the `cargo` binary performing the build. +* `CARGO_MANIFEST_DIR` --- The directory containing the manifest of your package. +* `CARGO_PKG_VERSION` --- The full version of your package. +* `CARGO_PKG_VERSION_MAJOR` --- The major version of your package. +* `CARGO_PKG_VERSION_MINOR` --- The minor version of your package. +* `CARGO_PKG_VERSION_PATCH` --- The patch version of your package. +* `CARGO_PKG_VERSION_PRE` --- The pre-release version of your package. +* `CARGO_PKG_AUTHORS` --- Colon separated list of authors from the manifest of your package. +* `CARGO_PKG_NAME` --- The name of your package. +* `CARGO_PKG_DESCRIPTION` --- The description from the manifest of your package. +* `CARGO_PKG_HOMEPAGE` --- The home page from the manifest of your package. +* `CARGO_PKG_REPOSITORY` --- The repository from the manifest of your package. +* `CARGO_PKG_LICENSE` --- The license from the manifest of your package. +* `CARGO_PKG_LICENSE_FILE` --- The license file from the manifest of your package. +* `CARGO_PKG_RUST_VERSION` --- The Rust version from the manifest of your package. Note that this is the minimum Rust version supported by the package, not the current Rust version. -* `CARGO_CRATE_NAME` — The name of the crate that is currently being compiled. It is the name of the [Cargo target] with `-` converted to `_`, such as the name of the library, binary, example, integration test, or benchmark. -* `CARGO_BIN_NAME` — The name of the binary that is currently being compiled. +* `CARGO_CRATE_NAME` --- The name of the crate that is currently being compiled. It is the name of the [Cargo target] with `-` converted to `_`, such as the name of the library, binary, example, integration test, or benchmark. +* `CARGO_BIN_NAME` --- The name of the binary that is currently being compiled. Only set for [binaries] or binary [examples]. This name does not include any file extension, such as `.exe`. -* `OUT_DIR` — If the package has a build script, this is set to the folder where the build +* `OUT_DIR` --- If the package has a build script, this is set to the folder where the build script should place its output. See below for more information. (Only set during compilation.) -* `CARGO_BIN_EXE_` — The absolute path to a binary target's executable. +* `CARGO_BIN_EXE_` --- The absolute path to a binary target's executable. This is only set when building an [integration test] or benchmark. This may be used with the [`env` macro] to find the executable to run for testing purposes. The `` is the name of the binary target, exactly as-is. For example, `CARGO_BIN_EXE_my-program` for a binary named `my-program`. Binaries are automatically built when the test is built, unless the binary has required features that are not enabled. -* `CARGO_PRIMARY_PACKAGE` — This environment variable will be set if the +* `CARGO_PRIMARY_PACKAGE` --- This environment variable will be set if the package being built is primary. Primary packages are the ones the user selected on the command-line, either with `-p` flags or the defaults based on the current directory and the default workspace members. This environment variable will not be set when building dependencies. This is only set when compiling the package (not when running binaries or tests). -* `CARGO_TARGET_TMPDIR` — Only set when building [integration test] or benchmark code. +* `CARGO_TARGET_TMPDIR` --- Only set when building [integration test] or benchmark code. This is a path to a directory inside the target directory where integration tests or benchmarks are free to put any data needed by the tests/benches. Cargo initially creates this directory but doesn't @@ -303,14 +303,14 @@ let out_dir = env::var("OUT_DIR").unwrap(); `out_dir` will now contain the value of `OUT_DIR`. -* `CARGO` — Path to the `cargo` binary performing the build. -* `CARGO_MANIFEST_DIR` — The directory containing the manifest for the package +* `CARGO` --- Path to the `cargo` binary performing the build. +* `CARGO_MANIFEST_DIR` --- The directory containing the manifest for the package being built (the package containing the build script). Also note that this is the value of the current working directory of the build script when it starts. -* `CARGO_MANIFEST_LINKS` — the manifest `links` value. -* `CARGO_MAKEFLAGS` — Contains parameters needed for Cargo's [jobserver] +* `CARGO_MANIFEST_LINKS` --- the manifest `links` value. +* `CARGO_MAKEFLAGS` --- Contains parameters needed for Cargo's [jobserver] implementation to parallelize subprocesses. Rustc or cargo invocations from build.rs can already read `CARGO_MAKEFLAGS`, but GNU Make requires the @@ -319,11 +319,11 @@ let out_dir = env::var("OUT_DIR").unwrap(); Currently Cargo doesn't set the `MAKEFLAGS` variable, but it's free for build scripts invoking GNU Make to set it to the contents of `CARGO_MAKEFLAGS`. -* `CARGO_FEATURE_` — For each activated feature of the package being +* `CARGO_FEATURE_` --- For each activated feature of the package being built, this environment variable will be present where `` is the name of the feature uppercased and having `-` translated to `_`. -* `CARGO_CFG_` — For each [configuration option][configuration] of the +* `CARGO_CFG_` --- For each [configuration option][configuration] of the package being built, this environment variable will contain the value of the configuration, where `` is the name of the configuration uppercased and having `-` translated to `_`. Boolean configurations are present if they are @@ -332,24 +332,24 @@ let out_dir = env::var("OUT_DIR").unwrap(); values built-in to the compiler (which can be seen with `rustc --print=cfg`) and values set by build scripts and extra flags passed to `rustc` (such as those defined in `RUSTFLAGS`). Some examples of what these variables are: - * `CARGO_CFG_UNIX` — Set on [unix-like platforms]. - * `CARGO_CFG_WINDOWS` — Set on [windows-like platforms]. - * `CARGO_CFG_TARGET_FAMILY=unix` — The [target family]. - * `CARGO_CFG_TARGET_OS=macos` — The [target operating system]. - * `CARGO_CFG_TARGET_ARCH=x86_64` — The CPU [target architecture]. - * `CARGO_CFG_TARGET_VENDOR=apple` — The [target vendor]. - * `CARGO_CFG_TARGET_ENV=gnu` — The [target environment] ABI. - * `CARGO_CFG_TARGET_POINTER_WIDTH=64` — The CPU [pointer width]. - * `CARGO_CFG_TARGET_ENDIAN=little` — The CPU [target endianness]. - * `CARGO_CFG_TARGET_FEATURE=mmx,sse` — List of CPU [target features] enabled. -* `OUT_DIR` — the folder in which all output and intermediate artifacts should + * `CARGO_CFG_UNIX` --- Set on [unix-like platforms]. + * `CARGO_CFG_WINDOWS` --- Set on [windows-like platforms]. + * `CARGO_CFG_TARGET_FAMILY=unix` --- The [target family]. + * `CARGO_CFG_TARGET_OS=macos` --- The [target operating system]. + * `CARGO_CFG_TARGET_ARCH=x86_64` --- The CPU [target architecture]. + * `CARGO_CFG_TARGET_VENDOR=apple` --- The [target vendor]. + * `CARGO_CFG_TARGET_ENV=gnu` --- The [target environment] ABI. + * `CARGO_CFG_TARGET_POINTER_WIDTH=64` --- The CPU [pointer width]. + * `CARGO_CFG_TARGET_ENDIAN=little` --- The CPU [target endianness]. + * `CARGO_CFG_TARGET_FEATURE=mmx,sse` --- List of CPU [target features] enabled. +* `OUT_DIR` --- the folder in which all output and intermediate artifacts should be placed. This folder is inside the build directory for the package being built, and it is unique for the package in question. -* `TARGET` — the target triple that is being compiled for. Native code should be +* `TARGET` --- the target triple that is being compiled for. Native code should be compiled for this triple. See the [Target Triple] description for more information. -* `HOST` — the host triple of the Rust compiler. -* `NUM_JOBS` — the parallelism specified as the top-level parallelism. This can +* `HOST` --- the host triple of the Rust compiler. +* `NUM_JOBS` --- the parallelism specified as the top-level parallelism. This can be useful to pass a `-j` parameter to a system like `make`. Note that care should be taken when interpreting this environment variable. For historical purposes this is still provided but @@ -357,33 +357,33 @@ let out_dir = env::var("OUT_DIR").unwrap(); -j`, and instead can set the `MAKEFLAGS` env var to the content of `CARGO_MAKEFLAGS` to activate the use of Cargo's GNU Make compatible [jobserver] for sub-make invocations. -* `OPT_LEVEL`, `DEBUG` — values of the corresponding variables for the +* `OPT_LEVEL`, `DEBUG` --- values of the corresponding variables for the profile currently being built. -* `PROFILE` — `release` for release builds, `debug` for other builds. This is +* `PROFILE` --- `release` for release builds, `debug` for other builds. This is determined based on if the [profile] inherits from the [`dev`] or [`release`] profile. Using this environment variable is not recommended. Using other environment variables like `OPT_LEVEL` provide a more correct view of the actual settings being used. -* `DEP__` — For more information about this set of environment +* `DEP__` --- For more information about this set of environment variables, see build script documentation about [`links`][links]. -* `RUSTC`, `RUSTDOC` — the compiler and documentation generator that Cargo has +* `RUSTC`, `RUSTDOC` --- the compiler and documentation generator that Cargo has resolved to use, passed to the build script so it might use it as well. -* `RUSTC_WRAPPER` — the `rustc` wrapper, if any, that Cargo is using. +* `RUSTC_WRAPPER` --- the `rustc` wrapper, if any, that Cargo is using. See [`build.rustc-wrapper`]. -* `RUSTC_WORKSPACE_WRAPPER` — the `rustc` wrapper, if any, that Cargo is +* `RUSTC_WORKSPACE_WRAPPER` --- the `rustc` wrapper, if any, that Cargo is using for workspace members. See [`build.rustc-workspace-wrapper`]. -* `RUSTC_LINKER` — The path to the linker binary that Cargo has resolved to use +* `RUSTC_LINKER` --- The path to the linker binary that Cargo has resolved to use for the current target, if specified. The linker can be changed by editing `.cargo/config.toml`; see the documentation about [cargo configuration][cargo-config] for more information. -* `CARGO_ENCODED_RUSTFLAGS` — extra flags that Cargo invokes `rustc` with, +* `CARGO_ENCODED_RUSTFLAGS` --- extra flags that Cargo invokes `rustc` with, separated by a `0x1f` character (ASCII Unit Separator). See [`build.rustflags`]. Note that since Rust 1.55, `RUSTFLAGS` is removed from the environment; scripts should use `CARGO_ENCODED_RUSTFLAGS` instead. -* `CARGO_PKG_` - The package information variables, with the same names and values as are [provided during crate building][variables set for crates]. +* `CARGO_PKG_` --- The package information variables, with the same names and values as are [provided during crate building][variables set for crates]. [`env_logger`]: https://docs.rs/env_logger [debug logging]: https://doc.crates.io/contrib/architecture/console.html#debug-logging @@ -412,6 +412,6 @@ let out_dir = env::var("OUT_DIR").unwrap(); Cargo exposes this environment variable to 3rd party subcommands (ie. programs named `cargo-foobar` placed in `$PATH`): -* `CARGO` — Path to the `cargo` binary performing the build. +* `CARGO` --- Path to the `cargo` binary performing the build. For extended information about your environment you may run `cargo metadata`. diff --git a/src/doc/src/reference/features.md b/src/doc/src/reference/features.md index cc86698d590..40eb32c411d 100644 --- a/src/doc/src/reference/features.md +++ b/src/doc/src/reference/features.md @@ -518,4 +518,4 @@ source and inspect it. Because features are a form of conditional compilation, they require an exponential number of configurations and test cases to be 100% covered. By default, tests, docs, and other tooling such as [Clippy](https://github.com/rust-lang/rust-clippy) will only run with the default set of features. -We encourage you to consider your strategy and tooling in regards to different feature combinations - Every project will have different requirements in conjunction with time, resources, and the cost-benefit of covering specific scenarios. Common configurations may be with / without default features, specific combinations of features, or all combinations of features. +We encourage you to consider your strategy and tooling in regards to different feature combinations --- Every project will have different requirements in conjunction with time, resources, and the cost-benefit of covering specific scenarios. Common configurations may be with / without default features, specific combinations of features, or all combinations of features. diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index dc351a02310..954cfe674c9 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -6,52 +6,52 @@ the `cargo locate-project` section for more detail on how cargo finds the manife Every manifest file consists of the following sections: -* [`cargo-features`](unstable.md) — Unstable, nightly-only features. -* [`[package]`](#the-package-section) — Defines a package. - * [`name`](#the-name-field) — The name of the package. - * [`version`](#the-version-field) — The version of the package. - * [`authors`](#the-authors-field) — The authors of the package. - * [`edition`](#the-edition-field) — The Rust edition. - * [`rust-version`](#the-rust-version-field) — The minimal supported Rust version. - * [`description`](#the-description-field) — A description of the package. - * [`documentation`](#the-documentation-field) — URL of the package documentation. - * [`readme`](#the-readme-field) — Path to the package's README file. - * [`homepage`](#the-homepage-field) — URL of the package homepage. - * [`repository`](#the-repository-field) — URL of the package source repository. - * [`license`](#the-license-and-license-file-fields) — The package license. - * [`license-file`](#the-license-and-license-file-fields) — Path to the text of the license. - * [`keywords`](#the-keywords-field) — Keywords for the package. - * [`categories`](#the-categories-field) — Categories of the package. - * [`workspace`](#the-workspace-field) — Path to the workspace for the package. - * [`build`](#the-build-field) — Path to the package build script. - * [`links`](#the-links-field) — Name of the native library the package links with. - * [`exclude`](#the-exclude-and-include-fields) — Files to exclude when publishing. - * [`include`](#the-exclude-and-include-fields) — Files to include when publishing. - * [`publish`](#the-publish-field) — Can be used to prevent publishing the package. - * [`metadata`](#the-metadata-table) — Extra settings for external tools. - * [`default-run`](#the-default-run-field) — The default binary to run by [`cargo run`]. - * [`autobins`](cargo-targets.md#target-auto-discovery) — Disables binary auto discovery. - * [`autoexamples`](cargo-targets.md#target-auto-discovery) — Disables example auto discovery. - * [`autotests`](cargo-targets.md#target-auto-discovery) — Disables test auto discovery. - * [`autobenches`](cargo-targets.md#target-auto-discovery) — Disables bench auto discovery. - * [`resolver`](resolver.md#resolver-versions) — Sets the dependency resolver to use. +* [`cargo-features`](unstable.md) --- Unstable, nightly-only features. +* [`[package]`](#the-package-section) --- Defines a package. + * [`name`](#the-name-field) --- The name of the package. + * [`version`](#the-version-field) --- The version of the package. + * [`authors`](#the-authors-field) --- The authors of the package. + * [`edition`](#the-edition-field) --- The Rust edition. + * [`rust-version`](#the-rust-version-field) --- The minimal supported Rust version. + * [`description`](#the-description-field) --- A description of the package. + * [`documentation`](#the-documentation-field) --- URL of the package documentation. + * [`readme`](#the-readme-field) --- Path to the package's README file. + * [`homepage`](#the-homepage-field) --- URL of the package homepage. + * [`repository`](#the-repository-field) --- URL of the package source repository. + * [`license`](#the-license-and-license-file-fields) --- The package license. + * [`license-file`](#the-license-and-license-file-fields) --- Path to the text of the license. + * [`keywords`](#the-keywords-field) --- Keywords for the package. + * [`categories`](#the-categories-field) --- Categories of the package. + * [`workspace`](#the-workspace-field) --- Path to the workspace for the package. + * [`build`](#the-build-field) --- Path to the package build script. + * [`links`](#the-links-field) --- Name of the native library the package links with. + * [`exclude`](#the-exclude-and-include-fields) --- Files to exclude when publishing. + * [`include`](#the-exclude-and-include-fields) --- Files to include when publishing. + * [`publish`](#the-publish-field) --- Can be used to prevent publishing the package. + * [`metadata`](#the-metadata-table) --- Extra settings for external tools. + * [`default-run`](#the-default-run-field) --- The default binary to run by [`cargo run`]. + * [`autobins`](cargo-targets.md#target-auto-discovery) --- Disables binary auto discovery. + * [`autoexamples`](cargo-targets.md#target-auto-discovery) --- Disables example auto discovery. + * [`autotests`](cargo-targets.md#target-auto-discovery) --- Disables test auto discovery. + * [`autobenches`](cargo-targets.md#target-auto-discovery) --- Disables bench auto discovery. + * [`resolver`](resolver.md#resolver-versions) --- Sets the dependency resolver to use. * Target tables: (see [configuration](cargo-targets.md#configuring-a-target) for settings) - * [`[lib]`](cargo-targets.md#library) — Library target settings. - * [`[[bin]]`](cargo-targets.md#binaries) — Binary target settings. - * [`[[example]]`](cargo-targets.md#examples) — Example target settings. - * [`[[test]]`](cargo-targets.md#tests) — Test target settings. - * [`[[bench]]`](cargo-targets.md#benchmarks) — Benchmark target settings. + * [`[lib]`](cargo-targets.md#library) --- Library target settings. + * [`[[bin]]`](cargo-targets.md#binaries) --- Binary target settings. + * [`[[example]]`](cargo-targets.md#examples) --- Example target settings. + * [`[[test]]`](cargo-targets.md#tests) --- Test target settings. + * [`[[bench]]`](cargo-targets.md#benchmarks) --- Benchmark target settings. * Dependency tables: - * [`[dependencies]`](specifying-dependencies.md) — Package library dependencies. - * [`[dev-dependencies]`](specifying-dependencies.md#development-dependencies) — Dependencies for examples, tests, and benchmarks. - * [`[build-dependencies]`](specifying-dependencies.md#build-dependencies) — Dependencies for build scripts. - * [`[target]`](specifying-dependencies.md#platform-specific-dependencies) — Platform-specific dependencies. -* [`[badges]`](#the-badges-section) — Badges to display on a registry. -* [`[features]`](features.md) — Conditional compilation features. -* [`[patch]`](overriding-dependencies.md#the-patch-section) — Override dependencies. -* [`[replace]`](overriding-dependencies.md#the-replace-section) — Override dependencies (deprecated). -* [`[profile]`](profiles.md) — Compiler settings and optimizations. -* [`[workspace]`](workspaces.md) — The workspace definition. + * [`[dependencies]`](specifying-dependencies.md) --- Package library dependencies. + * [`[dev-dependencies]`](specifying-dependencies.md#development-dependencies) --- Dependencies for examples, tests, and benchmarks. + * [`[build-dependencies]`](specifying-dependencies.md#build-dependencies) --- Dependencies for build scripts. + * [`[target]`](specifying-dependencies.md#platform-specific-dependencies) --- Platform-specific dependencies. +* [`[badges]`](#the-badges-section) --- Badges to display on a registry. +* [`[features]`](features.md) --- Conditional compilation features. +* [`[patch]`](overriding-dependencies.md#the-patch-section) --- Override dependencies. +* [`[replace]`](overriding-dependencies.md#the-replace-section) --- Override dependencies (deprecated). +* [`[profile]`](profiles.md) --- Compiler settings and optimizations. +* [`[workspace]`](workspaces.md) --- The workspace definition. ### The `[package]` section @@ -116,7 +116,7 @@ breaking change. #### The `authors` field The optional `authors` field lists in an array the people or organizations that are considered -the "authors" of the package. The exact meaning is open to interpretation — it +the "authors" of the package. The exact meaning is open to interpretation --- it may list the original or primary authors, current maintainers, or owners of the package. An optional email address may be included within angled brackets at the end of each author entry. diff --git a/src/doc/src/reference/profiles.md b/src/doc/src/reference/profiles.md index 5cc2a6f7f57..56c8538f80b 100644 --- a/src/doc/src/reference/profiles.md +++ b/src/doc/src/reference/profiles.md @@ -431,11 +431,11 @@ opt-level = 3 The precedence for which value is used is done in the following order (first match wins): -1. `[profile.dev.package.name]` — A named package. -2. `[profile.dev.package."*"]` — For any non-workspace member. -3. `[profile.dev.build-override]` — Only for build scripts, proc macros, and +1. `[profile.dev.package.name]` --- A named package. +2. `[profile.dev.package."*"]` --- For any non-workspace member. +3. `[profile.dev.build-override]` --- Only for build scripts, proc macros, and their dependencies. -4. `[profile.dev]` — Settings in `Cargo.toml`. +4. `[profile.dev]` --- Settings in `Cargo.toml`. 5. Default values built-in to Cargo. Overrides cannot specify the `panic`, `lto`, or `rpath` settings. diff --git a/src/doc/src/reference/resolver.md b/src/doc/src/reference/resolver.md index 1e78223dd22..af02d6cf28b 100644 --- a/src/doc/src/reference/resolver.md +++ b/src/doc/src/reference/resolver.md @@ -44,7 +44,7 @@ As a quick refresher, the dependencies is: Requirement | Example | Equivalence | Description ---|--------|--|------------- +------------|---------|-------------|------------- Caret | `1.2.3` or `^1.2.3` | >=1.2.3, <2.0.0 | Any SemVer-compatible version of at least the given value. Tilde | `~1.2` | >=1.2.0, <1.3.0 | Minimum version, with restricted compatibility range. Wildcard | `1.*` | >=1.0.0, <2.0.0 | Any version in the `*` position. diff --git a/src/doc/src/reference/semver.md b/src/doc/src/reference/semver.md index 36482ff6e65..b7274c259cb 100644 --- a/src/doc/src/reference/semver.md +++ b/src/doc/src/reference/semver.md @@ -1197,9 +1197,9 @@ However, library authors should be cautious about introducing new warnings and m The following lints are examples of those that may be introduced when updating a dependency: -* [`deprecated`][deprecated-lint] — Introduced when a dependency adds the [`#[deprecated]` attribute][deprecated] to an item you are using. -* [`unused_must_use`] — Introduced when a dependency adds the [`#[must_use]` attribute][must-use-attr] to an item where you are not consuming the result. -* [`unused_unsafe`] — Introduced when a dependency *removes* the `unsafe` qualifier from a function, and that is the only unsafe function called in an unsafe block. +* [`deprecated`][deprecated-lint] --- Introduced when a dependency adds the [`#[deprecated]` attribute][deprecated] to an item you are using. +* [`unused_must_use`] --- Introduced when a dependency adds the [`#[must_use]` attribute][must-use-attr] to an item where you are not consuming the result. +* [`unused_unsafe`] --- Introduced when a dependency *removes* the `unsafe` qualifier from a function, and that is the only unsafe function called in an unsafe block. Additionally, updating `rustc` to a new version may introduce new lints. diff --git a/src/doc/src/reference/source-replacement.md b/src/doc/src/reference/source-replacement.md index 8edcd0fb90e..b8bcdc7ae2b 100644 --- a/src/doc/src/reference/source-replacement.md +++ b/src/doc/src/reference/source-replacement.md @@ -8,11 +8,11 @@ A *source* is a provider that contains crates that may be included as dependencies for a package. Cargo supports the ability to **replace one source with another** to express strategies such as: -* Vendoring - custom sources can be defined which represent crates on the local +* Vendoring --- custom sources can be defined which represent crates on the local filesystem. These sources are subsets of the source that they're replacing and can be checked into packages if necessary. -* Mirroring - sources can be replaced with an equivalent version which acts as a +* Mirroring --- sources can be replaced with an equivalent version which acts as a cache for crates.io itself. Cargo has a core assumption about source replacement that the source code is diff --git a/src/doc/src/reference/specifying-dependencies.md b/src/doc/src/reference/specifying-dependencies.md index 45b537607d3..8d9eac308b8 100644 --- a/src/doc/src/reference/specifying-dependencies.md +++ b/src/doc/src/reference/specifying-dependencies.md @@ -2,7 +2,7 @@ Your crates can depend on other libraries from [crates.io] or other registries, `git` repositories, or subdirectories on your local file system. -You can also temporarily override the location of a dependency — for example, +You can also temporarily override the location of a dependency --- for example, to be able to test out a bug fix in the dependency that you are working on locally. You can have different dependencies for different platforms, and dependencies that are only used during development. Let's take a look at how @@ -136,7 +136,7 @@ regex = { git = "https://github.com/rust-lang/regex.git" } Cargo will fetch the `git` repository at this location then look for a `Cargo.toml` for the requested crate anywhere inside the `git` repository -(not necessarily at the root - for example, specifying a member crate name +(not necessarily at the root --- for example, specifying a member crate name of a workspace and setting `git` to the repository containing the workspace). Since we haven’t specified any other information, Cargo assumes that diff --git a/src/doc/src/reference/timings.md b/src/doc/src/reference/timings.md index 459794c455b..9e6863306f4 100644 --- a/src/doc/src/reference/timings.md +++ b/src/doc/src/reference/timings.md @@ -30,11 +30,11 @@ highlighted in orange. The second graph shows Cargo's concurrency over time. The background indicates CPU usage. The three lines are: -- "Waiting" (red) — This is the number of units waiting for a CPU slot to +- "Waiting" (red) --- This is the number of units waiting for a CPU slot to open. -- "Inactive" (blue) — This is the number of units that are waiting for their +- "Inactive" (blue) --- This is the number of units that are waiting for their dependencies to finish. -- "Active" (green) — This is the number of units currently running. +- "Active" (green) --- This is the number of units currently running. Note: This does not show the concurrency in the compiler itself. `rustc` coordinates with Cargo via the "job server" to stay within the concurrency diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md index 71c839ebb98..0b21118a88e 100644 --- a/src/doc/src/reference/unstable.md +++ b/src/doc/src/reference/unstable.md @@ -60,45 +60,45 @@ Each new feature described below should explain how to use it. ### List of unstable features * Unstable-specific features - * [-Z allow-features](#allow-features) — Provides a way to restrict which unstable features are used. + * [-Z allow-features](#allow-features) --- Provides a way to restrict which unstable features are used. * Build scripts and linking - * [Metabuild](#metabuild) — Provides declarative build scripts. + * [Metabuild](#metabuild) --- Provides declarative build scripts. * Resolver and features - * [no-index-update](#no-index-update) — Prevents cargo from updating the index cache. - * [avoid-dev-deps](#avoid-dev-deps) — Prevents the resolver from including dev-dependencies during resolution. - * [minimal-versions](#minimal-versions) — Forces the resolver to use the lowest compatible version instead of the highest. - * [public-dependency](#public-dependency) — Allows dependencies to be classified as either public or private. + * [no-index-update](#no-index-update) --- Prevents cargo from updating the index cache. + * [avoid-dev-deps](#avoid-dev-deps) --- Prevents the resolver from including dev-dependencies during resolution. + * [minimal-versions](#minimal-versions) --- Forces the resolver to use the lowest compatible version instead of the highest. + * [public-dependency](#public-dependency) --- Allows dependencies to be classified as either public or private. * Output behavior - * [out-dir](#out-dir) — Adds a directory where artifacts are copied to. - * [Different binary name](#different-binary-name) — Assign a name to the built binary that is separate from the crate name. + * [out-dir](#out-dir) --- Adds a directory where artifacts are copied to. + * [Different binary name](#different-binary-name) --- Assign a name to the built binary that is separate from the crate name. * Compile behavior - * [mtime-on-use](#mtime-on-use) — Updates the last-modified timestamp on every dependency every time it is used, to provide a mechanism to delete unused artifacts. - * [doctest-xcompile](#doctest-xcompile) — Supports running doctests with the `--target` flag. - * [build-std](#build-std) — Builds the standard library instead of using pre-built binaries. - * [build-std-features](#build-std-features) — Sets features to use with the standard library. - * [binary-dep-depinfo](#binary-dep-depinfo) — Causes the dep-info file to track binary dependencies. - * [panic-abort-tests](#panic-abort-tests) — Allows running tests with the "abort" panic strategy. - * [keep-going](#keep-going) — Build as much as possible rather than aborting on the first error. + * [mtime-on-use](#mtime-on-use) --- Updates the last-modified timestamp on every dependency every time it is used, to provide a mechanism to delete unused artifacts. + * [doctest-xcompile](#doctest-xcompile) --- Supports running doctests with the `--target` flag. + * [build-std](#build-std) --- Builds the standard library instead of using pre-built binaries. + * [build-std-features](#build-std-features) --- Sets features to use with the standard library. + * [binary-dep-depinfo](#binary-dep-depinfo) --- Causes the dep-info file to track binary dependencies. + * [panic-abort-tests](#panic-abort-tests) --- Allows running tests with the "abort" panic strategy. + * [keep-going](#keep-going) --- Build as much as possible rather than aborting on the first error. * rustdoc - * [`doctest-in-workspace`](#doctest-in-workspace) — Fixes workspace-relative paths when running doctests. - * [rustdoc-map](#rustdoc-map) — Provides mappings for documentation to link to external sites like [docs.rs](https://docs.rs/). + * [`doctest-in-workspace`](#doctest-in-workspace) --- Fixes workspace-relative paths when running doctests. + * [rustdoc-map](#rustdoc-map) --- Provides mappings for documentation to link to external sites like [docs.rs](https://docs.rs/). * `Cargo.toml` extensions - * [Profile `rustflags` option](#profile-rustflags-option) — Passed directly to rustc. - * [codegen-backend](#codegen-backend) — Select the codegen backend used by rustc. - * [per-package-target](#per-package-target) — Sets the `--target` to use for each individual package. - * [artifact dependencies](#artifact-dependencies) - Allow build artifacts to be included into other build artifacts and build them for different targets. + * [Profile `rustflags` option](#profile-rustflags-option) --- Passed directly to rustc. + * [codegen-backend](#codegen-backend) --- Select the codegen backend used by rustc. + * [per-package-target](#per-package-target) --- Sets the `--target` to use for each individual package. + * [artifact dependencies](#artifact-dependencies) --- Allow build artifacts to be included into other build artifacts and build them for different targets. * Information and metadata - * [Build-plan](#build-plan) — Emits JSON information on which commands will be run. - * [unit-graph](#unit-graph) — Emits JSON for Cargo's internal graph structure. - * [`cargo rustc --print`](#rustc---print) — Calls rustc with `--print` to display information from rustc. + * [Build-plan](#build-plan) --- Emits JSON information on which commands will be run. + * [unit-graph](#unit-graph) --- Emits JSON for Cargo's internal graph structure. + * [`cargo rustc --print`](#rustc---print) --- Calls rustc with `--print` to display information from rustc. * Configuration - * [config-include](#config-include) — Adds the ability for config files to include other files. - * [`cargo config`](#cargo-config) — Adds a new subcommand for viewing config files. + * [config-include](#config-include) --- Adds the ability for config files to include other files. + * [`cargo config`](#cargo-config) --- Adds a new subcommand for viewing config files. * Registries - * [credential-process](#credential-process) — Adds support for fetching registry tokens from an external authentication program. - * [`cargo logout`](#cargo-logout) — Adds the `logout` command to remove the currently saved registry token. - * [publish-timeout](#publish-timeout) — Controls the timeout between uploading the crate and being available in the index - * [registry-auth](#registry-auth) — Adds support for authenticated registries, and generate registry authentication tokens using asymmetric cryptography. + * [credential-process](#credential-process) --- Adds support for fetching registry tokens from an external authentication program. + * [`cargo logout`](#cargo-logout) --- Adds the `logout` command to remove the currently saved registry token. + * [publish-timeout](#publish-timeout) --- Controls the timeout between uploading the crate and being available in the index + * [registry-auth](#registry-auth) --- Adds support for authenticated registries, and generate registry authentication tokens using asymmetric cryptography. ### allow-features @@ -362,9 +362,9 @@ feature for Cargo has an extremely long history and is very large in scope, and this is just the beginning. If you'd like to report bugs please either report them to: -* Cargo - - for implementation bugs -* The tracking repository - - - for larger design +* Cargo --- --- for implementation bugs +* The tracking repository --- + --- for larger design questions. Also if you'd like to see a feature that's not yet implemented and/or if @@ -620,12 +620,12 @@ The following is a description of the JSON structure: "platform": null, /* The "mode" for this unit. Valid values: - * "test" — Build using `rustc` as a test. - * "build" — Build using `rustc`. - * "check" — Build using `rustc` in "check" mode. - * "doc" — Build using `rustdoc`. - * "doctest" — Test using `rustdoc`. - * "run-custom-build" — Represents the execution of a build script. + * "test" --- Build using `rustc` as a test. + * "build" --- Build using `rustc`. + * "check" --- Build using `rustc` in "check" mode. + * "doc" --- Build using `rustdoc`. + * "doctest" --- Test using `rustdoc`. + * "run-custom-build" --- Represents the execution of a build script. */ "mode": "build", /* Array of features enabled on this unit as strings. */ @@ -926,9 +926,9 @@ array of strings. Command-line arguments allow special placeholders which will be replaced with the corresponding value: -* `{name}` — The name of the registry. -* `{api_url}` — The base URL of the registry API endpoints. -* `{action}` — The authentication action (described below). +* `{name}` --- The name of the registry. +* `{api_url}` --- The base URL of the registry API endpoints. +* `{action}` --- The authentication action (described below). Process names with the prefix `cargo:` are loaded from the `libexec` directory next to cargo. Several experimental credential wrappers are included with @@ -999,9 +999,9 @@ ensure the credential process is kept as simple as possible. Cargo will execute the process with the `{action}` argument indicating which action to perform: -* `store` — Store the given token in secure storage. -* `get` — Get a token from storage. -* `erase` — Remove a token from storage. +* `store` --- Store the given token in secure storage. +* `get` --- Get a token from storage. +* `erase` --- Remove a token from storage. The `cargo login` command uses `store` to save a token. Commands that require authentication, like `cargo publish`, uses `get` to retrieve a token. `cargo @@ -1011,18 +1011,18 @@ The process inherits the user's stderr, so the process can display messages. Some values are passed in via environment variables (see below). The expected interactions are: -* `store` — The token is sent to the process's stdin, terminated by a newline. +* `store` --- The token is sent to the process's stdin, terminated by a newline. The process should store the token keyed off the registry name. If the process fails, it should exit with a nonzero exit status. -* `get` — The process should send the token to its stdout (trailing newline +* `get` --- The process should send the token to its stdout (trailing newline will be trimmed). The process inherits the user's stdin, should it need to receive input. If the process is unable to fulfill the request, it should exit with a nonzero exit code. -* `erase` — The process should remove the token associated with the registry +* `erase` --- The process should remove the token associated with the registry name. If the token is not found, the process should exit with a 0 exit status. @@ -1030,9 +1030,9 @@ interactions are: The following environment variables will be provided to the executed command: -* `CARGO` — Path to the `cargo` binary executing the command. -* `CARGO_REGISTRY_INDEX_URL` — The URL of the registry index. -* `CARGO_REGISTRY_NAME_OPT` — Optional name of the registry. Should not be used as a storage key. Not always available. +* `CARGO` --- Path to the `cargo` binary executing the command. +* `CARGO_REGISTRY_INDEX_URL` --- The URL of the registry index. +* `CARGO_REGISTRY_NAME_OPT` --- Optional name of the registry. Should not be used as a storage key. Not always available. #### `cargo logout` diff --git a/src/doc/src/reference/workspaces.md b/src/doc/src/reference/workspaces.md index 004839eac7d..fed53eb0da9 100644 --- a/src/doc/src/reference/workspaces.md +++ b/src/doc/src/reference/workspaces.md @@ -17,17 +17,17 @@ The key points of workspaces are: In the `Cargo.toml`, the `[workspace]` table supports the following sections: -* [`[workspace]`](#the-workspace-section) — Defines a workspace. - * [`resolver`](resolver.md#resolver-versions) — Sets the dependency resolver to use. - * [`members`](#the-members-and-exclude-fields) — Packages to include in the workspace. - * [`exclude`](#the-members-and-exclude-fields) — Packages to exclude from the workspace. - * [`default-members`](#the-default-members-field) — Packages to operate on when a specific package wasn't selected. - * [`package`](#the-package-table) — Keys for inheriting in packages. - * [`dependencies`](#the-dependencies-table) — Keys for inheriting in package dependencies. - * [`metadata`](#the-metadata-table) — Extra settings for external tools. -* [`[patch]`](overriding-dependencies.md#the-patch-section) — Override dependencies. -* [`[replace]`](overriding-dependencies.md#the-replace-section) — Override dependencies (deprecated). -* [`[profile]`](profiles.md) — Compiler settings and optimizations. +* [`[workspace]`](#the-workspace-section) --- Defines a workspace. + * [`resolver`](resolver.md#resolver-versions) --- Sets the dependency resolver to use. + * [`members`](#the-members-and-exclude-fields) --- Packages to include in the workspace. + * [`exclude`](#the-members-and-exclude-fields) --- Packages to exclude from the workspace. + * [`default-members`](#the-default-members-field) --- Packages to operate on when a specific package wasn't selected. + * [`package`](#the-package-table) --- Keys for inheriting in packages. + * [`dependencies`](#the-dependencies-table) --- Keys for inheriting in package dependencies. + * [`metadata`](#the-metadata-table) --- Extra settings for external tools. +* [`[patch]`](overriding-dependencies.md#the-patch-section) --- Override dependencies. +* [`[replace]`](overriding-dependencies.md#the-replace-section) --- Override dependencies (deprecated). +* [`[profile]`](profiles.md) --- Compiler settings and optimizations. ### The `[workspace]` section From b1754b2aa27dc2d056b54550545f42cba65acf0b Mon Sep 17 00:00:00 2001 From: Enyium <123484196+Enyium@users.noreply.github.com> Date: Thu, 9 Feb 2023 23:52:43 +0100 Subject: [PATCH 5/5] Regenerate derived doc formats. --- src/doc/man/generated_txt/cargo-add.txt | 21 +++--- src/doc/man/generated_txt/cargo-bench.txt | 48 ++++++------- src/doc/man/generated_txt/cargo-build.txt | 40 +++++------ src/doc/man/generated_txt/cargo-check.txt | 42 ++++++------ src/doc/man/generated_txt/cargo-clean.txt | 13 ++-- src/doc/man/generated_txt/cargo-doc.txt | 38 ++++++----- src/doc/man/generated_txt/cargo-fetch.txt | 11 +-- src/doc/man/generated_txt/cargo-fix.txt | 52 +++++++------- .../generated_txt/cargo-generate-lockfile.txt | 11 +-- src/doc/man/generated_txt/cargo-help.txt | 2 +- src/doc/man/generated_txt/cargo-init.txt | 11 +-- src/doc/man/generated_txt/cargo-install.txt | 44 ++++++------ .../generated_txt/cargo-locate-project.txt | 16 +++-- src/doc/man/generated_txt/cargo-login.txt | 11 +-- src/doc/man/generated_txt/cargo-metadata.txt | 17 ++--- src/doc/man/generated_txt/cargo-new.txt | 11 +-- src/doc/man/generated_txt/cargo-owner.txt | 15 +++-- src/doc/man/generated_txt/cargo-package.txt | 18 ++--- src/doc/man/generated_txt/cargo-pkgid.txt | 11 +-- src/doc/man/generated_txt/cargo-publish.txt | 13 ++-- src/doc/man/generated_txt/cargo-remove.txt | 17 ++--- src/doc/man/generated_txt/cargo-report.txt | 8 +-- src/doc/man/generated_txt/cargo-run.txt | 28 ++++---- src/doc/man/generated_txt/cargo-rustc.txt | 38 ++++++----- src/doc/man/generated_txt/cargo-rustdoc.txt | 38 ++++++----- src/doc/man/generated_txt/cargo-search.txt | 13 ++-- src/doc/man/generated_txt/cargo-test.txt | 54 ++++++++------- src/doc/man/generated_txt/cargo-tree.txt | 67 ++++++++++--------- src/doc/man/generated_txt/cargo-uninstall.txt | 17 ++--- src/doc/man/generated_txt/cargo-update.txt | 21 +++--- src/doc/man/generated_txt/cargo-vendor.txt | 29 ++++---- .../generated_txt/cargo-verify-project.txt | 11 +-- src/doc/man/generated_txt/cargo-version.txt | 2 +- src/doc/man/generated_txt/cargo-yank.txt | 18 ++--- src/doc/man/generated_txt/cargo.txt | 23 ++++--- src/doc/src/commands/cargo-add.md | 6 +- src/doc/src/commands/cargo-bench.md | 32 ++++----- src/doc/src/commands/cargo-build.md | 28 ++++---- src/doc/src/commands/cargo-check.md | 28 ++++---- src/doc/src/commands/cargo-clean.md | 8 +-- src/doc/src/commands/cargo-doc.md | 24 +++---- src/doc/src/commands/cargo-fetch.md | 4 +- src/doc/src/commands/cargo-fix.md | 28 ++++---- .../src/commands/cargo-generate-lockfile.md | 4 +- src/doc/src/commands/cargo-help.md | 2 +- src/doc/src/commands/cargo-init.md | 4 +- src/doc/src/commands/cargo-install.md | 16 ++--- src/doc/src/commands/cargo-locate-project.md | 6 +- src/doc/src/commands/cargo-login.md | 4 +- src/doc/src/commands/cargo-metadata.md | 8 +-- src/doc/src/commands/cargo-new.md | 4 +- src/doc/src/commands/cargo-owner.md | 8 +-- src/doc/src/commands/cargo-package.md | 12 ++-- src/doc/src/commands/cargo-pkgid.md | 4 +- src/doc/src/commands/cargo-publish.md | 6 +- src/doc/src/commands/cargo-remove.md | 10 +-- src/doc/src/commands/cargo-report.md | 8 +-- src/doc/src/commands/cargo-run.md | 12 ++-- src/doc/src/commands/cargo-rustc.md | 22 +++--- src/doc/src/commands/cargo-rustdoc.md | 22 +++--- src/doc/src/commands/cargo-search.md | 4 +- src/doc/src/commands/cargo-test.md | 36 +++++----- src/doc/src/commands/cargo-tree.md | 24 +++---- src/doc/src/commands/cargo-uninstall.md | 8 +-- src/doc/src/commands/cargo-update.md | 14 ++-- src/doc/src/commands/cargo-vendor.md | 8 +-- src/doc/src/commands/cargo-verify-project.md | 4 +- src/doc/src/commands/cargo-version.md | 2 +- src/doc/src/commands/cargo-yank.md | 4 +- src/doc/src/commands/cargo.md | 4 +- src/etc/man/cargo-add.1 | 14 ++-- src/etc/man/cargo-bench.1 | 36 +++++----- src/etc/man/cargo-build.1 | 28 ++++---- src/etc/man/cargo-check.1 | 30 ++++----- src/etc/man/cargo-clean.1 | 8 +-- src/etc/man/cargo-doc.1 | 26 +++---- src/etc/man/cargo-fetch.1 | 4 +- src/etc/man/cargo-fix.1 | 36 +++++----- src/etc/man/cargo-generate-lockfile.1 | 4 +- src/etc/man/cargo-help.1 | 2 +- src/etc/man/cargo-init.1 | 4 +- src/etc/man/cargo-install.1 | 26 +++---- src/etc/man/cargo-locate-project.1 | 6 +- src/etc/man/cargo-login.1 | 4 +- src/etc/man/cargo-metadata.1 | 8 +-- src/etc/man/cargo-new.1 | 4 +- src/etc/man/cargo-owner.1 | 8 +-- src/etc/man/cargo-package.1 | 12 ++-- src/etc/man/cargo-pkgid.1 | 4 +- src/etc/man/cargo-publish.1 | 6 +- src/etc/man/cargo-remove.1 | 12 ++-- src/etc/man/cargo-report.1 | 8 +-- src/etc/man/cargo-run.1 | 14 ++-- src/etc/man/cargo-rustc.1 | 22 +++--- src/etc/man/cargo-rustdoc.1 | 22 +++--- src/etc/man/cargo-search.1 | 6 +- src/etc/man/cargo-test.1 | 40 +++++------ src/etc/man/cargo-tree.1 | 42 ++++++------ src/etc/man/cargo-uninstall.1 | 10 +-- src/etc/man/cargo-update.1 | 14 ++-- src/etc/man/cargo-vendor.1 | 14 ++-- src/etc/man/cargo-verify-project.1 | 4 +- src/etc/man/cargo-version.1 | 2 +- src/etc/man/cargo-yank.1 | 10 +-- src/etc/man/cargo.1 | 14 ++-- 105 files changed, 898 insertions(+), 853 deletions(-) diff --git a/src/doc/man/generated_txt/cargo-add.txt b/src/doc/man/generated_txt/cargo-add.txt index e97ef57540d..b85d9172fe8 100644 --- a/src/doc/man/generated_txt/cargo-add.txt +++ b/src/doc/man/generated_txt/cargo-add.txt @@ -1,12 +1,12 @@ CARGO-ADD(1) NAME - cargo-add - Add dependencies to a Cargo.toml manifest file + cargo-add — Add dependencies to a Cargo.toml manifest file SYNOPSIS - cargo add [options] crate... + cargo add [options] crate… cargo add [options] --path path - cargo add [options] --git url [crate...] + cargo add [options] --git url [crate…] DESCRIPTION This command can add or modify dependencies. @@ -14,7 +14,7 @@ DESCRIPTION The source for the dependency can be specified with: o crate@version: Fetch from a registry with a version constraint of - "version" + “version” o --path path: Fetch from the specified path @@ -34,7 +34,7 @@ DESCRIPTION Upon successful invocation, the enabled (+) and disabled (-) features of the specified - dependency will be listed in the command's output. + dependency will be listed in the command’s output. OPTIONS Source options @@ -80,7 +80,7 @@ OPTIONS Dependency options --dry-run - Don't actually write the manifest + Don’t actually write the manifest --rename name Rename @@ -112,10 +112,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-bench.txt b/src/doc/man/generated_txt/cargo-bench.txt index 5e833272d15..aaa495d4639 100644 --- a/src/doc/man/generated_txt/cargo-bench.txt +++ b/src/doc/man/generated_txt/cargo-bench.txt @@ -1,7 +1,7 @@ CARGO-BENCH(1) NAME - cargo-bench - Execute benchmarks of a package + cargo-bench — Execute benchmarks of a package SYNOPSIS cargo bench [options] [benchname] [-- bench-options] @@ -11,11 +11,11 @@ DESCRIPTION The benchmark filtering argument benchname and all the arguments following the two dashes (--) are passed to the benchmark binaries and - thus to libtest (rustc's built in unit-test and micro-benchmarking + thus to libtest (rustc’s built in unit-test and micro-benchmarking framework). If you are passing arguments to both Cargo and the binary, the ones after -- go to the binary, the ones before go to Cargo. For - details about libtest's arguments see the output of cargo bench -- - --help and check out the rustc book's chapter on how tests work at + details about libtest’s arguments see the output of cargo bench -- + --help and check out the rustc book’s chapter on how tests work at . As an example, this will run only the benchmark named foo (and skip @@ -52,7 +52,7 @@ DESCRIPTION OPTIONS Benchmark Options --no-run - Compile, but don't run benchmarks. + Compile, but don’t run benchmarks. --no-fail-fast Run all benchmarks regardless of failure. Without this flag, Cargo @@ -74,7 +74,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Benchmark only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -88,7 +88,7 @@ OPTIONS --all Deprecated alias for --workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -136,23 +136,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Benchmark the package's library. + Benchmark the package’s library. - --bin name... + --bin name… Benchmark the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Benchmark all binary targets. - --example name... + --example name… Benchmark the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Benchmark all example targets. - --test name... + --test name… Benchmark the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -165,7 +165,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Benchmark the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -227,7 +227,7 @@ OPTIONS --ignore-rust-version Benchmark the target even if the selected Rust compiler is older - than the required Rust version as configured in the project's + than the required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -265,10 +265,11 @@ OPTIONS cargo bench -- --nocapture -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -303,18 +304,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-build.txt b/src/doc/man/generated_txt/cargo-build.txt index aae7e94ada0..da9284c8e4c 100644 --- a/src/doc/man/generated_txt/cargo-build.txt +++ b/src/doc/man/generated_txt/cargo-build.txt @@ -1,7 +1,7 @@ CARGO-BUILD(1) NAME - cargo-build - Compile the current package + cargo-build — Compile the current package SYNOPSIS cargo build [options] @@ -24,7 +24,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Build only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -38,7 +38,7 @@ OPTIONS --all Deprecated alias for --workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -68,23 +68,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Build the package's library. + Build the package’s library. - --bin name... + --bin name… Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Build all binary targets. - --example name... + --example name… Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Build all example targets. - --test name... + --test name… Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -97,7 +97,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -163,7 +163,7 @@ OPTIONS --ignore-rust-version Build the target even if the selected Rust compiler is older than - the required Rust version as configured in the project's + the required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -204,10 +204,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -242,18 +243,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. --build-plan Outputs a series of JSON messages to stdout that indicate the diff --git a/src/doc/man/generated_txt/cargo-check.txt b/src/doc/man/generated_txt/cargo-check.txt index 069f316492b..0b8a1ca6a55 100644 --- a/src/doc/man/generated_txt/cargo-check.txt +++ b/src/doc/man/generated_txt/cargo-check.txt @@ -1,7 +1,7 @@ CARGO-CHECK(1) NAME - cargo-check - Check the current package + cargo-check — Check the current package SYNOPSIS cargo check [options] @@ -12,7 +12,7 @@ DESCRIPTION code generation, which is faster than running cargo build. The compiler will save metadata files to disk so that future runs will reuse them if the source has not been modified. Some diagnostics and errors are only - emitted during code generation, so they inherently won't be reported + emitted during code generation, so they inherently won’t be reported with cargo check. OPTIONS @@ -30,7 +30,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Check only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -44,7 +44,7 @@ OPTIONS --all Deprecated alias for --workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -65,23 +65,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Check the package's library. + Check the package’s library. - --bin name... + --bin name… Check the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Check all binary targets. - --example name... + --example name… Check the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Check all example targets. - --test name... + --test name… Check the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -94,7 +94,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Check the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -167,7 +167,7 @@ OPTIONS --ignore-rust-version Check the target even if the selected Rust compiler is older than - the required Rust version as configured in the project's + the required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -199,10 +199,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -237,18 +238,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-clean.txt b/src/doc/man/generated_txt/cargo-clean.txt index 93e4ee24ad7..c0fd956bbb7 100644 --- a/src/doc/man/generated_txt/cargo-clean.txt +++ b/src/doc/man/generated_txt/cargo-clean.txt @@ -1,7 +1,7 @@ CARGO-CLEAN(1) NAME - cargo-clean - Remove generated artifacts + cargo-clean — Remove generated artifacts SYNOPSIS cargo clean [options] @@ -17,7 +17,7 @@ OPTIONS When no packages are selected, all packages and all dependencies in the workspace are cleaned. - -p spec..., --package spec... + -p spec…, --package spec… Clean only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for the SPEC format. @@ -57,10 +57,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-doc.txt b/src/doc/man/generated_txt/cargo-doc.txt index 26ce1aa3934..b6805929262 100644 --- a/src/doc/man/generated_txt/cargo-doc.txt +++ b/src/doc/man/generated_txt/cargo-doc.txt @@ -1,14 +1,14 @@ CARGO-DOC(1) NAME - cargo-doc - Build a package's documentation + cargo-doc — Build a package’s documentation SYNOPSIS cargo doc [options] DESCRIPTION Build the documentation for the local package and all dependencies. The - output is placed in target/doc in rustdoc's usual format. + output is placed in target/doc in rustdoc’s usual format. OPTIONS Documentation Options @@ -40,7 +40,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Document only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -54,7 +54,7 @@ OPTIONS --all Deprecated alias for --workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -73,16 +73,16 @@ OPTIONS ignore the doc flag and will always document the given target. --lib - Document the package's library. + Document the package’s library. - --bin name... + --bin name… Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Document all binary targets. - --example name... + --example name… Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -138,7 +138,7 @@ OPTIONS --ignore-rust-version Document the target even if the selected Rust compiler is older than - the required Rust version as configured in the project's + the required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -170,10 +170,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -208,18 +209,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-fetch.txt b/src/doc/man/generated_txt/cargo-fetch.txt index 5cc454d0b38..ba866323407 100644 --- a/src/doc/man/generated_txt/cargo-fetch.txt +++ b/src/doc/man/generated_txt/cargo-fetch.txt @@ -1,7 +1,7 @@ CARGO-FETCH(1) NAME - cargo-fetch - Fetch dependencies of a package from the network + cargo-fetch — Fetch dependencies of a package from the network SYNOPSIS cargo fetch [options] @@ -42,10 +42,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-fix.txt b/src/doc/man/generated_txt/cargo-fix.txt index 878b6aa9b75..2b94fdbcb85 100644 --- a/src/doc/man/generated_txt/cargo-fix.txt +++ b/src/doc/man/generated_txt/cargo-fix.txt @@ -1,13 +1,13 @@ CARGO-FIX(1) NAME - cargo-fix - Automatically fix lint warnings reported by rustc + cargo-fix — Automatically fix lint warnings reported by rustc SYNOPSIS cargo fix [options] DESCRIPTION - This Cargo subcommand will automatically take rustc's suggestions from + This Cargo subcommand will automatically take rustc’s suggestions from diagnostics like warnings and apply them to your source code. This is intended to help automate tasks that rustc itself already knows how to tell you to fix! @@ -15,8 +15,8 @@ DESCRIPTION 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 apply all fixes to the - current package, you can run: + process is finished. For example if you’d like to apply all fixes to + the current package, you can run: cargo fix @@ -34,8 +34,8 @@ DESCRIPTION cargo fix --target x86_64-pc-windows-gnu If you encounter any problems with cargo fix or otherwise have any - questions or feature requests please don't hesitate to file an issue at - . + questions or feature requests please don’t hesitate to file an issue + at . Edition migration The cargo fix subcommand can also be used to migrate a package from one @@ -57,7 +57,7 @@ DESCRIPTION (without the --edition flag) to apply any suggestions given by the compiler. - And hopefully that's it! Just keep in mind of the caveats mentioned + And hopefully that’s it! Just keep in mind of the caveats mentioned above that cargo fix cannot update code for inactive features or cfg expressions. Also, in some rare cases the compiler is unable to automatically migrate all code to the new edition, and this may require @@ -103,7 +103,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Fix only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -117,7 +117,7 @@ OPTIONS --all Deprecated alias for --workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -138,23 +138,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Fix the package's library. + Fix the package’s library. - --bin name... + --bin name… Fix the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Fix all binary targets. - --example name... + --example name… Fix the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Fix all example targets. - --test name... + --test name… Fix the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -167,7 +167,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Fix the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -240,7 +240,7 @@ OPTIONS --ignore-rust-version Fix the target even if the selected Rust compiler is older than the - required Rust version as configured in the project's rust-version + required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -272,10 +272,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -310,18 +311,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-generate-lockfile.txt b/src/doc/man/generated_txt/cargo-generate-lockfile.txt index 892b3df2e3f..ef15886da95 100644 --- a/src/doc/man/generated_txt/cargo-generate-lockfile.txt +++ b/src/doc/man/generated_txt/cargo-generate-lockfile.txt @@ -1,7 +1,7 @@ CARGO-GENERATE-LOCKFILE(1) NAME - cargo-generate-lockfile - Generate the lockfile for a package + cargo-generate-lockfile — Generate the lockfile for a package SYNOPSIS cargo generate-lockfile [options] @@ -17,10 +17,11 @@ DESCRIPTION OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-help.txt b/src/doc/man/generated_txt/cargo-help.txt index ea87ddfdb48..0107ebe2c04 100644 --- a/src/doc/man/generated_txt/cargo-help.txt +++ b/src/doc/man/generated_txt/cargo-help.txt @@ -1,7 +1,7 @@ CARGO-HELP(1) NAME - cargo-help - Get help for a Cargo command + cargo-help — Get help for a Cargo command SYNOPSIS cargo help [subcommand] diff --git a/src/doc/man/generated_txt/cargo-init.txt b/src/doc/man/generated_txt/cargo-init.txt index 1071627f8d2..6d1b5ccd653 100644 --- a/src/doc/man/generated_txt/cargo-init.txt +++ b/src/doc/man/generated_txt/cargo-init.txt @@ -1,7 +1,7 @@ CARGO-INIT(1) NAME - cargo-init - Create a new Cargo package in an existing directory + cargo-init — Create a new Cargo package in an existing directory SYNOPSIS cargo init [options] [path] @@ -56,10 +56,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-install.txt b/src/doc/man/generated_txt/cargo-install.txt index 0ed871e3cbe..8d15d2cd58a 100644 --- a/src/doc/man/generated_txt/cargo-install.txt +++ b/src/doc/man/generated_txt/cargo-install.txt @@ -1,19 +1,19 @@ CARGO-INSTALL(1) NAME - cargo-install - Build and install a Rust binary + cargo-install — Build and install a Rust binary SYNOPSIS - cargo install [options] crate[@version]... + cargo install [options] crate[@version]… cargo install [options] --path path - cargo install [options] --git url [crate...] + cargo install [options] --git url [crate…] cargo install [options] --list DESCRIPTION - This command manages Cargo's local set of installed binary crates. Only - packages which have executable [[bin]] or [[example]] targets can be - installed, and all executables are installed into the installation - root's bin folder. + This command manages Cargo’s local set of installed binary crates. + Only packages which have executable [[bin]] or [[example]] targets can + be installed, and all executables are installed into the installation + root’s bin folder. The installation root is determined, in order of precedence: @@ -38,7 +38,7 @@ DESCRIPTION install via the --version flags, and similarly packages from git repositories can optionally specify the branch, tag, or revision that should be installed. If a crate has multiple binaries, the --bin - argument can selectively install only one of them, and if you'd rather + argument can selectively install only one of them, and if you’d rather install examples the --example argument can be used as well. If the package is already installed, Cargo will reinstall it if the @@ -119,17 +119,17 @@ OPTIONS metadata file stored in the installation root directory. This flag tells Cargo not to use or create that file. With this flag, Cargo will refuse to overwrite any existing files unless the --force flag - is used. This also disables Cargo's ability to protect against + is used. This also disables Cargo’s ability to protect against multiple concurrent invocations of Cargo installing at the same time. - --bin name... + --bin name… Install only the specified binary. --bins Install all binaries. - --example name... + --example name… Install only the specified example. --examples @@ -267,10 +267,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -305,18 +306,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Common Options +toolchain diff --git a/src/doc/man/generated_txt/cargo-locate-project.txt b/src/doc/man/generated_txt/cargo-locate-project.txt index bc1ab6cd32f..bc11890e998 100644 --- a/src/doc/man/generated_txt/cargo-locate-project.txt +++ b/src/doc/man/generated_txt/cargo-locate-project.txt @@ -1,8 +1,8 @@ CARGO-LOCATE-PROJECT(1) NAME - cargo-locate-project - Print a JSON representation of a Cargo.toml - file's location + cargo-locate-project — Print a JSON representation of a Cargo.toml + file’s location SYNOPSIS cargo locate-project [options] @@ -28,15 +28,17 @@ OPTIONS The representation in which to print the project location. Valid values: - o json (default): JSON object with the path under the key "root". + o json (default): JSON object with the path under the key + “root”. o plain: Just the path. -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-login.txt b/src/doc/man/generated_txt/cargo-login.txt index b6dcbc1d79c..da61f370256 100644 --- a/src/doc/man/generated_txt/cargo-login.txt +++ b/src/doc/man/generated_txt/cargo-login.txt @@ -1,7 +1,7 @@ CARGO-LOGIN(1) NAME - cargo-login - Save an API token from the registry locally + cargo-login — Save an API token from the registry locally SYNOPSIS cargo login [options] [token] @@ -31,10 +31,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-metadata.txt b/src/doc/man/generated_txt/cargo-metadata.txt index c67757cd30d..64f1e74906e 100644 --- a/src/doc/man/generated_txt/cargo-metadata.txt +++ b/src/doc/man/generated_txt/cargo-metadata.txt @@ -1,7 +1,7 @@ CARGO-METADATA(1) NAME - cargo-metadata - Machine-readable metadata about the current package + cargo-metadata — Machine-readable metadata about the current package SYNOPSIS cargo metadata [options] @@ -290,8 +290,8 @@ OUTPUT FORMAT OPTIONS Output Options --no-deps - Output information only about the workspace members and don't fetch - dependencies. + Output information only about the workspace members and don’t + fetch dependencies. --format-version version Specify the version of the output format to use. Currently 1 is the @@ -303,7 +303,7 @@ OPTIONS . Without this flag, the resolve includes all targets. - Note that the dependencies listed in the "packages" array still + Note that the dependencies listed in the “packages” array still includes all dependencies. Each package definition is intended to be an unaltered reproduction of the information within Cargo.toml. @@ -330,10 +330,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-new.txt b/src/doc/man/generated_txt/cargo-new.txt index 30f610ed6f2..6590aaf0e02 100644 --- a/src/doc/man/generated_txt/cargo-new.txt +++ b/src/doc/man/generated_txt/cargo-new.txt @@ -1,7 +1,7 @@ CARGO-NEW(1) NAME - cargo-new - Create a new Cargo package + cargo-new — Create a new Cargo package SYNOPSIS cargo new [options] path @@ -51,10 +51,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-owner.txt b/src/doc/man/generated_txt/cargo-owner.txt index 6e98506ccf7..18a52503a4b 100644 --- a/src/doc/man/generated_txt/cargo-owner.txt +++ b/src/doc/man/generated_txt/cargo-owner.txt @@ -1,7 +1,7 @@ CARGO-OWNER(1) NAME - cargo-owner - Manage the owners of a crate on the registry + cargo-owner — Manage the owners of a crate on the registry SYNOPSIS cargo owner [options] --add login [crate] @@ -25,10 +25,10 @@ DESCRIPTION OPTIONS Owner Options - -a, --add login... + -a, --add login… Invite the given user or team as an owner. - -r, --remove login... + -r, --remove login… Remove the given user or team as an owner. -l, --list @@ -58,10 +58,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-package.txt b/src/doc/man/generated_txt/cargo-package.txt index 2c23883ffcd..c5e33a5d2e9 100644 --- a/src/doc/man/generated_txt/cargo-package.txt +++ b/src/doc/man/generated_txt/cargo-package.txt @@ -1,7 +1,8 @@ CARGO-PACKAGE(1) NAME - cargo-package - Assemble the local package into a distributable tarball + cargo-package — Assemble the local package into a distributable + tarball SYNOPSIS cargo package [options] @@ -64,7 +65,7 @@ OPTIONS Print files included in a package without making one. --no-verify - Don't verify the contents by building them. + Don’t verify the contents by building them. --no-metadata Ignore warnings about a lack of human-usable metadata (such as the @@ -88,7 +89,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Package only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -99,7 +100,7 @@ OPTIONS --workspace Package all members in the workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -199,10 +200,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-pkgid.txt b/src/doc/man/generated_txt/cargo-pkgid.txt index e94a04d327b..4564ade6bfc 100644 --- a/src/doc/man/generated_txt/cargo-pkgid.txt +++ b/src/doc/man/generated_txt/cargo-pkgid.txt @@ -1,7 +1,7 @@ CARGO-PKGID(1) NAME - cargo-pkgid - Print a fully qualified package specification + cargo-pkgid — Print a fully qualified package specification SYNOPSIS cargo pkgid [options] [spec] @@ -47,10 +47,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-publish.txt b/src/doc/man/generated_txt/cargo-publish.txt index 7e12c724630..e356c2d73ee 100644 --- a/src/doc/man/generated_txt/cargo-publish.txt +++ b/src/doc/man/generated_txt/cargo-publish.txt @@ -1,7 +1,7 @@ CARGO-PUBLISH(1) NAME - cargo-publish - Upload a package to the registry + cargo-publish — Upload a package to the registry SYNOPSIS cargo publish [options] @@ -46,7 +46,7 @@ OPTIONS in all capital letters. --no-verify - Don't verify the contents by building them. + Don’t verify the contents by building them. --allow-dirty Allow working directories with uncommitted VCS changes to be @@ -166,10 +166,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-remove.txt b/src/doc/man/generated_txt/cargo-remove.txt index f206c523e5e..bac7483188f 100644 --- a/src/doc/man/generated_txt/cargo-remove.txt +++ b/src/doc/man/generated_txt/cargo-remove.txt @@ -1,10 +1,10 @@ CARGO-REMOVE(1) NAME - cargo-remove - Remove dependencies from a Cargo.toml manifest file + cargo-remove — Remove dependencies from a Cargo.toml manifest file SYNOPSIS - cargo remove [options] dependency... + cargo remove [options] dependency… DESCRIPTION Remove one or more dependencies from a Cargo.toml manifest. @@ -25,14 +25,15 @@ OPTIONS Miscellaneous Options --dry-run - Don't actually write to the manifest. + Don’t actually write to the manifest. Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -84,7 +85,7 @@ OPTIONS . Package Selection - -p spec..., --package spec... + -p spec…, --package spec… Package to remove from. Common Options diff --git a/src/doc/man/generated_txt/cargo-report.txt b/src/doc/man/generated_txt/cargo-report.txt index 489e45dcbb7..f75a60c50e1 100644 --- a/src/doc/man/generated_txt/cargo-report.txt +++ b/src/doc/man/generated_txt/cargo-report.txt @@ -1,20 +1,20 @@ CARGO-REPORT(1) NAME - cargo-report - Generate and display various kinds of reports + cargo-report — Generate and display various kinds of reports SYNOPSIS cargo report type [options] DESCRIPTION - Displays a report of the given type - currently, only future-incompat is - supported + Displays a report of the given type — currently, only future-incompat + is supported OPTIONS --id id Show the report with the specified Cargo-generated id - -p spec..., --package spec... + -p spec…, --package spec… Only display a report for the specified package EXAMPLES diff --git a/src/doc/man/generated_txt/cargo-run.txt b/src/doc/man/generated_txt/cargo-run.txt index 09f445e994a..4512bb0c97f 100644 --- a/src/doc/man/generated_txt/cargo-run.txt +++ b/src/doc/man/generated_txt/cargo-run.txt @@ -1,7 +1,7 @@ CARGO-RUN(1) NAME - cargo-run - Run the current package + cargo-run — Run the current package SYNOPSIS cargo run [options] [-- args] @@ -10,7 +10,7 @@ DESCRIPTION Run a binary or example of the local package. All the arguments following the two dashes (--) are passed to the binary - to run. If you're passing arguments to both Cargo and the binary, the + to run. If you’re passing arguments to both Cargo and the binary, the ones after -- go to the binary, the ones before go to Cargo. OPTIONS @@ -82,7 +82,7 @@ OPTIONS --ignore-rust-version Run the target even if the selected Rust compiler is older than the - required Rust version as configured in the project's rust-version + required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -114,10 +114,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -152,18 +153,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-rustc.txt b/src/doc/man/generated_txt/cargo-rustc.txt index 38da4a3de86..f0a6edb12c6 100644 --- a/src/doc/man/generated_txt/cargo-rustc.txt +++ b/src/doc/man/generated_txt/cargo-rustc.txt @@ -1,8 +1,8 @@ CARGO-RUSTC(1) NAME - cargo-rustc - Compile the current package, and pass extra options to the - compiler + cargo-rustc — Compile the current package, and pass extra options to + the compiler SYNOPSIS cargo rustc [options] [-- args] @@ -59,23 +59,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Build the package's library. + Build the package’s library. - --bin name... + --bin name… Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Build all binary targets. - --example name... + --example name… Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Build all example targets. - --test name... + --test name… Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -88,7 +88,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -171,7 +171,7 @@ OPTIONS --ignore-rust-version Build the target even if the selected Rust compiler is older than - the required Rust version as configured in the project's + the required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -216,10 +216,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -254,18 +255,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-rustdoc.txt b/src/doc/man/generated_txt/cargo-rustdoc.txt index a3218916b5e..dcd9c566efc 100644 --- a/src/doc/man/generated_txt/cargo-rustdoc.txt +++ b/src/doc/man/generated_txt/cargo-rustdoc.txt @@ -1,8 +1,8 @@ CARGO-RUSTDOC(1) NAME - cargo-rustdoc - Build a package's documentation, using specified custom - flags + cargo-rustdoc — Build a package’s documentation, using specified + custom flags SYNOPSIS cargo rustdoc [options] [-- args] @@ -59,23 +59,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Document the package's library. + Document the package’s library. - --bin name... + --bin name… Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Document all binary targets. - --example name... + --example name… Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Document all example targets. - --test name... + --test name… Document the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -88,7 +88,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Document the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -154,7 +154,7 @@ OPTIONS --ignore-rust-version Document the target even if the selected Rust compiler is older than - the required Rust version as configured in the project's + the required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -186,10 +186,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -224,18 +225,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-search.txt b/src/doc/man/generated_txt/cargo-search.txt index d0531de9159..42381cf4a45 100644 --- a/src/doc/man/generated_txt/cargo-search.txt +++ b/src/doc/man/generated_txt/cargo-search.txt @@ -1,10 +1,10 @@ CARGO-SEARCH(1) NAME - cargo-search - Search packages in crates.io + cargo-search — Search packages in crates.io SYNOPSIS - cargo search [options] [query...] + cargo search [options] [query…] DESCRIPTION This performs a textual search for crates on . The @@ -28,10 +28,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-test.txt b/src/doc/man/generated_txt/cargo-test.txt index 653f1d6f1a0..bb17deb9d85 100644 --- a/src/doc/man/generated_txt/cargo-test.txt +++ b/src/doc/man/generated_txt/cargo-test.txt @@ -1,7 +1,7 @@ CARGO-TEST(1) NAME - cargo-test - Execute unit and integration tests of a package + cargo-test — Execute unit and integration tests of a package SYNOPSIS cargo test [options] [testname] [-- test-options] @@ -11,11 +11,11 @@ DESCRIPTION The test filtering argument TESTNAME and all the arguments following the two dashes (--) are passed to the test binaries and thus to libtest - (rustc's built in unit-test and micro-benchmarking framework). If you're - passing arguments to both Cargo and the binary, the ones after -- go to - the binary, the ones before go to Cargo. For details about libtest's - arguments see the output of cargo test -- --help and check out the rustc - book's chapter on how tests work at + (rustc’s built in unit-test and micro-benchmarking framework). If + you’re passing arguments to both Cargo and the binary, the ones after + -- go to the binary, the ones before go to Cargo. For details about + libtest’s arguments see the output of cargo test -- --help and check + out the rustc book’s chapter on how tests work at . As an example, this will filter for tests with foo in their name and run @@ -55,7 +55,7 @@ DESCRIPTION OPTIONS Test Options --no-run - Compile, but don't run tests. + Compile, but don’t run tests. --no-fail-fast Run all tests regardless of failure. Without this flag, Cargo will @@ -77,7 +77,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Test only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -91,7 +91,7 @@ OPTIONS --all Deprecated alias for --workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -146,23 +146,23 @@ OPTIONS use single quotes or double quotes around each glob pattern. --lib - Test the package's library. + Test the package’s library. - --bin name... + --bin name… Test the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. --bins Test all binary targets. - --example name... + --example name… Test the specified example. This flag may be specified multiple times and supports common Unix glob patterns. --examples Test all example targets. - --test name... + --test name… Test the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -175,7 +175,7 @@ OPTIONS integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. - --bench name... + --bench name… Test the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -193,7 +193,7 @@ OPTIONS --tests --benches --examples. --doc - Test only the library's documentation. This cannot be mixed with + Test only the library’s documentation. This cannot be mixed with other target options. Feature Selection @@ -245,7 +245,7 @@ OPTIONS --ignore-rust-version Test the target even if the selected Rust compiler is older than the - required Rust version as configured in the project's rust-version + required Rust version as configured in the project’s rust-version field. --timings=fmts @@ -283,10 +283,11 @@ OPTIONS cargo test -- --nocapture -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -321,18 +322,19 @@ OPTIONS for more details. Conflicts with human and short. o json-diagnostic-short: Ensure the rendered field of JSON messages - contains the "short" rendering from rustc. Cannot be used with - human or short. + contains the “short” rendering from rustc. Cannot be used + with human or short. o json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting - rustc's default color scheme. Cannot be used with human or short. + rustc’s default color scheme. Cannot be used with human or + short. o json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself - should render the JSON diagnostics coming from rustc. Cargo's own - JSON diagnostics and others coming from rustc are still emitted. - Cannot be used with human or short. + should render the JSON diagnostics coming from rustc. Cargo’s + own JSON diagnostics and others coming from rustc are still + emitted. Cannot be used with human or short. Manifest Options --manifest-path path diff --git a/src/doc/man/generated_txt/cargo-tree.txt b/src/doc/man/generated_txt/cargo-tree.txt index e41d23e7e01..b8e5c98f557 100644 --- a/src/doc/man/generated_txt/cargo-tree.txt +++ b/src/doc/man/generated_txt/cargo-tree.txt @@ -1,14 +1,14 @@ CARGO-TREE(1) NAME - cargo-tree - Display a tree visualization of a dependency graph + cargo-tree — Display a tree visualization of a dependency graph SYNOPSIS cargo tree [options] DESCRIPTION This command will display a tree of dependencies to the terminal. An - example of a simple project that depends on the "rand" package: + example of a simple project that depends on the “rand” package: myproject v0.1.0 (/myproject) └── rand v0.7.3 @@ -24,13 +24,13 @@ DESCRIPTION [build-dependencies] └── cc v1.0.50 - Packages marked with (*) have been "de-duplicated". The dependencies for - the package have already been shown elsewhere in the graph, and so are - not repeated. Use the --no-dedupe option to repeat the duplicates. + Packages marked with (*) have been “de-duplicated”. The dependencies + for the package have already been shown elsewhere in the graph, and so + are not repeated. Use the --no-dedupe option to repeat the duplicates. The -e flag can be used to select the dependency kinds to display. The - "features" kind changes the output to display the features enabled by - each dependency. For example, cargo tree -e features: + “features” kind changes the output to display the features enabled + by each dependency. For example, cargo tree -e features: myproject v0.1.0 (/myproject) └── log feature "serde" @@ -40,9 +40,9 @@ DESCRIPTION └── cfg-if v0.1.10 In this tree, myproject depends on log with the serde feature. log in - turn depends on cfg-if with "default" features. When using -e features - it can be helpful to use -i flag to show how the features flow into a - package. See the examples below for more detail. + turn depends on cfg-if with “default” features. When using -e + features it can be helpful to use -i flag to show how the features flow + into a package. See the examples below for more detail. Feature Unification This command shows a graph much closer to a feature-unified graph Cargo @@ -55,7 +55,7 @@ DESCRIPTION As a result, for a mostly equivalent overview of what cargo build does, cargo tree -e normal,build is pretty close; for a mostly equivalent overview of what cargo test does, cargo tree is pretty close. However, - it doesn't guarantee the exact equivalence to what Cargo is going to + it doesn’t guarantee the exact equivalence to what Cargo is going to build, since a compilation is complex and depends on lots of different factors. @@ -71,12 +71,12 @@ OPTIONS package. Note that in a workspace, by default it will only display the - package's reverse dependencies inside the tree of the workspace + package’s reverse dependencies inside the tree of the workspace member in the current directory. The --workspace flag can be used to - extend it so that it will show the package's reverse dependencies + extend it so that it will show the package’s reverse dependencies across the entire workspace. The -p flag can be used to display the - package's reverse dependencies only with the subtree of the package - given to -p. + package’s reverse dependencies only with the subtree of the + package given to -p. --prune spec Prune the given package from the display of the dependency tree. @@ -141,10 +141,10 @@ OPTIONS Tree Formatting Options --charset charset Chooses the character set to use for the tree. Valid values are - "utf8" or "ascii". Default is "utf8". + “utf8” or “ascii”. Default is “utf8”. -f format, --format format - Set the format string for each package. The default is "{p}". + Set the format string for each package. The default is “{p}”. This is an arbitrary string which will be used to display each package. The following strings will be replaced with the @@ -159,8 +159,8 @@ OPTIONS o {f} — Comma-separated list of package features that are enabled. - o {lib} — The name, as used in a use statement, of the package's - library. + o {lib} — The name, as used in a use statement, of the + package’s library. --prefix prefix Sets how each line is displayed. The prefix value can be one of: @@ -186,7 +186,7 @@ OPTIONS passing --workspace), and a non-virtual workspace will include only the root crate itself. - -p spec..., --package spec... + -p spec…, --package spec… Display only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your @@ -197,7 +197,7 @@ OPTIONS --workspace Display all members in the workspace. - --exclude SPEC... + --exclude SPEC… Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to @@ -259,10 +259,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -371,14 +372,14 @@ EXAMPLES └── syn feature "proc-macro" (*) To read this graph, you can follow the chain for each feature from - the root to see why it is included. For example, the "full" feature - is added by the rustversion crate which is included from myproject - (with the default features), and myproject is the package selected on - the command-line. All of the other syn features are added by the - "default" feature ("quote" is added by "printing" and "proc-macro", - both of which are default features). - - If you're having difficulty cross-referencing the de-duplicated (*) + the root to see why it is included. For example, the “full” + feature is added by the rustversion crate which is included from + myproject (with the default features), and myproject is the package + selected on the command-line. All of the other syn features are added + by the “default” feature (“quote” is added by “printing” + and “proc-macro”, both of which are default features). + + If you’re having difficulty cross-referencing the de-duplicated (*) entries, try with the --no-dedupe flag to get the full output. SEE ALSO diff --git a/src/doc/man/generated_txt/cargo-uninstall.txt b/src/doc/man/generated_txt/cargo-uninstall.txt index 19ac378a02b..dcf3d55f75a 100644 --- a/src/doc/man/generated_txt/cargo-uninstall.txt +++ b/src/doc/man/generated_txt/cargo-uninstall.txt @@ -1,10 +1,10 @@ CARGO-UNINSTALL(1) NAME - cargo-uninstall - Remove a Rust binary + cargo-uninstall — Remove a Rust binary SYNOPSIS - cargo uninstall [options] [spec...] + cargo uninstall [options] [spec…] DESCRIPTION This command removes a package installed with cargo-install(1). The spec @@ -29,10 +29,10 @@ DESCRIPTION OPTIONS Install Options - -p, --package spec... + -p, --package spec… Package to uninstall. - --bin name... + --bin name… Only uninstall the binary name. --root dir @@ -40,10 +40,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-update.txt b/src/doc/man/generated_txt/cargo-update.txt index a9c1b934e40..a6cec24e30b 100644 --- a/src/doc/man/generated_txt/cargo-update.txt +++ b/src/doc/man/generated_txt/cargo-update.txt @@ -1,7 +1,7 @@ CARGO-UPDATE(1) NAME - cargo-update - Update dependencies as recorded in the local lock file + cargo-update — Update dependencies as recorded in the local lock file SYNOPSIS cargo update [options] @@ -13,7 +13,7 @@ DESCRIPTION OPTIONS Update Options - -p spec..., --package spec... + -p spec…, --package spec… Update only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for the SPEC format. @@ -37,20 +37,21 @@ OPTIONS -w, --workspace Attempt to update only packages defined in the workspace. Other - packages are updated only if they don't already exist in the - lockfile. This option is useful for updating Cargo.lock after you've - changed version numbers in Cargo.toml. + packages are updated only if they don’t already exist in the + lockfile. This option is useful for updating Cargo.lock after + you’ve changed version numbers in Cargo.toml. --dry-run - Displays what would be updated, but doesn't actually write the + Displays what would be updated, but doesn’t actually write the lockfile. Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-vendor.txt b/src/doc/man/generated_txt/cargo-vendor.txt index e2f07f5fa2b..0525e463b35 100644 --- a/src/doc/man/generated_txt/cargo-vendor.txt +++ b/src/doc/man/generated_txt/cargo-vendor.txt @@ -1,7 +1,7 @@ CARGO-VENDOR(1) NAME - cargo-vendor - Vendor all dependencies locally + cargo-vendor — Vendor all dependencies locally SYNOPSIS cargo vendor [options] [path] @@ -25,8 +25,8 @@ OPTIONS times. --no-delete - Don't delete the "vendor" directory when vendoring, but rather keep - all existing contents of the vendor directory + Don’t delete the “vendor” directory when vendoring, but rather + keep all existing contents of the vendor directory --respect-source-config Instead of ignoring [source] configuration by default in @@ -36,10 +36,10 @@ OPTIONS --versioned-dirs Normally versions are only added to disambiguate multiple versions of the same package. This option causes all directories in the - "vendor" directory to be versioned, which makes it easier to track - the history of vendored packages over time, and can help with the - performance of re-vendoring when only a subset of the packages have - changed. + “vendor” directory to be versioned, which makes it easier to + track the history of vendored packages over time, and can help with + the performance of re-vendoring when only a subset of the packages + have changed. Manifest Options --manifest-path path @@ -74,10 +74,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -137,15 +138,15 @@ EXIT STATUS o 101: Cargo failed to complete. EXAMPLES - 1. Vendor all dependencies into a local "vendor" folder + 1. Vendor all dependencies into a local “vendor” folder cargo vendor - 2. Vendor all dependencies into a local "third-party/vendor" folder + 2. Vendor all dependencies into a local “third-party/vendor” folder cargo vendor third-party/vendor - 3. Vendor the current workspace as well as another to "vendor" + 3. Vendor the current workspace as well as another to “vendor” cargo vendor -s ../path/to/Cargo.toml diff --git a/src/doc/man/generated_txt/cargo-verify-project.txt b/src/doc/man/generated_txt/cargo-verify-project.txt index b98c076f47d..f641ce911d0 100644 --- a/src/doc/man/generated_txt/cargo-verify-project.txt +++ b/src/doc/man/generated_txt/cargo-verify-project.txt @@ -1,7 +1,7 @@ CARGO-VERIFY-PROJECT(1) NAME - cargo-verify-project - Check correctness of crate manifest + cargo-verify-project — Check correctness of crate manifest SYNOPSIS cargo verify-project [options] @@ -20,10 +20,11 @@ DESCRIPTION OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo-version.txt b/src/doc/man/generated_txt/cargo-version.txt index fc26df72579..138390a2749 100644 --- a/src/doc/man/generated_txt/cargo-version.txt +++ b/src/doc/man/generated_txt/cargo-version.txt @@ -1,7 +1,7 @@ CARGO-VERSION(1) NAME - cargo-version - Show version information + cargo-version — Show version information SYNOPSIS cargo version [options] diff --git a/src/doc/man/generated_txt/cargo-yank.txt b/src/doc/man/generated_txt/cargo-yank.txt index 23dd9138961..e07e52626fe 100644 --- a/src/doc/man/generated_txt/cargo-yank.txt +++ b/src/doc/man/generated_txt/cargo-yank.txt @@ -1,16 +1,17 @@ CARGO-YANK(1) NAME - cargo-yank - Remove a pushed crate from the index + cargo-yank — Remove a pushed crate from the index SYNOPSIS cargo yank [options] crate@version cargo yank [options] --version version [crate] DESCRIPTION - The yank command removes a previously published crate's version from the - server's index. This command does not delete any data, and the crate - will still be available for download via the registry's download link. + The yank command removes a previously published crate’s version from + the server’s index. This command does not delete any data, and the + crate will still be available for download via the registry’s download + link. Note that existing crates locked to a yanked version will still be able to download the yanked version to use it. Cargo will, however, not allow @@ -54,10 +55,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the diff --git a/src/doc/man/generated_txt/cargo.txt b/src/doc/man/generated_txt/cargo.txt index f2d4a9f6ad2..9ebf6ef2150 100644 --- a/src/doc/man/generated_txt/cargo.txt +++ b/src/doc/man/generated_txt/cargo.txt @@ -1,7 +1,7 @@ CARGO(1) NAME - cargo - The Rust package manager + cargo — The Rust package manager SYNOPSIS cargo [options] command [args] @@ -29,7 +29,7 @@ COMMANDS     Remove artifacts that Cargo has generated in the past. cargo-doc(1) -     Build a package's documentation. +     Build a package’s documentation. cargo-fetch(1)     Fetch dependencies of a package from the network. @@ -44,7 +44,7 @@ COMMANDS     Compile a package, and pass extra options to the compiler. cargo-rustdoc(1) -     Build a package's documentation, using specified custom flags. +     Build a package’s documentation, using specified custom flags. cargo-test(1)     Execute unit and integration tests of a package. @@ -54,7 +54,7 @@ COMMANDS     Generate Cargo.lock for a project. cargo-locate-project(1) -     Print a JSON representation of a Cargo.toml file's location. +     Print a JSON representation of a Cargo.toml file’s location. cargo-metadata(1)     Output the resolved dependencies of a package in @@ -130,10 +130,11 @@ OPTIONS Display Options -v, --verbose - Use verbose output. May be specified twice for "very verbose" output - which includes extra output such as dependency warnings and build - script output. May also be specified with the term.verbose config - value . + 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 + . -q, --quiet Do not print cargo log messages. May also be specified with the @@ -221,8 +222,8 @@ EXIT STATUS FILES ~/.cargo/ -     Default location for Cargo's "home" directory where it stores - various files. The location can be changed with the CARGO_HOME +     Default location for Cargo’s “home” directory where it + stores various files. The location can be changed with the CARGO_HOME environment variable. $CARGO_HOME/bin/ @@ -275,7 +276,7 @@ EXAMPLES mkdir foo && cd foo cargo init . - 6. Learn about a command's options and usage: + 6. Learn about a command’s options and usage: cargo help clean diff --git a/src/doc/src/commands/cargo-add.md b/src/doc/src/commands/cargo-add.md index 13c2ab423ab..a54a551fd3b 100644 --- a/src/doc/src/commands/cargo-add.md +++ b/src/doc/src/commands/cargo-add.md @@ -4,7 +4,7 @@ ## NAME -cargo-add - Add dependencies to a Cargo.toml manifest file +cargo-add --- Add dependencies to a Cargo.toml manifest file ## SYNOPSIS @@ -98,7 +98,7 @@ which is defined by the registry.default config key which defaults
--dry-run
-
Don't actually write the manifest
+
Don’t actually write the manifest
--rename name
@@ -137,7 +137,7 @@ which enables all specified features.
-v
--verbose
-
Use verbose output. May be specified twice for "very verbose" output which +
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.
diff --git a/src/doc/src/commands/cargo-bench.md b/src/doc/src/commands/cargo-bench.md index 06b3b9923f4..e1858c402c2 100644 --- a/src/doc/src/commands/cargo-bench.md +++ b/src/doc/src/commands/cargo-bench.md @@ -5,7 +5,7 @@ ## NAME -cargo-bench - Execute benchmarks of a package +cargo-bench --- Execute benchmarks of a package ## SYNOPSIS @@ -63,7 +63,7 @@ debugger.
--no-run
-
Compile, but don't run benchmarks.
+
Compile, but don’t run benchmarks.
--no-fail-fast
@@ -91,8 +91,8 @@ virtual workspace will include all workspace members (equivalent to passing
-
-p spec...
-
--package spec...
+
-p spec…
+
--package spec…
Benchmark only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -110,7 +110,7 @@ double quotes around each pattern.
-
--exclude SPEC...
+
--exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -126,7 +126,7 @@ single quotes or double quotes around each pattern.
When no target selection options are given, `cargo bench` will build the following targets of the selected packages: -- lib — used to link with binaries and benchmarks +- lib --- used to link with binaries and benchmarks - bins (only if benchmark targets are built and required features are available) - lib as a benchmark @@ -161,10 +161,10 @@ use single quotes or double quotes around each glob pattern.
--lib
-
Benchmark the package's library.
+
Benchmark the package’s library.
-
--bin name...
+
--bin name…
Benchmark the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -174,7 +174,7 @@ and supports common Unix glob patterns. -
--example name...
+
--example name…
Benchmark the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -183,7 +183,7 @@ and supports common Unix glob patterns.
Benchmark all example targets.
-
--test name...
+
--test name…
Benchmark the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -198,7 +198,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
--bench name...
+
--bench name…
Benchmark the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
@@ -273,7 +273,7 @@ See the the reference for more details
--ignore-rust-version
Benchmark the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
+required Rust version as configured in the project’s rust-version field. @@ -322,7 +322,7 @@ passing `--nocapture` to the benchmark binaries:
-v
--verbose
-
Use verbose output. May be specified twice for "very verbose" output which +
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.
@@ -360,13 +360,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-build.md b/src/doc/src/commands/cargo-build.md index 971b0f4a216..6b60097aebf 100644 --- a/src/doc/src/commands/cargo-build.md +++ b/src/doc/src/commands/cargo-build.md @@ -4,7 +4,7 @@ ## NAME -cargo-build - Compile the current package +cargo-build --- Compile the current package ## SYNOPSIS @@ -31,8 +31,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Build only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -50,7 +50,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -88,10 +88,10 @@ use single quotes or double quotes around each glob pattern.
    --lib
    -
    Build the package's library.
    +
    Build the package’s library.
    -
    --bin name...
    +
    --bin name…
    Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -101,7 +101,7 @@ and supports common Unix glob patterns.
    -
    --example name...
    +
    --example name…
    Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -110,7 +110,7 @@ and supports common Unix glob patterns.
    Build all example targets.
    -
    --test name...
    +
    --test name…
    Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -125,7 +125,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
    --bench name...
    +
    --bench name…
    Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -207,7 +207,7 @@ See the the reference for more details
    --ignore-rust-version
    Build the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -258,7 +258,7 @@ See https://github.com/
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -296,13 +296,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-check.md b/src/doc/src/commands/cargo-check.md index 730e10d0629..18b0e2b5ee7 100644 --- a/src/doc/src/commands/cargo-check.md +++ b/src/doc/src/commands/cargo-check.md @@ -4,7 +4,7 @@ ## NAME -cargo-check - Check the current package +cargo-check --- Check the current package ## SYNOPSIS @@ -36,8 +36,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Check only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -55,7 +55,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -83,10 +83,10 @@ use single quotes or double quotes around each glob pattern.
    --lib
    -
    Check the package's library.
    +
    Check the package’s library.
    -
    --bin name...
    +
    --bin name…
    Check the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -96,7 +96,7 @@ and supports common Unix glob patterns.
    -
    --example name...
    +
    --example name…
    Check the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -105,7 +105,7 @@ and supports common Unix glob patterns.
    Check all example targets.
    -
    --test name...
    +
    --test name…
    Check the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -120,7 +120,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
    --bench name...
    +
    --bench name…
    Check the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -206,7 +206,7 @@ detail.

    --ignore-rust-version
    Check the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -248,7 +248,7 @@ Defaults to target in the root of the workspace.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -286,13 +286,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-clean.md b/src/doc/src/commands/cargo-clean.md index 89132f7d5ad..369837920fe 100644 --- a/src/doc/src/commands/cargo-clean.md +++ b/src/doc/src/commands/cargo-clean.md @@ -4,7 +4,7 @@ ## NAME -cargo-clean - Remove generated artifacts +cargo-clean --- Remove generated artifacts ## SYNOPSIS @@ -25,8 +25,8 @@ When no packages are selected, all packages and all dependencies in the workspace are cleaned.
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Clean only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for the SPEC format.
    @@ -76,7 +76,7 @@ target artifacts are placed in a separate directory. See the
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-doc.md b/src/doc/src/commands/cargo-doc.md index 2c6af666d35..f1150f56701 100644 --- a/src/doc/src/commands/cargo-doc.md +++ b/src/doc/src/commands/cargo-doc.md @@ -4,7 +4,7 @@ ## NAME -cargo-doc - Build a package's documentation +cargo-doc --- Build a package's documentation ## SYNOPSIS @@ -53,8 +53,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Document only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -72,7 +72,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -96,10 +96,10 @@ flag and will always document the given target.
    --lib
    -
    Document the package's library.
    +
    Document the package’s library.
    -
    --bin name...
    +
    --bin name…
    Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -109,7 +109,7 @@ and supports common Unix glob patterns.
    -
    --example name...
    +
    --example name…
    Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -180,7 +180,7 @@ See the the reference for more details
    --ignore-rust-version
    Document the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -222,7 +222,7 @@ Defaults to target in the root of the workspace.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -260,13 +260,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-fetch.md b/src/doc/src/commands/cargo-fetch.md index 471644fc3f4..b461619f64b 100644 --- a/src/doc/src/commands/cargo-fetch.md +++ b/src/doc/src/commands/cargo-fetch.md @@ -5,7 +5,7 @@ ## NAME -cargo-fetch - Fetch dependencies of a package from the network +cargo-fetch --- Fetch dependencies of a package from the network ## SYNOPSIS @@ -50,7 +50,7 @@ target artifacts are placed in a separate directory. See the
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-fix.md b/src/doc/src/commands/cargo-fix.md index db8e7b793c5..1b45fc27ff2 100644 --- a/src/doc/src/commands/cargo-fix.md +++ b/src/doc/src/commands/cargo-fix.md @@ -4,7 +4,7 @@ ## NAME -cargo-fix - Automatically fix lint warnings reported by rustc +cargo-fix --- Automatically fix lint warnings reported by rustc ## SYNOPSIS @@ -116,8 +116,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Fix only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -135,7 +135,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -163,10 +163,10 @@ use single quotes or double quotes around each glob pattern.
    --lib
    -
    Fix the package's library.
    +
    Fix the package’s library.
    -
    --bin name...
    +
    --bin name…
    Fix the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -176,7 +176,7 @@ and supports common Unix glob patterns.
    -
    --example name...
    +
    --example name…
    Fix the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -185,7 +185,7 @@ and supports common Unix glob patterns.
    Fix all example targets.
    -
    --test name...
    +
    --test name…
    Fix the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -200,7 +200,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
    --bench name...
    +
    --bench name…
    Fix the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -286,7 +286,7 @@ detail.

    --ignore-rust-version
    Fix the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -328,7 +328,7 @@ Defaults to target in the root of the workspace.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -366,13 +366,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-generate-lockfile.md b/src/doc/src/commands/cargo-generate-lockfile.md index c47f0b1272a..65c0591b5af 100644 --- a/src/doc/src/commands/cargo-generate-lockfile.md +++ b/src/doc/src/commands/cargo-generate-lockfile.md @@ -2,7 +2,7 @@ ## NAME -cargo-generate-lockfile - Generate the lockfile for a package +cargo-generate-lockfile --- Generate the lockfile for a package ## SYNOPSIS @@ -24,7 +24,7 @@ lockfile and has more options for controlling update behavior.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-help.md b/src/doc/src/commands/cargo-help.md index a3bffb1674c..db5cb342abf 100644 --- a/src/doc/src/commands/cargo-help.md +++ b/src/doc/src/commands/cargo-help.md @@ -2,7 +2,7 @@ ## NAME -cargo-help - Get help for a Cargo command +cargo-help --- Get help for a Cargo command ## SYNOPSIS diff --git a/src/doc/src/commands/cargo-init.md b/src/doc/src/commands/cargo-init.md index 8162cb3b249..83f681fdc24 100644 --- a/src/doc/src/commands/cargo-init.md +++ b/src/doc/src/commands/cargo-init.md @@ -2,7 +2,7 @@ ## NAME -cargo-init - Create a new Cargo package in an existing directory +cargo-init --- Create a new Cargo package in an existing directory ## SYNOPSIS @@ -72,7 +72,7 @@ be restricted.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-install.md b/src/doc/src/commands/cargo-install.md index 1262b79e0cd..e59693e447e 100644 --- a/src/doc/src/commands/cargo-install.md +++ b/src/doc/src/commands/cargo-install.md @@ -4,7 +4,7 @@ ## NAME -cargo-install - Build and install a Rust binary +cargo-install --- Build and install a Rust binary ## SYNOPSIS @@ -128,12 +128,12 @@ such as a newer version of rustc.
    By default, Cargo keeps track of the installed packages with a metadata file stored in the installation root directory. This flag tells Cargo not to use or create that file. With this flag, Cargo will refuse to overwrite any existing -files unless the --force flag is used. This also disables Cargo's ability to +files unless the --force flag is used. This also disables Cargo’s ability to protect against multiple concurrent invocations of Cargo installing at the same time.
    -
    --bin name...
    +
    --bin name…
    Install only the specified binary.
    @@ -141,7 +141,7 @@ same time.
    Install all binaries.
    -
    --example name...
    +
    --example name…
    Install only the specified example.
    @@ -311,7 +311,7 @@ the build on the first one that fails to build. Unstable, requires
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -349,13 +349,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-locate-project.md b/src/doc/src/commands/cargo-locate-project.md index 736407ad38f..efecd255c3a 100644 --- a/src/doc/src/commands/cargo-locate-project.md +++ b/src/doc/src/commands/cargo-locate-project.md @@ -2,7 +2,7 @@ ## NAME -cargo-locate-project - Print a JSON representation of a Cargo.toml file's location +cargo-locate-project --- Print a JSON representation of a Cargo.toml file's location ## SYNOPSIS @@ -37,14 +37,14 @@ workspace member.
    --message-format fmt
    The representation in which to print the project location. Valid values:

      -
    • json (default): JSON object with the path under the key "root".
      • +
    • json (default): JSON object with the path under the key “root”.
    • plain: Just the path.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-login.md b/src/doc/src/commands/cargo-login.md index d8c1c9e5d3d..63a885e9b59 100644 --- a/src/doc/src/commands/cargo-login.md +++ b/src/doc/src/commands/cargo-login.md @@ -2,7 +2,7 @@ ## NAME -cargo-login - Save an API token from the registry locally +cargo-login --- Save an API token from the registry locally ## SYNOPSIS @@ -40,7 +40,7 @@ which is defined by the registry.default config key which defaults
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-metadata.md b/src/doc/src/commands/cargo-metadata.md index 51bbda524f6..fc89e525e05 100644 --- a/src/doc/src/commands/cargo-metadata.md +++ b/src/doc/src/commands/cargo-metadata.md @@ -2,7 +2,7 @@ ## NAME -cargo-metadata - Machine-readable metadata about the current package +cargo-metadata --- Machine-readable metadata about the current package ## SYNOPSIS @@ -300,7 +300,7 @@ The output has the following format:
    --no-deps
    -
    Output information only about the workspace members and don't fetch +
    Output information only about the workspace members and don’t fetch dependencies.
    @@ -313,7 +313,7 @@ possible value.
    This filters the resolve output to only include dependencies for the given target triple. Without this flag, the resolve includes all targets.

    -

    Note that the dependencies listed in the "packages" array still includes all +

    Note that the dependencies listed in the “packages” array still includes all dependencies. Each package definition is intended to be an unaltered reproduction of the information within Cargo.toml.

    @@ -354,7 +354,7 @@ be specified multiple times, which enables all specified features.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-new.md b/src/doc/src/commands/cargo-new.md index 6bca79594b8..c08bfc05536 100644 --- a/src/doc/src/commands/cargo-new.md +++ b/src/doc/src/commands/cargo-new.md @@ -2,7 +2,7 @@ ## NAME -cargo-new - Create a new Cargo package +cargo-new --- Create a new Cargo package ## SYNOPSIS @@ -67,7 +67,7 @@ be restricted.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-owner.md b/src/doc/src/commands/cargo-owner.md index 0473790cd99..17740a2ec37 100644 --- a/src/doc/src/commands/cargo-owner.md +++ b/src/doc/src/commands/cargo-owner.md @@ -2,7 +2,7 @@ ## NAME -cargo-owner - Manage the owners of a crate on the registry +cargo-owner --- Manage the owners of a crate on the registry ## SYNOPSIS @@ -32,12 +32,12 @@ information about owners and publishing.
    -a
    -
    --add login...
    +
    --add login…
    Invite the given user or team as an owner.
    -r
    -
    --remove login...
    +
    --remove login…
    Remove the given user or team as an owner.
    @@ -78,7 +78,7 @@ which is defined by the registry.default config key which defaults
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-package.md b/src/doc/src/commands/cargo-package.md index efae5db59df..827f25724fd 100644 --- a/src/doc/src/commands/cargo-package.md +++ b/src/doc/src/commands/cargo-package.md @@ -5,7 +5,7 @@ ## NAME -cargo-package - Assemble the local package into a distributable tarball +cargo-package --- Assemble the local package into a distributable tarball ## SYNOPSIS @@ -72,7 +72,7 @@ in subdirectories of the version control repository.
    --no-verify
    -
    Don't verify the contents by building them.
    +
    Don’t verify the contents by building them.
    --no-metadata
    @@ -101,8 +101,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Package only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -116,7 +116,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -244,7 +244,7 @@ the build on the first one that fails to build. Unstable, requires
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-pkgid.md b/src/doc/src/commands/cargo-pkgid.md index ab6d5134c2b..b7fe6d2dfff 100644 --- a/src/doc/src/commands/cargo-pkgid.md +++ b/src/doc/src/commands/cargo-pkgid.md @@ -2,7 +2,7 @@ ## NAME -cargo-pkgid - Print a fully qualified package specification +cargo-pkgid --- Print a fully qualified package specification ## SYNOPSIS @@ -51,7 +51,7 @@ _url_`#`_name_`:`_version_ | `https://github.com/rust-lang/cargo#crates-io@0.21.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-publish.md b/src/doc/src/commands/cargo-publish.md index e69d7170eb2..ee49ec1f1fc 100644 --- a/src/doc/src/commands/cargo-publish.md +++ b/src/doc/src/commands/cargo-publish.md @@ -4,7 +4,7 @@ ## NAME -cargo-publish - Upload a package to the registry +cargo-publish --- Upload a package to the registry ## SYNOPSIS @@ -53,7 +53,7 @@ of the registry in all capital letters.
    --no-verify
    -
    Don't verify the contents by building them.
    +
    Don’t verify the contents by building them.
    --allow-dirty
    @@ -210,7 +210,7 @@ the build on the first one that fails to build. Unstable, requires
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-remove.md b/src/doc/src/commands/cargo-remove.md index 66d01432ef8..29989815a7b 100644 --- a/src/doc/src/commands/cargo-remove.md +++ b/src/doc/src/commands/cargo-remove.md @@ -4,7 +4,7 @@ ## NAME -cargo-remove - Remove dependencies from a Cargo.toml manifest file +cargo-remove --- Remove dependencies from a Cargo.toml manifest file ## SYNOPSIS @@ -39,7 +39,7 @@ Remove one or more dependencies from a `Cargo.toml` manifest.
    --dry-run
    -
    Don't actually write to the manifest.
    +
    Don’t actually write to the manifest.
    @@ -49,7 +49,7 @@ Remove one or more dependencies from a `Cargo.toml` manifest.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -115,8 +115,8 @@ offline.

    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Package to remove from.
    diff --git a/src/doc/src/commands/cargo-report.md b/src/doc/src/commands/cargo-report.md index 5df2303e6af..130449d1200 100644 --- a/src/doc/src/commands/cargo-report.md +++ b/src/doc/src/commands/cargo-report.md @@ -2,7 +2,7 @@ ## NAME -cargo-report - Generate and display various kinds of reports +cargo-report --- Generate and display various kinds of reports ## SYNOPSIS @@ -10,7 +10,7 @@ cargo-report - Generate and display various kinds of reports ### DESCRIPTION -Displays a report of the given _type_ - currently, only `future-incompat` is supported +Displays a report of the given _type_ --- currently, only `future-incompat` is supported ## OPTIONS @@ -20,8 +20,8 @@ Displays a report of the given _type_ - currently, only `future-incompat` is sup
    Show the report with the specified Cargo-generated id
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Only display a report for the specified package
    diff --git a/src/doc/src/commands/cargo-run.md b/src/doc/src/commands/cargo-run.md index 530684942c3..396c2d499dd 100644 --- a/src/doc/src/commands/cargo-run.md +++ b/src/doc/src/commands/cargo-run.md @@ -3,7 +3,7 @@ ## NAME -cargo-run - Run the current package +cargo-run --- Run the current package ## SYNOPSIS @@ -114,7 +114,7 @@ See the the reference for more details
    --ignore-rust-version
    Run the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -157,7 +157,7 @@ Defaults to target in the root of the workspace.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -195,13 +195,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-rustc.md b/src/doc/src/commands/cargo-rustc.md index d753426bedf..43e18d70cef 100644 --- a/src/doc/src/commands/cargo-rustc.md +++ b/src/doc/src/commands/cargo-rustc.md @@ -4,7 +4,7 @@ ## NAME -cargo-rustc - Compile the current package, and pass extra options to the compiler +cargo-rustc --- Compile the current package, and pass extra options to the compiler ## SYNOPSIS @@ -75,10 +75,10 @@ use single quotes or double quotes around each glob pattern.
    --lib
    -
    Build the package's library.
    +
    Build the package’s library.
    -
    --bin name...
    +
    --bin name…
    Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -88,7 +88,7 @@ and supports common Unix glob patterns. -
    --example name...
    +
    --example name…
    Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -97,7 +97,7 @@ and supports common Unix glob patterns.
    Build all example targets.
    -
    --test name...
    +
    --test name…
    Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -112,7 +112,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
    --bench name...
    +
    --bench name…
    Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -204,7 +204,7 @@ similar to the test profile.
    --ignore-rust-version
    Build the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -258,7 +258,7 @@ Defaults to target in the root of the workspace.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -296,13 +296,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-rustdoc.md b/src/doc/src/commands/cargo-rustdoc.md index a75d5e2fd4e..133fa35f26d 100644 --- a/src/doc/src/commands/cargo-rustdoc.md +++ b/src/doc/src/commands/cargo-rustdoc.md @@ -4,7 +4,7 @@ ## NAME -cargo-rustdoc - Build a package's documentation, using specified custom flags +cargo-rustdoc --- Build a package's documentation, using specified custom flags ## SYNOPSIS @@ -80,10 +80,10 @@ use single quotes or double quotes around each glob pattern.
    --lib
    -
    Document the package's library.
    +
    Document the package’s library.
    -
    --bin name...
    +
    --bin name…
    Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -93,7 +93,7 @@ and supports common Unix glob patterns. -
    --example name...
    +
    --example name…
    Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -102,7 +102,7 @@ and supports common Unix glob patterns.
    Document all example targets.
    -
    --test name...
    +
    --test name…
    Document the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -117,7 +117,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
    --bench name...
    +
    --bench name…
    Document the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -199,7 +199,7 @@ See the the reference for more details
    --ignore-rust-version
    Document the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -241,7 +241,7 @@ Defaults to target in the root of the workspace.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -279,13 +279,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-search.md b/src/doc/src/commands/cargo-search.md index 8b509197c86..6f2dedd51eb 100644 --- a/src/doc/src/commands/cargo-search.md +++ b/src/doc/src/commands/cargo-search.md @@ -2,7 +2,7 @@ ## NAME -cargo-search - Search packages in crates.io +cargo-search --- Search packages in crates.io ## SYNOPSIS @@ -44,7 +44,7 @@ which is defined by the registry.default config key which defaults
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-test.md b/src/doc/src/commands/cargo-test.md index 9614e259eb1..0ba9dcc6148 100644 --- a/src/doc/src/commands/cargo-test.md +++ b/src/doc/src/commands/cargo-test.md @@ -5,7 +5,7 @@ ## NAME -cargo-test - Execute unit and integration tests of a package +cargo-test --- Execute unit and integration tests of a package ## SYNOPSIS @@ -64,7 +64,7 @@ on writing doc tests.
    --no-run
    -
    Compile, but don't run tests.
    +
    Compile, but don’t run tests.
    --no-fail-fast
    @@ -92,8 +92,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Test only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -111,7 +111,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -127,10 +127,10 @@ single quotes or double quotes around each pattern.
    When no target selection options are given, `cargo test` will build the following targets of the selected packages: -- lib — used to link with binaries, examples, integration tests, and doc tests +- lib --- used to link with binaries, examples, integration tests, and doc tests - bins (only if integration tests are built and required features are available) -- examples — to ensure they compile +- examples --- to ensure they compile - lib as a unit test - bins as unit tests - integration tests @@ -166,10 +166,10 @@ use single quotes or double quotes around each glob pattern.
    --lib
    -
    Test the package's library.
    +
    Test the package’s library.
    -
    --bin name...
    +
    --bin name…
    Test the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -179,7 +179,7 @@ and supports common Unix glob patterns. -
    --example name...
    +
    --example name…
    Test the specified example. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -188,7 +188,7 @@ and supports common Unix glob patterns.
    Test all example targets.
    -
    --test name...
    +
    --test name…
    Test the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -203,7 +203,7 @@ Targets may be enabled or disabled by setting the test flag in the manifest settings for the target. -
    --bench name...
    +
    --bench name…
    Test the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.
    @@ -228,7 +228,7 @@ manifest settings for the target.
    --doc
    -
    Test only the library's documentation. This cannot be mixed with other +
    Test only the library’s documentation. This cannot be mixed with other target options.
    @@ -294,7 +294,7 @@ See the the reference for more details
    --ignore-rust-version
    Test the target even if the selected Rust compiler is older than the -required Rust version as configured in the project's rust-version field.
    +required Rust version as configured in the project’s rust-version field. @@ -343,7 +343,7 @@ results readable. Test output can be recovered (e.g., for debugging) by passing
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    @@ -381,13 +381,13 @@ and json. the reference for more details. Conflicts with human and short.
  • json-diagnostic-short: Ensure the rendered field of JSON messages contains -the "short" rendering from rustc. Cannot be used with human or short.
    • +the “short” rendering from rustc. Cannot be used with human or short.
  • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.
  • json-render-diagnostics: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.
    • diff --git a/src/doc/src/commands/cargo-tree.md b/src/doc/src/commands/cargo-tree.md index 8ce1480e2d5..b13d2395eb1 100644 --- a/src/doc/src/commands/cargo-tree.md +++ b/src/doc/src/commands/cargo-tree.md @@ -4,7 +4,7 @@ ## NAME -cargo-tree - Display a tree visualization of a dependency graph +cargo-tree --- Display a tree visualization of a dependency graph ## SYNOPSIS @@ -80,11 +80,11 @@ To learn more about feature unification, check out this
    --invert spec
    Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package.

    -

    Note that in a workspace, by default it will only display the package's +

    Note that in a workspace, by default it will only display the package’s reverse dependencies inside the tree of the workspace member in the current directory. The --workspace flag can be used to extend it so that it will -show the package's reverse dependencies across the entire workspace. The -p -flag can be used to display the package's reverse dependencies only with the +show the package’s reverse dependencies across the entire workspace. The -p +flag can be used to display the package’s reverse dependencies only with the subtree of the package given to -p.

    @@ -148,13 +148,13 @@ The default is the host platform. Use the value all to include
    --charset charset
    -
    Chooses the character set to use for the tree. Valid values are "utf8" or -"ascii". Default is "utf8".
    +
    Chooses the character set to use for the tree. Valid values are “utf8” or +“ascii”. Default is “utf8”.
    -f format
    --format format
    -
    Set the format string for each package. The default is "{p}".

    +
    Set the format string for each package. The default is “{p}”.

    This is an arbitrary string which will be used to display each package. The following strings will be replaced with the corresponding value:

      @@ -162,7 +162,7 @@ strings will be replaced with the corresponding value:

    • {l} — The package license.
    • {r} — The package repository URL.
    • {f} — Comma-separated list of package features that are enabled.
      • -
    • {lib} — The name, as used in a use statement, of the package's library.
      • +
    • {lib} — The name, as used in a use statement, of the package’s library.
    @@ -192,8 +192,8 @@ virtual workspace will include all workspace members (equivalent to passing
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Display only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally @@ -207,7 +207,7 @@ double quotes around each pattern.
    -
    --exclude SPEC...
    +
    --exclude SPEC…
    Exclude the specified packages. Must be used in conjunction with the --workspace flag. This flag may be specified multiple times and supports common Unix glob patterns like *, ? and []. However, to avoid your shell @@ -290,7 +290,7 @@ be specified multiple times, which enables all specified features.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-uninstall.md b/src/doc/src/commands/cargo-uninstall.md index 5249eedf3fc..2fb7490b901 100644 --- a/src/doc/src/commands/cargo-uninstall.md +++ b/src/doc/src/commands/cargo-uninstall.md @@ -2,7 +2,7 @@ ## NAME -cargo-uninstall - Remove a Rust binary +cargo-uninstall --- Remove a Rust binary ## SYNOPSIS @@ -33,11 +33,11 @@ The installation root is determined, in order of precedence:
    -p
    -
    --package spec...
    +
    --package spec…
    Package to uninstall.
    -
    --bin name...
    +
    --bin name…
    Only uninstall the binary name.
    @@ -53,7 +53,7 @@ The installation root is determined, in order of precedence:
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-update.md b/src/doc/src/commands/cargo-update.md index dad1c4757e7..4cc8ddd64bc 100644 --- a/src/doc/src/commands/cargo-update.md +++ b/src/doc/src/commands/cargo-update.md @@ -2,7 +2,7 @@ ## NAME -cargo-update - Update dependencies as recorded in the local lock file +cargo-update --- Update dependencies as recorded in the local lock file ## SYNOPSIS @@ -20,8 +20,8 @@ latest available versions.
    -
    -p spec...
    -
    --package spec...
    +
    -p spec…
    +
    --package spec…
    Update only the specified packages. This flag may be specified multiple times. See cargo-pkgid(1) for the SPEC format.

    If packages are specified with the -p flag, then a conservative update of @@ -46,13 +46,13 @@ revision (such as a SHA hash or tag).

    -w
    --workspace
    Attempt to update only packages defined in the workspace. Other packages -are updated only if they don't already exist in the lockfile. This -option is useful for updating Cargo.lock after you've changed version +are updated only if they don’t already exist in the lockfile. This +option is useful for updating Cargo.lock after you’ve changed version numbers in Cargo.toml.
    --dry-run
    -
    Displays what would be updated, but doesn't actually write the lockfile.
    +
    Displays what would be updated, but doesn’t actually write the lockfile.
    @@ -62,7 +62,7 @@ numbers in Cargo.toml.
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-vendor.md b/src/doc/src/commands/cargo-vendor.md index 020ddce7c8d..095e4418778 100644 --- a/src/doc/src/commands/cargo-vendor.md +++ b/src/doc/src/commands/cargo-vendor.md @@ -2,7 +2,7 @@ ## NAME -cargo-vendor - Vendor all dependencies locally +cargo-vendor --- Vendor all dependencies locally ## SYNOPSIS @@ -32,7 +32,7 @@ vendored and synced to the output. May be specified multiple times.
    --no-delete
    -
    Don't delete the "vendor" directory when vendoring, but rather keep all +
    Don’t delete the “vendor” directory when vendoring, but rather keep all existing contents of the vendor directory
    @@ -43,7 +43,7 @@ read it and use it when downloading crates from crates.io, for example
    --versioned-dirs
    Normally versions are only added to disambiguate multiple versions of the -same package. This option causes all directories in the "vendor" directory +same package. This option causes all directories in the “vendor” directory to be versioned, which makes it easier to track the history of vendored packages over time, and can help with the performance of re-vendoring when only a subset of the packages have changed.
    @@ -94,7 +94,7 @@ offline.

    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-verify-project.md b/src/doc/src/commands/cargo-verify-project.md index 9d59468d666..1134b38e4df 100644 --- a/src/doc/src/commands/cargo-verify-project.md +++ b/src/doc/src/commands/cargo-verify-project.md @@ -2,7 +2,7 @@ ## NAME -cargo-verify-project - Check correctness of crate manifest +cargo-verify-project --- Check correctness of crate manifest ## SYNOPSIS @@ -27,7 +27,7 @@ An invalid workspace will display:
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo-version.md b/src/doc/src/commands/cargo-version.md index 1ceacf81113..e9e12a05f79 100644 --- a/src/doc/src/commands/cargo-version.md +++ b/src/doc/src/commands/cargo-version.md @@ -2,7 +2,7 @@ ## NAME -cargo-version - Show version information +cargo-version --- Show version information ## SYNOPSIS diff --git a/src/doc/src/commands/cargo-yank.md b/src/doc/src/commands/cargo-yank.md index f8bac57419f..b1371185e02 100644 --- a/src/doc/src/commands/cargo-yank.md +++ b/src/doc/src/commands/cargo-yank.md @@ -2,7 +2,7 @@ ## NAME -cargo-yank - Remove a pushed crate from the index +cargo-yank --- Remove a pushed crate from the index ## SYNOPSIS @@ -73,7 +73,7 @@ which is defined by the registry.default config key which defaults
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/doc/src/commands/cargo.md b/src/doc/src/commands/cargo.md index 2329ea021e3..9e3392fd410 100644 --- a/src/doc/src/commands/cargo.md +++ b/src/doc/src/commands/cargo.md @@ -2,7 +2,7 @@ ## NAME -cargo - The Rust package manager +cargo --- The Rust package manager ## SYNOPSIS @@ -152,7 +152,7 @@ error message (for example, E0004).
    -v
    --verbose
    -
    Use verbose output. May be specified twice for "very verbose" output which +
    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.
    diff --git a/src/etc/man/cargo-add.1 b/src/etc/man/cargo-add.1 index 51bc190b2c7..05e52d68d88 100644 --- a/src/etc/man/cargo-add.1 +++ b/src/etc/man/cargo-add.1 @@ -4,20 +4,20 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-add \- Add dependencies to a Cargo.toml manifest file +cargo\-add \[em] Add dependencies to a Cargo.toml manifest file .SH "SYNOPSIS" -\fBcargo add\fR [\fIoptions\fR] \fIcrate\fR\&... +\fBcargo add\fR [\fIoptions\fR] \fIcrate\fR\[u2026] .br \fBcargo add\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR .br -\fBcargo add\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\&...] +\fBcargo add\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\[u2026]] .SH "DESCRIPTION" This command can add or modify dependencies. .sp The source for the dependency can be specified with: .sp .RS 4 -\h'-04'\(bu\h'+02'\fIcrate\fR\fB@\fR\fIversion\fR: Fetch from a registry with a version constraint of "\fIversion\fR" +\h'-04'\(bu\h'+02'\fIcrate\fR\fB@\fR\fIversion\fR: Fetch from a registry with a version constraint of \[lq]\fIversion\fR\[rq] .RE .sp .RS 4 @@ -45,7 +45,7 @@ If no source is specified, then a best effort will be made to select one, includ When you add a package that is already present, the existing entry will be updated with the flags specified. .sp Upon successful invocation, the enabled (\fB+\fR) and disabled (\fB\-\fR) \fIfeatures\fR of the specified -dependency will be listed in the command's output. +dependency will be listed in the command\[cq]s output. .SH "OPTIONS" .SS "Source options" .sp @@ -102,7 +102,7 @@ Add as a dependency to the \fIgiven target platform\fR \&. diff --git a/src/etc/man/cargo-bench.1 b/src/etc/man/cargo-bench.1 index ee94caa849c..8cc7195e517 100644 --- a/src/etc/man/cargo-bench.1 +++ b/src/etc/man/cargo-bench.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-bench \- Execute benchmarks of a package +cargo\-bench \[em] Execute benchmarks of a package .SH "SYNOPSIS" \fBcargo bench\fR [\fIoptions\fR] [\fIbenchname\fR] [\fB\-\-\fR \fIbench\-options\fR] .SH "DESCRIPTION" @@ -12,11 +12,11 @@ Compile and execute benchmarks. .sp The benchmark filtering argument \fIbenchname\fR and all the arguments following the two dashes (\fB\-\-\fR) are passed to the benchmark binaries and thus to -\fIlibtest\fR (rustc's built in unit\-test and micro\-benchmarking framework). If +\fIlibtest\fR (rustc\[cq]s built in unit\-test and micro\-benchmarking framework). If you are passing arguments to both Cargo and the binary, the ones after \fB\-\-\fR go -to the binary, the ones before go to Cargo. For details about libtest's +to the binary, the ones before go to Cargo. For details about libtest\[cq]s arguments see the output of \fBcargo bench \-\- \-\-help\fR and check out the rustc -book's chapter on how tests work at +book\[cq]s chapter on how tests work at \&. .sp As an example, this will run only the benchmark named \fBfoo\fR (and skip other @@ -62,7 +62,7 @@ debugger. .sp \fB\-\-no\-run\fR .RS 4 -Compile, but don't run benchmarks. +Compile, but don\[cq]t run benchmarks. .RE .sp \fB\-\-no\-fail\-fast\fR @@ -84,8 +84,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Benchmark only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -104,7 +104,7 @@ Benchmark all members in the workspace. Deprecated alias for \fB\-\-workspace\fR\&. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -163,10 +163,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Benchmark the package's library. +Benchmark the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Benchmark the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -177,7 +177,7 @@ and supports common Unix glob patterns. Benchmark all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Benchmark the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -188,7 +188,7 @@ and supports common Unix glob patterns. Benchmark all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Benchmark the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -205,7 +205,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Benchmark the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -276,7 +276,7 @@ See the \fIthe reference\fR \&. @@ -381,19 +381,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-build.1 b/src/etc/man/cargo-build.1 index f2bb188bf74..d42d6a1006c 100644 --- a/src/etc/man/cargo-build.1 +++ b/src/etc/man/cargo-build.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-build \- Compile the current package +cargo\-build \[em] Compile the current package .SH "SYNOPSIS" \fBcargo build\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -22,8 +22,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Build only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -42,7 +42,7 @@ Build all members in the workspace. Deprecated alias for \fB\-\-workspace\fR\&. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -74,10 +74,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Build the package's library. +Build the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -88,7 +88,7 @@ and supports common Unix glob patterns. Build all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -99,7 +99,7 @@ and supports common Unix glob patterns. Build all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -116,7 +116,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -194,7 +194,7 @@ See the \fIthe reference\fR for more information. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. @@ -300,19 +300,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-check.1 b/src/etc/man/cargo-check.1 index c2da3d3201a..b18e2202ad2 100644 --- a/src/etc/man/cargo-check.1 +++ b/src/etc/man/cargo-check.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-check \- Check the current package +cargo\-check \[em] Check the current package .SH "SYNOPSIS" \fBcargo check\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -13,7 +13,7 @@ essentially compile the packages without performing the final step of code generation, which is faster than running \fBcargo build\fR\&. The compiler will save metadata files to disk so that future runs will reuse them if the source has not been modified. Some diagnostics and errors are only emitted during code -generation, so they inherently won't be reported with \fBcargo check\fR\&. +generation, so they inherently won\[cq]t be reported with \fBcargo check\fR\&. .SH "OPTIONS" .SS "Package Selection" By default, when no package selection options are given, the packages selected @@ -27,8 +27,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Check only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -47,7 +47,7 @@ Check all members in the workspace. Deprecated alias for \fB\-\-workspace\fR\&. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -70,10 +70,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Check the package's library. +Check the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Check the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -84,7 +84,7 @@ and supports common Unix glob patterns. Check all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Check the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -95,7 +95,7 @@ and supports common Unix glob patterns. Check all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Check the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -112,7 +112,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Check the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -196,7 +196,7 @@ See the \fIthe reference\fR \&. @@ -292,19 +292,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-clean.1 b/src/etc/man/cargo-clean.1 index 1d945cb9819..7799cca8c04 100644 --- a/src/etc/man/cargo-clean.1 +++ b/src/etc/man/cargo-clean.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-clean \- Remove generated artifacts +cargo\-clean \[em] Remove generated artifacts .SH "SYNOPSIS" \fBcargo clean\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -17,8 +17,8 @@ With no options, \fBcargo clean\fR will delete the entire target directory. When no packages are selected, all packages and all dependencies in the workspace are cleaned. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Clean only the specified packages. This flag may be specified multiple times. See \fBcargo\-pkgid\fR(1) for the SPEC format. @@ -67,7 +67,7 @@ target artifacts are placed in a separate directory. See the \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-doc.1 b/src/etc/man/cargo-doc.1 index d6757dc65e1..76f1a0914a1 100644 --- a/src/etc/man/cargo-doc.1 +++ b/src/etc/man/cargo-doc.1 @@ -4,12 +4,12 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-doc \- Build a package's documentation +cargo\-doc \[em] Build a package\[cq]s documentation .SH "SYNOPSIS" \fBcargo doc\fR [\fIoptions\fR] .SH "DESCRIPTION" Build the documentation for the local package and all dependencies. The output -is placed in \fBtarget/doc\fR in rustdoc's usual format. +is placed in \fBtarget/doc\fR in rustdoc\[cq]s usual format. .SH "OPTIONS" .SS "Documentation Options" .sp @@ -42,8 +42,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Document only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -62,7 +62,7 @@ Document all members in the workspace. Deprecated alias for \fB\-\-workspace\fR\&. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -82,10 +82,10 @@ flag and will always document the given target. .sp \fB\-\-lib\fR .RS 4 -Document the package's library. +Document the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -96,7 +96,7 @@ and supports common Unix glob patterns. Document all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -163,7 +163,7 @@ See the \fIthe reference\fR \&. @@ -259,19 +259,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-fetch.1 b/src/etc/man/cargo-fetch.1 index bab11829c9c..9b8bc8f088c 100644 --- a/src/etc/man/cargo-fetch.1 +++ b/src/etc/man/cargo-fetch.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-fetch \- Fetch dependencies of a package from the network +cargo\-fetch \[em] Fetch dependencies of a package from the network .SH "SYNOPSIS" \fBcargo fetch\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -41,7 +41,7 @@ target artifacts are placed in a separate directory. See the \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-fix.1 b/src/etc/man/cargo-fix.1 index bcc709f900e..3d842628816 100644 --- a/src/etc/man/cargo-fix.1 +++ b/src/etc/man/cargo-fix.1 @@ -4,18 +4,18 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-fix \- Automatically fix lint warnings reported by rustc +cargo\-fix \[em] Automatically fix lint warnings reported by rustc .SH "SYNOPSIS" \fBcargo fix\fR [\fIoptions\fR] .SH "DESCRIPTION" -This Cargo subcommand will automatically take rustc's suggestions from +This Cargo subcommand will automatically take rustc\[cq]s suggestions from diagnostics like warnings and apply them to your source code. This is intended to help automate tasks that rustc itself already knows how to tell you to fix! .sp Executing \fBcargo fix\fR will under the hood execute \fBcargo\-check\fR(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 apply all fixes to the current package, you can run: +example if you\[cq]d like to apply all fixes to the current package, you can run: .sp .RS 4 .nf @@ -45,7 +45,7 @@ cargo fix \-\-target x86_64\-pc\-windows\-gnu .RE .sp If you encounter any problems with \fBcargo fix\fR or otherwise have any questions -or feature requests please don't hesitate to file an issue at +or feature requests please don\[cq]t hesitate to file an issue at \&. .SS "Edition migration" The \fBcargo fix\fR subcommand can also be used to migrate a package from one @@ -68,7 +68,7 @@ warnings are issued, you may want to consider running \fBcargo fix\fR again compiler. .RE .sp -And hopefully that's it! Just keep in mind of the caveats mentioned above that +And hopefully that\[cq]s it! Just keep in mind of the caveats mentioned above that \fBcargo fix\fR cannot update code for inactive features or \fBcfg\fR expressions. Also, in some rare cases the compiler is unable to automatically migrate all code to the new edition, and this may require manual changes after building @@ -122,8 +122,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Fix only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -142,7 +142,7 @@ Fix all members in the workspace. Deprecated alias for \fB\-\-workspace\fR\&. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -165,10 +165,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Fix the package's library. +Fix the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Fix the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -179,7 +179,7 @@ and supports common Unix glob patterns. Fix all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Fix the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -190,7 +190,7 @@ and supports common Unix glob patterns. Fix all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Fix the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -207,7 +207,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Fix the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -291,7 +291,7 @@ See the \fIthe reference\fR \&. @@ -387,19 +387,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-generate-lockfile.1 b/src/etc/man/cargo-generate-lockfile.1 index 67cf7a8f466..da4a5fbe675 100644 --- a/src/etc/man/cargo-generate-lockfile.1 +++ b/src/etc/man/cargo-generate-lockfile.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-generate\-lockfile \- Generate the lockfile for a package +cargo\-generate\-lockfile \[em] Generate the lockfile for a package .SH "SYNOPSIS" \fBcargo generate\-lockfile\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -20,7 +20,7 @@ lockfile and has more options for controlling update behavior. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-help.1 b/src/etc/man/cargo-help.1 index 8ff0ad22e49..655328550c0 100644 --- a/src/etc/man/cargo-help.1 +++ b/src/etc/man/cargo-help.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-help \- Get help for a Cargo command +cargo\-help \[em] Get help for a Cargo command .SH "SYNOPSIS" \fBcargo help\fR [\fIsubcommand\fR] .SH "DESCRIPTION" diff --git a/src/etc/man/cargo-init.1 b/src/etc/man/cargo-init.1 index 7ec56fb05bc..f842fcef6e0 100644 --- a/src/etc/man/cargo-init.1 +++ b/src/etc/man/cargo-init.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-init \- Create a new Cargo package in an existing directory +cargo\-init \[em] Create a new Cargo package in an existing directory .SH "SYNOPSIS" \fBcargo init\fR [\fIoptions\fR] [\fIpath\fR] .SH "DESCRIPTION" @@ -69,7 +69,7 @@ be restricted. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-install.1 b/src/etc/man/cargo-install.1 index ace8371ff37..c9d393e0e85 100644 --- a/src/etc/man/cargo-install.1 +++ b/src/etc/man/cargo-install.1 @@ -4,19 +4,19 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-install \- Build and install a Rust binary +cargo\-install \[em] Build and install a Rust binary .SH "SYNOPSIS" -\fBcargo install\fR [\fIoptions\fR] \fIcrate\fR[@\fIversion\fR]\&... +\fBcargo install\fR [\fIoptions\fR] \fIcrate\fR[@\fIversion\fR]\[u2026] .br \fBcargo install\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR .br -\fBcargo install\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\&...] +\fBcargo install\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\[u2026]] .br \fBcargo install\fR [\fIoptions\fR] \fB\-\-list\fR .SH "DESCRIPTION" -This command manages Cargo's local set of installed binary crates. Only +This command manages Cargo\[cq]s local set of installed binary crates. Only packages which have executable \fB[[bin]]\fR or \fB[[example]]\fR targets can be -installed, and all executables are installed into the installation root's +installed, and all executables are installed into the installation root\[cq]s \fBbin\fR folder. .sp The installation root is determined, in order of precedence: @@ -51,7 +51,7 @@ Crates from crates.io can optionally specify the version they wish to install via the \fB\-\-version\fR flags, and similarly packages from git repositories can optionally specify the branch, tag, or revision that should be installed. If a crate has multiple binaries, the \fB\-\-bin\fR argument can selectively install only -one of them, and if you'd rather install examples the \fB\-\-example\fR argument can +one of them, and if you\[cq]d rather install examples the \fB\-\-example\fR argument can be used as well. .sp If the package is already installed, Cargo will reinstall it if the installed @@ -159,12 +159,12 @@ such as a newer version of \fBrustc\fR\&. By default, Cargo keeps track of the installed packages with a metadata file stored in the installation root directory. This flag tells Cargo not to use or create that file. With this flag, Cargo will refuse to overwrite any existing -files unless the \fB\-\-force\fR flag is used. This also disables Cargo's ability to +files unless the \fB\-\-force\fR flag is used. This also disables Cargo\[cq]s ability to protect against multiple concurrent invocations of Cargo installing at the same time. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Install only the specified binary. .RE @@ -174,7 +174,7 @@ Install only the specified binary. Install all binaries. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Install only the specified example. .RE @@ -341,7 +341,7 @@ the build on the first one that fails to build. Unstable, requires \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. @@ -399,19 +399,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-locate-project.1 b/src/etc/man/cargo-locate-project.1 index 3dbb8b6541b..15e1f380feb 100644 --- a/src/etc/man/cargo-locate-project.1 +++ b/src/etc/man/cargo-locate-project.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-locate\-project \- Print a JSON representation of a Cargo.toml file's location +cargo\-locate\-project \[em] Print a JSON representation of a Cargo.toml file\[cq]s location .SH "SYNOPSIS" \fBcargo locate\-project\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -30,7 +30,7 @@ workspace member. The representation in which to print the project location. Valid values: .sp .RS 4 -\h'-04'\(bu\h'+02'\fBjson\fR (default): JSON object with the path under the key "root". +\h'-04'\(bu\h'+02'\fBjson\fR (default): JSON object with the path under the key \[lq]root\[rq]\&. .RE .sp .RS 4 @@ -41,7 +41,7 @@ The representation in which to print the project location. Valid values: \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-login.1 b/src/etc/man/cargo-login.1 index b51eebcc7b5..8e076cae97c 100644 --- a/src/etc/man/cargo-login.1 +++ b/src/etc/man/cargo-login.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-login \- Save an API token from the registry locally +cargo\-login \[em] Save an API token from the registry locally .SH "SYNOPSIS" \fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] .SH "DESCRIPTION" @@ -33,7 +33,7 @@ which is defined by the \fBregistry.default\fR config key which defaults to \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-metadata.1 b/src/etc/man/cargo-metadata.1 index 297cf23260a..9a7dd0fa95f 100644 --- a/src/etc/man/cargo-metadata.1 +++ b/src/etc/man/cargo-metadata.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-metadata \- Machine\-readable metadata about the current package +cargo\-metadata \[em] Machine\-readable metadata about the current package .SH "SYNOPSIS" \fBcargo metadata\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -295,7 +295,7 @@ The output has the following format: .sp \fB\-\-no\-deps\fR .RS 4 -Output information only about the workspace members and don't fetch +Output information only about the workspace members and don\[cq]t fetch dependencies. .RE .sp @@ -311,7 +311,7 @@ This filters the \fBresolve\fR output to only include dependencies for the given \fItarget triple\fR \&. Without this flag, the resolve includes all targets. .sp -Note that the dependencies listed in the "packages" array still includes all +Note that the dependencies listed in the \[lq]packages\[rq] array still includes all dependencies. Each package definition is intended to be an unaltered reproduction of the information within \fBCargo.toml\fR\&. .RE @@ -345,7 +345,7 @@ Do not activate the \fBdefault\fR feature of the selected packages. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-new.1 b/src/etc/man/cargo-new.1 index 43841001c3c..5f01bba7f59 100644 --- a/src/etc/man/cargo-new.1 +++ b/src/etc/man/cargo-new.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-new \- Create a new Cargo package +cargo\-new \[em] Create a new Cargo package .SH "SYNOPSIS" \fBcargo new\fR [\fIoptions\fR] \fIpath\fR .SH "DESCRIPTION" @@ -64,7 +64,7 @@ be restricted. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-owner.1 b/src/etc/man/cargo-owner.1 index 5436314dcca..1977aae5cca 100644 --- a/src/etc/man/cargo-owner.1 +++ b/src/etc/man/cargo-owner.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-owner \- Manage the owners of a crate on the registry +cargo\-owner \[em] Manage the owners of a crate on the registry .SH "SYNOPSIS" \fBcargo owner\fR [\fIoptions\fR] \fB\-\-add\fR \fIlogin\fR [\fIcrate\fR] .br @@ -28,13 +28,13 @@ information about owners and publishing. .SS "Owner Options" .sp \fB\-a\fR, -\fB\-\-add\fR \fIlogin\fR\&... +\fB\-\-add\fR \fIlogin\fR\[u2026] .RS 4 Invite the given user or team as an owner. .RE .sp \fB\-r\fR, -\fB\-\-remove\fR \fIlogin\fR\&... +\fB\-\-remove\fR \fIlogin\fR\[u2026] .RS 4 Remove the given user or team as an owner. .RE @@ -75,7 +75,7 @@ which is defined by the \fBregistry.default\fR config key which defaults to \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-package.1 b/src/etc/man/cargo-package.1 index 9ecf4f3f53e..c2aa20067b0 100644 --- a/src/etc/man/cargo-package.1 +++ b/src/etc/man/cargo-package.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-package \- Assemble the local package into a distributable tarball +cargo\-package \[em] Assemble the local package into a distributable tarball .SH "SYNOPSIS" \fBcargo package\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -94,7 +94,7 @@ Print files included in a package without making one. .sp \fB\-\-no\-verify\fR .RS 4 -Don't verify the contents by building them. +Don\[cq]t verify the contents by building them. .RE .sp \fB\-\-no\-metadata\fR @@ -119,8 +119,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Package only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -134,7 +134,7 @@ double quotes around each pattern. Package all members in the workspace. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -249,7 +249,7 @@ the build on the first one that fails to build. Unstable, requires \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-pkgid.1 b/src/etc/man/cargo-pkgid.1 index f836f18dd28..03cff2f4769 100644 --- a/src/etc/man/cargo-pkgid.1 +++ b/src/etc/man/cargo-pkgid.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-pkgid \- Print a fully qualified package specification +cargo\-pkgid \[em] Print a fully qualified package specification .SH "SYNOPSIS" \fBcargo pkgid\fR [\fIoptions\fR] [\fIspec\fR] .SH "DESCRIPTION" @@ -75,7 +75,7 @@ Get the package ID for the given package instead of the current package. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-publish.1 b/src/etc/man/cargo-publish.1 index 03809538d4a..8f92e47f5b6 100644 --- a/src/etc/man/cargo-publish.1 +++ b/src/etc/man/cargo-publish.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-publish \- Upload a package to the registry +cargo\-publish \[em] Upload a package to the registry .SH "SYNOPSIS" \fBcargo publish\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -59,7 +59,7 @@ of the registry in all capital letters. .sp \fB\-\-no\-verify\fR .RS 4 -Don't verify the contents by building them. +Don\[cq]t verify the contents by building them. .RE .sp \fB\-\-allow\-dirty\fR @@ -199,7 +199,7 @@ the build on the first one that fails to build. Unstable, requires \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-remove.1 b/src/etc/man/cargo-remove.1 index 8df7eaa3ec8..bc07ad23b6f 100644 --- a/src/etc/man/cargo-remove.1 +++ b/src/etc/man/cargo-remove.1 @@ -4,9 +4,9 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-remove \- Remove dependencies from a Cargo.toml manifest file +cargo\-remove \[em] Remove dependencies from a Cargo.toml manifest file .SH "SYNOPSIS" -\fBcargo remove\fR [\fIoptions\fR] \fIdependency\fR\&... +\fBcargo remove\fR [\fIoptions\fR] \fIdependency\fR\[u2026] .SH "DESCRIPTION" Remove one or more dependencies from a \fBCargo.toml\fR manifest. .SH "OPTIONS" @@ -30,14 +30,14 @@ Remove as a dependency to the \fIgiven target platform\fR \&. @@ -109,8 +109,8 @@ May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. @@ -192,19 +192,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-rustc.1 b/src/etc/man/cargo-rustc.1 index 8cc95048246..63796c5065a 100644 --- a/src/etc/man/cargo-rustc.1 +++ b/src/etc/man/cargo-rustc.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-rustc \- Compile the current package, and pass extra options to the compiler +cargo\-rustc \[em] Compile the current package, and pass extra options to the compiler .SH "SYNOPSIS" \fBcargo rustc\fR [\fIoptions\fR] [\fB\-\-\fR \fIargs\fR] .SH "DESCRIPTION" @@ -60,10 +60,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Build the package's library. +Build the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Build the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -74,7 +74,7 @@ and supports common Unix glob patterns. Build all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Build the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -85,7 +85,7 @@ and supports common Unix glob patterns. Build all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Build the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -102,7 +102,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Build the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -200,7 +200,7 @@ See the \fIthe reference\fR \&. @@ -310,19 +310,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-rustdoc.1 b/src/etc/man/cargo-rustdoc.1 index 4214b7a164f..11d3a0abaee 100644 --- a/src/etc/man/cargo-rustdoc.1 +++ b/src/etc/man/cargo-rustdoc.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-rustdoc \- Build a package's documentation, using specified custom flags +cargo\-rustdoc \[em] Build a package\[cq]s documentation, using specified custom flags .SH "SYNOPSIS" \fBcargo rustdoc\fR [\fIoptions\fR] [\fB\-\-\fR \fIargs\fR] .SH "DESCRIPTION" @@ -62,10 +62,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Document the package's library. +Document the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -76,7 +76,7 @@ and supports common Unix glob patterns. Document all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -87,7 +87,7 @@ and supports common Unix glob patterns. Document all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Document the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -104,7 +104,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Document the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -182,7 +182,7 @@ See the \fIthe reference\fR \&. @@ -278,19 +278,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-search.1 b/src/etc/man/cargo-search.1 index 1f1e08b108f..f6c748dde9e 100644 --- a/src/etc/man/cargo-search.1 +++ b/src/etc/man/cargo-search.1 @@ -4,9 +4,9 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-search \- Search packages in crates.io +cargo\-search \[em] Search packages in crates.io .SH "SYNOPSIS" -\fBcargo search\fR [\fIoptions\fR] [\fIquery\fR\&...] +\fBcargo search\fR [\fIoptions\fR] [\fIquery\fR\[u2026]] .SH "DESCRIPTION" This performs a textual search for crates on \&. The matching crates will be displayed along with their description in TOML format suitable @@ -36,7 +36,7 @@ which is defined by the \fBregistry.default\fR config key which defaults to \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-test.1 b/src/etc/man/cargo-test.1 index 02325858838..2cc443370fb 100644 --- a/src/etc/man/cargo-test.1 +++ b/src/etc/man/cargo-test.1 @@ -4,18 +4,18 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-test \- Execute unit and integration tests of a package +cargo\-test \[em] Execute unit and integration tests of a package .SH "SYNOPSIS" \fBcargo test\fR [\fIoptions\fR] [\fItestname\fR] [\fB\-\-\fR \fItest\-options\fR] .SH "DESCRIPTION" Compile and execute unit, integration, and documentation tests. .sp The test filtering argument \fBTESTNAME\fR and all the arguments following the two -dashes (\fB\-\-\fR) are passed to the test binaries and thus to \fIlibtest\fR (rustc's -built in unit\-test and micro\-benchmarking framework). If you're passing +dashes (\fB\-\-\fR) are passed to the test binaries and thus to \fIlibtest\fR (rustc\[cq]s +built in unit\-test and micro\-benchmarking framework). If you\[cq]re passing arguments to both Cargo and the binary, the ones after \fB\-\-\fR go to the binary, -the ones before go to Cargo. For details about libtest's arguments see the -output of \fBcargo test \-\- \-\-help\fR and check out the rustc book's chapter on +the ones before go to Cargo. For details about libtest\[cq]s arguments see the +output of \fBcargo test \-\- \-\-help\fR and check out the rustc book\[cq]s chapter on how tests work at \&. .sp As an example, this will filter for tests with \fBfoo\fR in their name and run them @@ -58,7 +58,7 @@ on writing doc tests. .sp \fB\-\-no\-run\fR .RS 4 -Compile, but don't run tests. +Compile, but don\[cq]t run tests. .RE .sp \fB\-\-no\-fail\-fast\fR @@ -80,8 +80,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Test only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -100,7 +100,7 @@ Test all members in the workspace. Deprecated alias for \fB\-\-workspace\fR\&. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -169,10 +169,10 @@ use single quotes or double quotes around each glob pattern. .sp \fB\-\-lib\fR .RS 4 -Test the package's library. +Test the package\[cq]s library. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Test the specified binary. This flag may be specified multiple times and supports common Unix glob patterns. @@ -183,7 +183,7 @@ and supports common Unix glob patterns. Test all binary targets. .RE .sp -\fB\-\-example\fR \fIname\fR\&... +\fB\-\-example\fR \fIname\fR\[u2026] .RS 4 Test the specified example. This flag may be specified multiple times and supports common Unix glob patterns. @@ -194,7 +194,7 @@ and supports common Unix glob patterns. Test all example targets. .RE .sp -\fB\-\-test\fR \fIname\fR\&... +\fB\-\-test\fR \fIname\fR\[u2026] .RS 4 Test the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns. @@ -211,7 +211,7 @@ Targets may be enabled or disabled by setting the \fBtest\fR flag in the manifest settings for the target. .RE .sp -\fB\-\-bench\fR \fIname\fR\&... +\fB\-\-bench\fR \fIname\fR\[u2026] .RS 4 Test the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns. @@ -235,7 +235,7 @@ Test all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests .sp \fB\-\-doc\fR .RS 4 -Test only the library's documentation. This cannot be mixed with other +Test only the library\[cq]s documentation. This cannot be mixed with other target options. .RE .SS "Feature Selection" @@ -295,7 +295,7 @@ See the \fIthe reference\fR \&. @@ -400,19 +400,19 @@ for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains -the "short" rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages -contains embedded ANSI color codes for respecting rustc's default color +contains embedded ANSI color codes for respecting rustc\[cq]s default color scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .sp .RS 4 \h'-04'\(bu\h'+02'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the -JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. .RE .RE diff --git a/src/etc/man/cargo-tree.1 b/src/etc/man/cargo-tree.1 index 2103adc6a55..5394c65e968 100644 --- a/src/etc/man/cargo-tree.1 +++ b/src/etc/man/cargo-tree.1 @@ -4,12 +4,12 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-tree \- Display a tree visualization of a dependency graph +cargo\-tree \[em] Display a tree visualization of a dependency graph .SH "SYNOPSIS" \fBcargo tree\fR [\fIoptions\fR] .SH "DESCRIPTION" This command will display a tree of dependencies to the terminal. An example -of a simple project that depends on the "rand" package: +of a simple project that depends on the \[lq]rand\[rq] package: .sp .RS 4 .nf @@ -29,12 +29,12 @@ myproject v0.1.0 (/myproject) .fi .RE .sp -Packages marked with \fB(*)\fR have been "de\-duplicated". The dependencies for the +Packages marked with \fB(*)\fR have been \[lq]de\-duplicated\[rq]\&. The dependencies for the package have already been shown elsewhere in the graph, and so are not repeated. Use the \fB\-\-no\-dedupe\fR option to repeat the duplicates. .sp The \fB\-e\fR flag can be used to select the dependency kinds to display. The -"features" kind changes the output to display the features enabled by +\[lq]features\[rq] kind changes the output to display the features enabled by each dependency. For example, \fBcargo tree \-e features\fR: .sp .RS 4 @@ -49,7 +49,7 @@ myproject v0.1.0 (/myproject) .RE .sp In this tree, \fBmyproject\fR depends on \fBlog\fR with the \fBserde\fR feature. \fBlog\fR in -turn depends on \fBcfg\-if\fR with "default" features. When using \fB\-e features\fR it +turn depends on \fBcfg\-if\fR with \[lq]default\[rq] features. When using \fB\-e features\fR it can be helpful to use \fB\-i\fR flag to show how the features flow into a package. See the examples below for more detail. .SS "Feature Unification" @@ -61,7 +61,7 @@ one of the dependency to indicate the duplicate. .sp As a result, for a mostly equivalent overview of what \fBcargo build\fR does, \fBcargo tree \-e normal,build\fR is pretty close; for a mostly equivalent overview -of what \fBcargo test\fR does, \fBcargo tree\fR is pretty close. However, it doesn't +of what \fBcargo test\fR does, \fBcargo tree\fR is pretty close. However, it doesn\[cq]t guarantee the exact equivalence to what Cargo is going to build, since a compilation is complex and depends on lots of different factors. .sp @@ -76,11 +76,11 @@ To learn more about feature unification, check out this Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package. .sp -Note that in a workspace, by default it will only display the package's +Note that in a workspace, by default it will only display the package\[cq]s reverse dependencies inside the tree of the workspace member in the current directory. The \fB\-\-workspace\fR flag can be used to extend it so that it will -show the package's reverse dependencies across the entire workspace. The \fB\-p\fR -flag can be used to display the package's reverse dependencies only with the +show the package\[cq]s reverse dependencies across the entire workspace. The \fB\-p\fR +flag can be used to display the package\[cq]s reverse dependencies only with the subtree of the package given to \fB\-p\fR\&. .RE .sp @@ -174,14 +174,14 @@ The default is the host platform. Use the value \fBall\fR to include \fIall\fR t .sp \fB\-\-charset\fR \fIcharset\fR .RS 4 -Chooses the character set to use for the tree. Valid values are "utf8" or -"ascii". Default is "utf8". +Chooses the character set to use for the tree. Valid values are \[lq]utf8\[rq] or +\[lq]ascii\[rq]\&. Default is \[lq]utf8\[rq]\&. .RE .sp \fB\-f\fR \fIformat\fR, \fB\-\-format\fR \fIformat\fR .RS 4 -Set the format string for each package. The default is "{p}". +Set the format string for each package. The default is \[lq]{p}\[rq]\&. .sp This is an arbitrary string which will be used to display each package. The following strings will be replaced with the corresponding value: @@ -203,7 +203,7 @@ strings will be replaced with the corresponding value: .RE .sp .RS 4 -\h'-04'\(bu\h'+02'\fB{lib}\fR \[em] The name, as used in a \fBuse\fR statement, of the package's library. +\h'-04'\(bu\h'+02'\fB{lib}\fR \[em] The name, as used in a \fBuse\fR statement, of the package\[cq]s library. .RE .RE .sp @@ -235,8 +235,8 @@ The default members of a workspace can be set explicitly with the virtual workspace will include all workspace members (equivalent to passing \fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Display only the specified packages. See \fBcargo\-pkgid\fR(1) for the SPEC format. This flag may be specified multiple times and supports common Unix @@ -250,7 +250,7 @@ double quotes around each pattern. Display all members in the workspace. .RE .sp -\fB\-\-exclude\fR \fISPEC\fR\&... +\fB\-\-exclude\fR \fISPEC\fR\[u2026] .RS 4 Exclude the specified packages. Must be used in conjunction with the \fB\-\-workspace\fR flag. This flag may be specified multiple times and supports @@ -324,7 +324,7 @@ Do not activate the \fBdefault\fR feature of the selected packages. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. @@ -488,13 +488,13 @@ syn v1.0.17 .RE .sp To read this graph, you can follow the chain for each feature from the root -to see why it is included. For example, the "full" feature is added by the +to see why it is included. For example, the \[lq]full\[rq] feature is added by the \fBrustversion\fR crate which is included from \fBmyproject\fR (with the default features), and \fBmyproject\fR is the package selected on the command\-line. All -of the other \fBsyn\fR features are added by the "default" feature ("quote" is -added by "printing" and "proc\-macro", both of which are default features). +of the other \fBsyn\fR features are added by the \[lq]default\[rq] feature (\[lq]quote\[rq] is +added by \[lq]printing\[rq] and \[lq]proc\-macro\[rq], both of which are default features). .sp -If you're having difficulty cross\-referencing the de\-duplicated \fB(*)\fR +If you\[cq]re having difficulty cross\-referencing the de\-duplicated \fB(*)\fR entries, try with the \fB\-\-no\-dedupe\fR flag to get the full output. .RE .SH "SEE ALSO" diff --git a/src/etc/man/cargo-uninstall.1 b/src/etc/man/cargo-uninstall.1 index b6c888f9998..d3ead109267 100644 --- a/src/etc/man/cargo-uninstall.1 +++ b/src/etc/man/cargo-uninstall.1 @@ -4,9 +4,9 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-uninstall \- Remove a Rust binary +cargo\-uninstall \[em] Remove a Rust binary .SH "SYNOPSIS" -\fBcargo uninstall\fR [\fIoptions\fR] [\fIspec\fR\&...] +\fBcargo uninstall\fR [\fIoptions\fR] [\fIspec\fR\[u2026]] .SH "DESCRIPTION" This command removes a package installed with \fBcargo\-install\fR(1). The \fIspec\fR argument is a package ID specification of the package to remove (see @@ -40,12 +40,12 @@ The installation root is determined, in order of precedence: .SS "Install Options" .sp \fB\-p\fR, -\fB\-\-package\fR \fIspec\fR\&... +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Package to uninstall. .RE .sp -\fB\-\-bin\fR \fIname\fR\&... +\fB\-\-bin\fR \fIname\fR\[u2026] .RS 4 Only uninstall the binary \fIname\fR\&. .RE @@ -59,7 +59,7 @@ Directory to uninstall packages from. \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-update.1 b/src/etc/man/cargo-update.1 index 6ca5c52d987..7f2f511b272 100644 --- a/src/etc/man/cargo-update.1 +++ b/src/etc/man/cargo-update.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-update \- Update dependencies as recorded in the local lock file +cargo\-update \[em] Update dependencies as recorded in the local lock file .SH "SYNOPSIS" \fBcargo update\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -14,8 +14,8 @@ latest available versions. .SH "OPTIONS" .SS "Update Options" .sp -\fB\-p\fR \fIspec\fR\&..., -\fB\-\-package\fR \fIspec\fR\&... +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] .RS 4 Update only the specified packages. This flag may be specified multiple times. See \fBcargo\-pkgid\fR(1) for the SPEC format. @@ -46,21 +46,21 @@ revision (such as a SHA hash or tag). \fB\-\-workspace\fR .RS 4 Attempt to update only packages defined in the workspace. Other packages -are updated only if they don't already exist in the lockfile. This -option is useful for updating \fBCargo.lock\fR after you've changed version +are updated only if they don\[cq]t already exist in the lockfile. This +option is useful for updating \fBCargo.lock\fR after you\[cq]ve changed version numbers in \fBCargo.toml\fR\&. .RE .sp \fB\-\-dry\-run\fR .RS 4 -Displays what would be updated, but doesn't actually write the lockfile. +Displays what would be updated, but doesn\[cq]t actually write the lockfile. .RE .SS "Display Options" .sp \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-vendor.1 b/src/etc/man/cargo-vendor.1 index d7fb9220b98..9caf6e6a08d 100644 --- a/src/etc/man/cargo-vendor.1 +++ b/src/etc/man/cargo-vendor.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-vendor \- Vendor all dependencies locally +cargo\-vendor \[em] Vendor all dependencies locally .SH "SYNOPSIS" \fBcargo vendor\fR [\fIoptions\fR] [\fIpath\fR] .SH "DESCRIPTION" @@ -28,7 +28,7 @@ vendored and synced to the output. May be specified multiple times. .sp \fB\-\-no\-delete\fR .RS 4 -Don't delete the "vendor" directory when vendoring, but rather keep all +Don\[cq]t delete the \[lq]vendor\[rq] directory when vendoring, but rather keep all existing contents of the vendor directory .RE .sp @@ -41,7 +41,7 @@ read it and use it when downloading crates from crates.io, for example \fB\-\-versioned\-dirs\fR .RS 4 Normally versions are only added to disambiguate multiple versions of the -same package. This option causes all directories in the "vendor" directory +same package. This option causes all directories in the \[lq]vendor\[rq] directory to be versioned, which makes it easier to track the history of vendored packages over time, and can help with the performance of re\-vendoring when only a subset of the packages have changed. @@ -87,7 +87,7 @@ May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. @@ -171,7 +171,7 @@ details on environment variables that Cargo reads. .SH "EXAMPLES" .sp .RS 4 -\h'-04' 1.\h'+01'Vendor all dependencies into a local "vendor" folder +\h'-04' 1.\h'+01'Vendor all dependencies into a local \[lq]vendor\[rq] folder .sp .RS 4 .nf @@ -181,7 +181,7 @@ cargo vendor .RE .sp .RS 4 -\h'-04' 2.\h'+01'Vendor all dependencies into a local "third\-party/vendor" folder +\h'-04' 2.\h'+01'Vendor all dependencies into a local \[lq]third\-party/vendor\[rq] folder .sp .RS 4 .nf @@ -191,7 +191,7 @@ cargo vendor third\-party/vendor .RE .sp .RS 4 -\h'-04' 3.\h'+01'Vendor the current workspace as well as another to "vendor" +\h'-04' 3.\h'+01'Vendor the current workspace as well as another to \[lq]vendor\[rq] .sp .RS 4 .nf diff --git a/src/etc/man/cargo-verify-project.1 b/src/etc/man/cargo-verify-project.1 index fe4aa0c8b75..0b419cbcf31 100644 --- a/src/etc/man/cargo-verify-project.1 +++ b/src/etc/man/cargo-verify-project.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-verify\-project \- Check correctness of crate manifest +cargo\-verify\-project \[em] Check correctness of crate manifest .SH "SYNOPSIS" \fBcargo verify\-project\fR [\fIoptions\fR] .SH "DESCRIPTION" @@ -30,7 +30,7 @@ An invalid workspace will display: \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo-version.1 b/src/etc/man/cargo-version.1 index cabd8b2d240..6f1f46303ed 100644 --- a/src/etc/man/cargo-version.1 +++ b/src/etc/man/cargo-version.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-version \- Show version information +cargo\-version \[em] Show version information .SH "SYNOPSIS" \fBcargo version\fR [\fIoptions\fR] .SH "DESCRIPTION" diff --git a/src/etc/man/cargo-yank.1 b/src/etc/man/cargo-yank.1 index 00a795a4a78..71de0ae37db 100644 --- a/src/etc/man/cargo-yank.1 +++ b/src/etc/man/cargo-yank.1 @@ -4,15 +4,15 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo\-yank \- Remove a pushed crate from the index +cargo\-yank \[em] Remove a pushed crate from the index .SH "SYNOPSIS" \fBcargo yank\fR [\fIoptions\fR] \fIcrate\fR@\fIversion\fR .br \fBcargo yank\fR [\fIoptions\fR] \fB\-\-version\fR \fIversion\fR [\fIcrate\fR] .SH "DESCRIPTION" -The yank command removes a previously published crate's version from the -server's index. This command does not delete any data, and the crate will -still be available for download via the registry's download link. +The yank command removes a previously published crate\[cq]s version from the +server\[cq]s index. This command does not delete any data, and the crate will +still be available for download via the registry\[cq]s download link. .sp Note that existing crates locked to a yanked version will still be able to download the yanked version to use it. Cargo will, however, not allow any new @@ -67,7 +67,7 @@ which is defined by the \fBregistry.default\fR config key which defaults to \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. diff --git a/src/etc/man/cargo.1 b/src/etc/man/cargo.1 index 571e52f1fc0..ee9715d2b63 100644 --- a/src/etc/man/cargo.1 +++ b/src/etc/man/cargo.1 @@ -4,7 +4,7 @@ .ad l .ss \n[.ss] 0 .SH "NAME" -cargo \- The Rust package manager +cargo \[em] The Rust package manager .SH "SYNOPSIS" \fBcargo\fR [\fIoptions\fR] \fIcommand\fR [\fIargs\fR] .br @@ -38,7 +38,7 @@ available at \&. .sp \fBcargo\-doc\fR(1) .br -\ \ \ \ Build a package's documentation. +\ \ \ \ Build a package\[cq]s documentation. .sp \fBcargo\-fetch\fR(1) .br @@ -58,7 +58,7 @@ available at \&. .sp \fBcargo\-rustdoc\fR(1) .br -\ \ \ \ Build a package's documentation, using specified custom flags. +\ \ \ \ Build a package\[cq]s documentation, using specified custom flags. .sp \fBcargo\-test\fR(1) .br @@ -70,7 +70,7 @@ available at \&. .sp \fBcargo\-locate\-project\fR(1) .br -\ \ \ \ Print a JSON representation of a \fBCargo.toml\fR file's location. +\ \ \ \ Print a JSON representation of a \fBCargo.toml\fR file\[cq]s location. .sp \fBcargo\-metadata\fR(1) .br @@ -169,7 +169,7 @@ error message (for example, \fBE0004\fR). \fB\-v\fR, \fB\-\-verbose\fR .RS 4 -Use verbose output. May be specified twice for "very verbose" output which +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which includes extra output such as dependency warnings and build script output. May also be specified with the \fBterm.verbose\fR \fIconfig value\fR \&. @@ -283,7 +283,7 @@ details on environment variables that Cargo reads. .SH "FILES" \fB~/.cargo/\fR .br -\ \ \ \ Default location for Cargo's "home" directory where it +\ \ \ \ Default location for Cargo\[cq]s \[lq]home\[rq] directory where it stores various files. The location can be changed with the \fBCARGO_HOME\fR environment variable. .sp @@ -372,7 +372,7 @@ cargo init . .RE .sp .RS 4 -\h'-04' 6.\h'+01'Learn about a command's options and usage: +\h'-04' 6.\h'+01'Learn about a command\[cq]s options and usage: .sp .RS 4 .nf