Add an explanation of CARGO_PKG_README

rust-lang · Mar 3, 2023 · ec8aa3e · ec8aa3e
1 parent 5531cd3
commit ec8aa3e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/doc/src/reference/environment-variables.md b/src/doc/src/reference/environment-variables.md
@@ -231,11 +231,12 @@ corresponding environment variable is set to the empty string, `""`.
 * `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_PKG_README` — The location of README of your package.
 * `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_<name>` --- The absolute path to a binary target's executable.