Skip to content

Commit 3153855

Browse files
committed
Ensure em dashes are recognizable in markup.
1 parent 678de60 commit 3153855

Some content is hidden

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

89 files changed

+444
-444
lines changed

src/doc/contrib/src/architecture/codebase.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,106 +3,106 @@
33
This is a very high-level overview of the Cargo codebase.
44

55
* [`src/bin/cargo`](https://github.com/rust-lang/cargo/tree/master/src/bin/cargo)
6-
Cargo is split in a library and a binary. This is the binary side that
6+
--- Cargo is split in a library and a binary. This is the binary side that
77
handles argument parsing, and then calls into the library to perform the
88
appropriate subcommand. Each Cargo subcommand is a separate module here. See
99
[SubCommands](subcommands.md).
1010

1111
* [`src/cargo/ops`](https://github.com/rust-lang/cargo/tree/master/src/cargo/ops)
12-
Every major operation is implemented here. This is where the binary CLI
12+
--- Every major operation is implemented here. This is where the binary CLI
1313
usually calls into to perform the appropriate action.
1414

1515
* [`src/cargo/ops/cargo_compile/mod.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/ops/cargo_compile/mod.rs)
16-
This is the entry point for all the compilation commands. This is a
16+
--- This is the entry point for all the compilation commands. This is a
1717
good place to start if you want to follow how compilation starts and
1818
flows to completion.
1919

2020
* [`src/cargo/core/resolver`](https://github.com/rust-lang/cargo/tree/master/src/cargo/core/resolver)
21-
This is the dependency and feature resolvers.
21+
--- This is the dependency and feature resolvers.
2222

2323
* [`src/cargo/core/compiler`](https://github.com/rust-lang/cargo/tree/master/src/cargo/core/compiler)
24-
This is the code responsible for running `rustc` and `rustdoc`.
24+
--- This is the code responsible for running `rustc` and `rustdoc`.
2525

2626
* [`src/cargo/core/compiler/build_context/mod.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/build_context/mod.rs)
27-
The `BuildContext` is the result of the "front end" of the build
27+
--- The `BuildContext` is the result of the "front end" of the build
2828
process. This contains the graph of work to perform and any settings
2929
necessary for `rustc`. After this is built, the next stage of building
3030
is handled in `Context`.
3131

3232
* [`src/cargo/core/compiler/context`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/context/mod.rs)
33-
The `Context` is the mutable state used during the build process. This
33+
--- The `Context` is the mutable state used during the build process. This
3434
is the core of the build process, and everything is coordinated through
3535
this.
3636

3737
* [`src/cargo/core/compiler/fingerprint.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/compiler/fingerprint.rs)
38-
The `fingerprint` module contains all the code that handles detecting
38+
--- The `fingerprint` module contains all the code that handles detecting
3939
if a crate needs to be recompiled.
4040

4141
* [`src/cargo/core/source`](https://github.com/rust-lang/cargo/tree/master/src/cargo/core/source)
42-
The `Source` trait is an abstraction over different sources of packages.
42+
--- The `Source` trait is an abstraction over different sources of packages.
4343
Sources are uniquely identified by a `SourceId`. Sources are implemented in
4444
the
4545
[`src/cargo/sources`](https://github.com/rust-lang/cargo/tree/master/src/cargo/sources)
4646
directory.
4747

4848
* [`src/cargo/util`](https://github.com/rust-lang/cargo/tree/master/src/cargo/util)
49-
This directory contains generally-useful utility modules.
49+
--- This directory contains generally-useful utility modules.
5050

5151
* [`src/cargo/util/config`](https://github.com/rust-lang/cargo/tree/master/src/cargo/util/config)
52-
This directory contains the config parser. It makes heavy use of
52+
--- This directory contains the config parser. It makes heavy use of
5353
[serde](https://serde.rs/) to merge and translate config values. The
5454
`Config` is usually accessed from the
5555
[`Workspace`](https://github.com/rust-lang/cargo/blob/master/src/cargo/core/workspace.rs),
5656
though references to it are scattered around for more convenient access.
5757

5858
* [`src/cargo/util/toml`](https://github.com/rust-lang/cargo/tree/master/src/cargo/util/toml)
59-
This directory contains the code for parsing `Cargo.toml` files.
59+
--- This directory contains the code for parsing `Cargo.toml` files.
6060

6161
* [`src/cargo/ops/lockfile.rs`](https://github.com/rust-lang/cargo/blob/master/src/cargo/ops/lockfile.rs)
62-
This is where `Cargo.lock` files are loaded and saved.
62+
--- This is where `Cargo.lock` files are loaded and saved.
6363

6464
* [`src/doc`](https://github.com/rust-lang/cargo/tree/master/src/doc)
65-
This directory contains Cargo's documentation and man pages.
65+
--- This directory contains Cargo's documentation and man pages.
6666

6767
* [`src/etc`](https://github.com/rust-lang/cargo/tree/master/src/etc)
68-
These are files that get distributed in the `etc` directory in the Rust release.
68+
--- These are files that get distributed in the `etc` directory in the Rust release.
6969
The man pages are auto-generated by a script in the `src/doc` directory.
7070

7171
* [`crates`](https://github.com/rust-lang/cargo/tree/master/crates)
72-
A collection of independent crates used by Cargo.
72+
--- A collection of independent crates used by Cargo.
7373

7474
## Extra crates
7575

7676
Some functionality is split off into separate crates, usually in the
7777
[`crates`](https://github.com/rust-lang/cargo/tree/master/crates) directory.
7878

7979
* [`cargo-platform`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-platform)
80-
This library handles parsing `cfg` expressions.
80+
--- This library handles parsing `cfg` expressions.
8181
* [`cargo-test-macro`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-test-macro)
82-
This is a proc-macro used by the test suite to define tests. More
82+
--- This is a proc-macro used by the test suite to define tests. More
8383
information can be found at [`cargo_test`
8484
attribute](../tests/writing.md#cargo_test-attribute).
8585
* [`cargo-test-support`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-test-support)
86-
This contains a variety of code to support [writing
86+
--- This contains a variety of code to support [writing
8787
tests](../tests/writing.md).
8888
* [`cargo-util`](https://github.com/rust-lang/cargo/tree/master/crates/cargo-util)
89-
This contains general utility code that is shared between cargo and the
89+
--- This contains general utility code that is shared between cargo and the
9090
testsuite.
9191
* [`crates-io`](https://github.com/rust-lang/cargo/tree/master/crates/crates-io)
92-
This contains code for accessing the crates.io API.
92+
--- This contains code for accessing the crates.io API.
9393
* [`credential`](https://github.com/rust-lang/cargo/tree/master/crates/credential)
94-
This subdirectory contains several packages for implementing the
94+
--- This subdirectory contains several packages for implementing the
9595
experimental
9696
[credential-process](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#credential-process)
9797
feature.
98-
* [`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.
98+
* [`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.
9999
This is not directly depended upon with a `path` dependency; cargo uses the version from crates.io.
100100
It is intended to be versioned and published independently of Rust's release system.
101101
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.
102-
* [`mdman`](https://github.com/rust-lang/cargo/tree/master/crates/mdman)
103-
This is a utility for generating cargo's man pages. See [Building the man
102+
* [`mdman`](https://github.com/rust-lang/cargo/tree/master/crates/mdman)
103+
--- This is a utility for generating cargo's man pages. See [Building the man
104104
pages](https://github.com/rust-lang/cargo/tree/master/src/doc#building-the-man-pages)
105105
for more information.
106106
* [`resolver-tests`](https://github.com/rust-lang/cargo/tree/master/crates/resolver-tests)
107-
This is a dedicated package that defines tests for the [dependency
107+
--- This is a dedicated package that defines tests for the [dependency
108108
resolver](../architecture/packages.md#resolver).

src/doc/contrib/src/architecture/packages.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,27 @@ actually compiled by `rustc`.
1616
There are several data structures that are important to understand how
1717
packages are found and loaded:
1818

19-
* [`Package`] A package, which is a `Cargo.toml` manifest and its associated
19+
* [`Package`] --- A package, which is a `Cargo.toml` manifest and its associated
2020
source files.
21-
* [`PackageId`] A unique identifier for a package.
22-
* [`Source`] An abstraction for something that can fetch packages (a remote
21+
* [`PackageId`] --- A unique identifier for a package.
22+
* [`Source`] --- An abstraction for something that can fetch packages (a remote
2323
registry, a git repo, the local filesystem, etc.). Check out the [source
2424
implementations] for all the details about registries, indexes, git
2525
dependencies, etc.
26-
* [`SourceId`] A unique identifier for a source.
27-
* [`SourceMap`] Map of all available sources.
28-
* [`PackageRegistry`] This is the main interface for how the dependency
26+
* [`SourceId`] --- A unique identifier for a source.
27+
* [`SourceMap`] --- Map of all available sources.
28+
* [`PackageRegistry`] --- This is the main interface for how the dependency
2929
resolver finds packages. It contains the `SourceMap`, and handles things
3030
like the `[patch]` table. The `Registry` trait provides a generic interface
3131
to the `PackageRegistry`, but this is only used for providing an alternate
3232
implementation of the `PackageRegistry` for testing. The dependency resolver
3333
sends a query to the `PackageRegistry` to "get me all packages that match
3434
this dependency declaration".
35-
* [`Summary`] A summary is a subset of a [`Manifest`], and is essentially
35+
* [`Summary`] --- A summary is a subset of a [`Manifest`], and is essentially
3636
the information that can be found in a registry index. Queries against the
3737
`PackageRegistry` yields a `Summary`. The resolver uses the summary
3838
information to build the dependency graph.
39-
* [`PackageSet`] Contains all of the `Package` objects. This works with the
39+
* [`PackageSet`] --- Contains all of the `Package` objects. This works with the
4040
[`Downloads`] struct to coordinate downloading packages. It has a reference
4141
to the `SourceMap` to get the `Source` objects which tell the `Downloads`
4242
struct which URLs to fetch.

src/doc/contrib/src/issues.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ If you file in the wrong tracker, someone will either transfer it to the
2626
correct one or ask you to move it. Some other repositories that may be
2727
relevant are:
2828

29-
* [`rust-lang/rust`] Home for the [`rustc`] compiler and [`rustdoc`].
30-
* [`rust-lang/rustup`] Home for the [`rustup`] toolchain installer.
31-
* [`rust-lang/rustfmt`] Home for the `rustfmt` tool, which also includes `cargo fmt`.
32-
* [`rust-lang/rust-clippy`] Home for the `clippy` tool, which also includes `cargo clippy`.
33-
* [`rust-lang/crates.io`] Home for the [crates.io] website.
29+
* [`rust-lang/rust`] --- Home for the [`rustc`] compiler and [`rustdoc`].
30+
* [`rust-lang/rustup`] --- Home for the [`rustup`] toolchain installer.
31+
* [`rust-lang/rustfmt`] --- Home for the `rustfmt` tool, which also includes `cargo fmt`.
32+
* [`rust-lang/rust-clippy`] --- Home for the `clippy` tool, which also includes `cargo clippy`.
33+
* [`rust-lang/crates.io`] --- Home for the [crates.io] website.
3434

3535
Issues with [`cargo fix`] can be tricky to know where they should be filed,
3636
since the fixes are driven by `rustc`, processed by [`rustfix`], and the

src/doc/contrib/src/tests/writing.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,34 +77,34 @@ They are listed in parentheses separated with commas, such as:
7777

7878
The options it supports are:
7979

80-
* `nightly` This will cause the test to be ignored if not running on the nightly toolchain.
80+
* `nightly` --- This will cause the test to be ignored if not running on the nightly toolchain.
8181
This is useful for tests that use unstable options in `rustc` or `rustdoc`.
8282
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.
8383
A `reason` field is required to explain why it is nightly-only.
84-
* `build_std_real` This is a "real" `-Zbuild-std` test (in the `build_std` integration test).
84+
* `build_std_real` --- This is a "real" `-Zbuild-std` test (in the `build_std` integration test).
8585
This only runs on nightly, and only if the environment variable `CARGO_RUN_BUILD_STD_TESTS` is set (these tests on run on Linux).
86-
* `build_std_mock` This is a "mock" `-Zbuild-std` test (which uses a mock standard library).
86+
* `build_std_mock` --- This is a "mock" `-Zbuild-std` test (which uses a mock standard library).
8787
This only runs on nightly, and is disabled for windows-gnu.
88-
* `requires_` This indicates a command that is required to be installed to be run.
88+
* `requires_` --- This indicates a command that is required to be installed to be run.
8989
For example, `requires_rustfmt` means the test will only run if the executable `rustfmt` is installed.
9090
These tests are *always* run on CI.
9191
This is mainly used to avoid requiring contributors from having every dependency installed.
92-
* `>=1.64` This indicates that the test will only run with the given version of `rustc` or newer.
92+
* `>=1.64` --- This indicates that the test will only run with the given version of `rustc` or newer.
9393
This can be used when a new `rustc` feature has been stabilized that the test depends on.
9494
If this is specified, a `reason` is required to explain why it is being checked.
95-
* `public_network_test` This tests contacts the public internet.
95+
* `public_network_test` --- This tests contacts the public internet.
9696
These tests are disabled unless the `CARGO_PUBLIC_NETWORK_TESTS` environment variable is set.
9797
Use of this should be *extremely rare*, please avoid using it if possible.
9898
The hosts it contacts should have a relatively high confidence that they are reliable and stable (such as github.com), especially in CI.
9999
The tests should be carefully considered for developer security and privacy as well.
100-
* `container_test` This indicates that it is a test that uses Docker.
100+
* `container_test` --- This indicates that it is a test that uses Docker.
101101
These tests are disabled unless the `CARGO_CONTAINER_TESTS` environment variable is set.
102102
This requires that you have Docker installed.
103103
The SSH tests also assume that you have OpenSSH installed.
104104
These should work on Linux, macOS, and Windows where possible.
105105
Unfortunately these tests are not run in CI for macOS or Windows (no Docker on macOS, and Windows does not support Linux images).
106106
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.
107-
* `ignore_windows="reason"` Indicates that the test should be ignored on windows for the given reason.
107+
* `ignore_windows="reason"` --- Indicates that the test should be ignored on windows for the given reason.
108108

109109
#### Testing Nightly Features
110110

src/doc/man/cargo-add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-add - Add dependencies to a Cargo.toml manifest file
7+
cargo-add --- Add dependencies to a Cargo.toml manifest file
88

99
## SYNOPSIS
1010

src/doc/man/cargo-bench.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## NAME
77

8-
cargo-bench - Execute benchmarks of a package
8+
cargo-bench --- Execute benchmarks of a package
99

1010
## SYNOPSIS
1111

@@ -69,7 +69,7 @@ debugger.
6969
When no target selection options are given, `cargo bench` will build the
7070
following targets of the selected packages:
7171

72-
- lib used to link with binaries and benchmarks
72+
- lib --- used to link with binaries and benchmarks
7373
- bins (only if benchmark targets are built and required features are
7474
available)
7575
- lib as a benchmark

src/doc/man/cargo-build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-build - Compile the current package
7+
cargo-build --- Compile the current package
88

99
## SYNOPSIS
1010

src/doc/man/cargo-check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-check - Check the current package
7+
cargo-check --- Check the current package
88

99
## SYNOPSIS
1010

src/doc/man/cargo-clean.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-clean - Remove generated artifacts
7+
cargo-clean --- Remove generated artifacts
88

99
## SYNOPSIS
1010

src/doc/man/cargo-doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-doc - Build a package's documentation
7+
cargo-doc --- Build a package's documentation
88

99
## SYNOPSIS
1010

src/doc/man/cargo-fetch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## NAME
77

8-
cargo-fetch - Fetch dependencies of a package from the network
8+
cargo-fetch --- Fetch dependencies of a package from the network
99

1010
## SYNOPSIS
1111

src/doc/man/cargo-fix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-fix - Automatically fix lint warnings reported by rustc
7+
cargo-fix --- Automatically fix lint warnings reported by rustc
88

99
## SYNOPSIS
1010

src/doc/man/cargo-generate-lockfile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-generate-lockfile - Generate the lockfile for a package
5+
cargo-generate-lockfile --- Generate the lockfile for a package
66

77
## SYNOPSIS
88

src/doc/man/cargo-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-help - Get help for a Cargo command
5+
cargo-help --- Get help for a Cargo command
66

77
## SYNOPSIS
88

src/doc/man/cargo-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-init - Create a new Cargo package in an existing directory
5+
cargo-init --- Create a new Cargo package in an existing directory
66

77
## SYNOPSIS
88

src/doc/man/cargo-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## NAME
66

7-
cargo-install - Build and install a Rust binary
7+
cargo-install --- Build and install a Rust binary
88

99
## SYNOPSIS
1010

src/doc/man/cargo-locate-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-locate-project - Print a JSON representation of a Cargo.toml file's location
5+
cargo-locate-project --- Print a JSON representation of a Cargo.toml file's location
66

77
## SYNOPSIS
88

src/doc/man/cargo-login.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-login - Save an API token from the registry locally
5+
cargo-login --- Save an API token from the registry locally
66

77
## SYNOPSIS
88

src/doc/man/cargo-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-metadata - Machine-readable metadata about the current package
5+
cargo-metadata --- Machine-readable metadata about the current package
66

77
## SYNOPSIS
88

src/doc/man/cargo-new.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-new - Create a new Cargo package
5+
cargo-new --- Create a new Cargo package
66

77
## SYNOPSIS
88

src/doc/man/cargo-owner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## NAME
44

5-
cargo-owner - Manage the owners of a crate on the registry
5+
cargo-owner --- Manage the owners of a crate on the registry
66

77
## SYNOPSIS
88

src/doc/man/cargo-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
## NAME
77

8-
cargo-package - Assemble the local package into a distributable tarball
8+
cargo-package --- Assemble the local package into a distributable tarball
99

1010
## SYNOPSIS
1111

0 commit comments

Comments
 (0)