docs: Present other environment variable alternatives to crate_name!
#4514
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`crate_name!` macro uses a value of an environment variable `CARGO_PKG_NAME`, but there are other similar variables `CARGO_PKG_NAME` and `CARGO_CRATE_NAME`, that users should be aware of.
noritada
changed the title
CARGO_CRATE_NAME and CARGO_BIN_NAME as alternatives to crate_name!CARGO_CRATE_NAME and CARGO_BIN_NAME as alternatives to crate_name!
noritada
force-pushed
the
notes-on-cargo-env-vars
branch
2 times, most recently
from
56e7db7
to
b3ef28c
Compare
noritada
changed the title
CARGO_CRATE_NAME and CARGO_BIN_NAME as alternatives to crate_name!crate_name!
noritada
force-pushed
the
notes-on-cargo-env-vars
branch
from
b3ef28c
to
e2501ef
Compare
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR will add a note to the description on
crate_name!macro about where the name in the output come from.There are 3 name-related environment variables in cargo,
CARGO_PKG_NAME,CARGO_CRATE_NAME, andCARGO_BIN_NAME, and thecrate_name!macro uses the 1st one among them. This means thatfoois used as the name in the case of Cargo.toml as shown below:Since the
crate_*macros are under consideration for deprecation in #2840, and changing the source to another environment variable would result in the behavior change, I think it would be best to add a note to the documentation.If you have suggestions, I would appreciate it.
Thank you very much.