itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add an explanation of CARGO_PKG_README

Browse Source
This commit is contained in:
chansuke 2023-01-28 18:59:41 +09:00
parent 5531cd3806
commit ec8aa3e8d5
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/doc/src/reference/environment-variables.md
View File

@ -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. * `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 Note that this is the minimum Rust version supported by the package, not the
current Rust version. 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_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_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 Only set for [binaries] or binary [examples]. This name does not include any
file extension, such as `.exe`. 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. script should place its output. See below for more information.
(Only set during compilation.) (Only set during compilation.)
* `CARGO_BIN_EXE_<name>` --- The absolute path to a binary target's executable. * `CARGO_BIN_EXE_<name>` --- The absolute path to a binary target's executable.