Skip to content

Commit cb9de44

Browse files
committed
Auto merge of #7799 - ehuss:consistent-dash, r=alexcrichton
Consistently use em-dash in environment documentation page.
2 parents 0a4ec29 + 9088706 commit cb9de44

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

src/doc/src/reference/environment-variables.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -152,19 +152,19 @@ let version = env!("CARGO_PKG_VERSION");
152152

153153
`version` will now contain the value of `CARGO_PKG_VERSION`.
154154

155-
* `CARGO` - Path to the `cargo` binary performing the build.
156-
* `CARGO_MANIFEST_DIR` - The directory containing the manifest of your package.
157-
* `CARGO_PKG_VERSION` - The full version of your package.
158-
* `CARGO_PKG_VERSION_MAJOR` - The major version of your package.
159-
* `CARGO_PKG_VERSION_MINOR` - The minor version of your package.
160-
* `CARGO_PKG_VERSION_PATCH` - The patch version of your package.
161-
* `CARGO_PKG_VERSION_PRE` - The pre-release version of your package.
162-
* `CARGO_PKG_AUTHORS` - Colon separated list of authors from the manifest of your package.
163-
* `CARGO_PKG_NAME` - The name of your package.
164-
* `CARGO_PKG_DESCRIPTION` - The description from the manifest of your package.
165-
* `CARGO_PKG_HOMEPAGE` - The home page from the manifest of your package.
166-
* `CARGO_PKG_REPOSITORY` - The repository from the manifest of your package.
167-
* `OUT_DIR` - If the package has a build script, this is set to the folder where the build
155+
* `CARGO` Path to the `cargo` binary performing the build.
156+
* `CARGO_MANIFEST_DIR` The directory containing the manifest of your package.
157+
* `CARGO_PKG_VERSION` The full version of your package.
158+
* `CARGO_PKG_VERSION_MAJOR` The major version of your package.
159+
* `CARGO_PKG_VERSION_MINOR` The minor version of your package.
160+
* `CARGO_PKG_VERSION_PATCH` The patch version of your package.
161+
* `CARGO_PKG_VERSION_PRE` The pre-release version of your package.
162+
* `CARGO_PKG_AUTHORS` Colon separated list of authors from the manifest of your package.
163+
* `CARGO_PKG_NAME` The name of your package.
164+
* `CARGO_PKG_DESCRIPTION` The description from the manifest of your package.
165+
* `CARGO_PKG_HOMEPAGE` The home page from the manifest of your package.
166+
* `CARGO_PKG_REPOSITORY` The repository from the manifest of your package.
167+
* `OUT_DIR` If the package has a build script, this is set to the folder where the build
168168
script should place its output. See below for more information.
169169
(Only set during compilation.)
170170

@@ -208,18 +208,18 @@ let out_dir = env::var("OUT_DIR").unwrap();
208208

209209
`out_dir` will now contain the value of `OUT_DIR`.
210210

211-
* `CARGO` - Path to the `cargo` binary performing the build.
212-
* `CARGO_MANIFEST_DIR` - The directory containing the manifest for the package
211+
* `CARGO` Path to the `cargo` binary performing the build.
212+
* `CARGO_MANIFEST_DIR` The directory containing the manifest for the package
213213
being built (the package containing the build
214214
script). Also note that this is the value of the
215215
current working directory of the build script when it
216216
starts.
217-
* `CARGO_MANIFEST_LINKS` - the manifest `links` value.
218-
* `CARGO_FEATURE_<name>` - For each activated feature of the package being
217+
* `CARGO_MANIFEST_LINKS` the manifest `links` value.
218+
* `CARGO_FEATURE_<name>` For each activated feature of the package being
219219
built, this environment variable will be present
220220
where `<name>` is the name of the feature uppercased
221221
and having `-` translated to `_`.
222-
* `CARGO_CFG_<cfg>` - For each [configuration option][configuration] of the
222+
* `CARGO_CFG_<cfg>` For each [configuration option][configuration] of the
223223
package being built, this environment variable will contain the value of the
224224
configuration, where `<cfg>` is the name of the configuration uppercased and
225225
having `-` translated to `_`. Boolean configurations are present if they are
@@ -238,14 +238,14 @@ let out_dir = env::var("OUT_DIR").unwrap();
238238
* `CARGO_CFG_TARGET_POINTER_WIDTH=64` — The CPU [pointer width].
239239
* `CARGO_CFG_TARGET_ENDIAN=little` — The CPU [target endianness].
240240
* `CARGO_CFG_TARGET_FEATURE=mmx,sse` — List of CPU [target features] enabled.
241-
* `OUT_DIR` - the folder in which all output should be placed. This folder is
241+
* `OUT_DIR` the folder in which all output should be placed. This folder is
242242
inside the build directory for the package being built, and it is
243243
unique for the package in question.
244-
* `TARGET` - the target triple that is being compiled for. Native code should be
244+
* `TARGET` the target triple that is being compiled for. Native code should be
245245
compiled for this triple. See the [Target Triple] description
246246
for more information.
247-
* `HOST` - the host triple of the rust compiler.
248-
* `NUM_JOBS` - the parallelism specified as the top-level parallelism. This can
247+
* `HOST` the host triple of the rust compiler.
248+
* `NUM_JOBS` the parallelism specified as the top-level parallelism. This can
249249
be useful to pass a `-j` parameter to a system like `make`. Note
250250
that care should be taken when interpreting this environment
251251
variable. For historical purposes this is still provided but
@@ -254,15 +254,15 @@ let out_dir = env::var("OUT_DIR").unwrap();
254254
[jobserver] and will allow build scripts to inherit this
255255
information, so programs compatible with GNU make jobservers will
256256
already have appropriately configured parallelism.
257-
* `OPT_LEVEL`, `DEBUG` - values of the corresponding variables for the
257+
* `OPT_LEVEL`, `DEBUG` values of the corresponding variables for the
258258
profile currently being built.
259-
* `PROFILE` - `release` for release builds, `debug` for other builds.
260-
* `DEP_<name>_<key>` - For more information about this set of environment
259+
* `PROFILE` `release` for release builds, `debug` for other builds.
260+
* `DEP_<name>_<key>` For more information about this set of environment
261261
variables, see build script documentation about [`links`][links].
262-
* `RUSTC`, `RUSTDOC` - the compiler and documentation generator that Cargo has
262+
* `RUSTC`, `RUSTDOC` the compiler and documentation generator that Cargo has
263263
resolved to use, passed to the build script so it might
264264
use it as well.
265-
* `RUSTC_LINKER` - The path to the linker binary that Cargo has resolved to use
265+
* `RUSTC_LINKER` The path to the linker binary that Cargo has resolved to use
266266
for the current target, if specified. The linker can be
267267
changed by editing `.cargo/config`; see the documentation
268268
about [cargo configuration][cargo-config] for more
@@ -289,4 +289,4 @@ let out_dir = env::var("OUT_DIR").unwrap();
289289
Cargo exposes this environment variable to 3rd party subcommands
290290
(ie. programs named `cargo-foobar` placed in `$PATH`):
291291

292-
* `CARGO` - Path to the `cargo` binary performing the build.
292+
* `CARGO` Path to the `cargo` binary performing the build.

0 commit comments

Comments
 (0)