fix(docs): Document the only possible values for DEBUG in build scripts #16413
Conversation
This file contains hidden or 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
rustbot
added
A-documenting-cargo-itself
Collaborator
epage
reviewed
Dec 17, 2025
| content of `CARGO_MAKEFLAGS` to activate the use of Cargo's GNU Make compatible | ||
| [jobserver] for sub-make invocations. | ||
| * `OPT_LEVEL`, `DEBUG` --- values of the corresponding variables for the profile currently being built. | ||
| * `DEBUG` --- `true` or `false`. `false` corresponds to when the debug profile setting is `0`, `false`, or `"none"`. |
Contributor
There was a problem hiding this comment.
We should probably state something like "all other values map to true"
Alternatively, we could adopt language from the doc comment
/// Returns true if any debuginfo will be generated. Helper
/// for a common operation on the usual `Option` representation.
and say
trueif any debug information will be generated andfalseotherwise
or appended to the existing comment
otherwise
trueindicating debug information will be generated
Contributor
Author
There was a problem hiding this comment.
Thanks, it's probably good to not replicate the possible profile values here.
epage
reviewed
Dec 17, 2025
Comment on lines
380
to
381
| * `DEBUG` --- `true` or `false`. `false` corresponds to when the debug profile setting is `0`, `false`, or `"none"`. | ||
| * `OPT_LEVEL` --- values of the corresponding variable for the profile currently being built. |
Contributor
There was a problem hiding this comment.
With us splitting these up, we should probably link to the relevant content
Contributor
|
Thanks for working to improve the documentation! |
dawedawe
force-pushed
the
docs_fix_debug_env
branch
from
01de08b to
6ede179
Compare
epage
approved these changes
Dec 18, 2025
Contributor
|
Thanks! |
rustbot
removed
the
S-waiting-on-review
bors
added a commit
to rust-lang/rust
that referenced
this pull request
Dec 20, 2025
Update cargo submodule 13 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..3861f60f6b58f57524c0e7aab1f5c1ad83e35409 2025-12-13 16:29:21 +0000 to 2025-12-19 21:53:33 +0000 - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
github-actions bot
pushed a commit
to rust-lang/miri
that referenced
this pull request
Dec 21, 2025
Update cargo submodule 13 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..3861f60f6b58f57524c0e7aab1f5c1ad83e35409 2025-12-13 16:29:21 +0000 to 2025-12-19 21:53:33 +0000 - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
bors
added a commit
to rust-lang/rust
that referenced
this pull request
Dec 27, 2025
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
github-actions bot
pushed a commit
to rust-lang/compiler-builtins
that referenced
this pull request
Dec 28, 2025
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
github-actions bot
pushed a commit
to rust-lang/miri
that referenced
this pull request
Dec 28, 2025
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
github-actions bot
pushed a commit
to rust-lang/rustc-dev-guide
that referenced
this pull request
Dec 29, 2025
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
Kobzol
pushed a commit
to Kobzol/rustc_codegen_cranelift
that referenced
this pull request
Dec 29, 2025
Update cargo submodule 13 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..3861f60f6b58f57524c0e7aab1f5c1ad83e35409 2025-12-13 16:29:21 +0000 to 2025-12-19 21:53:33 +0000 - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
Kobzol
pushed a commit
to Kobzol/rustc_codegen_cranelift
that referenced
this pull request
Dec 29, 2025
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
github-actions bot
pushed a commit
to rust-lang/stdarch
that referenced
this pull request
Jan 1, 2026
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
github-actions bot
pushed a commit
to rust-lang/rust-analyzer
that referenced
this pull request
Jan 8, 2026
Update cargo submodule 17 commits in e91b2baa632c0c7e84216c91ecfe107c37d887c1..94c368ad2b9db0f0da5bdd8421cea13786ce4412 2025-12-13 16:29:21 +0000 to 2025-12-26 19:39:15 +0000 - fix(vendor): unpack from local-registry cache path (rust-lang/cargo#16435) - feat(index): Stabilize pubtime (rust-lang/cargo#16372) - Experiment: Render timing pipeline in SVG (rust-lang/cargo#15091) - chore(triagebot): auto-label `Command-report` (rust-lang/cargo#16429) - fix(sbom): Don't set CARGO_SBOM_PATH when empty (like stable) (rust-lang/cargo#16419) - chore(ci): report-timings to upload HTML report (rust-lang/cargo#16416) - fix(report): get the same feature parity of `--timings` (rust-lang/cargo#16414) - fix(docs): Document the only possible values for DEBUG in build scripts (rust-lang/cargo#16413) - fix(log): emit fingeprint log also for no-rebuild unit (rust-lang/cargo#16408) - Fix link to `doc_cfg` docs in cargo book (rust-lang/cargo#16404) - Add best pratice for how to check in generated files (rust-lang/cargo#16405) - test: Use a larger default term width (rust-lang/cargo#16403) - Document more services and permissions of the cargo team (rust-lang/cargo#16402) - fix(new): Improve quality of package name error messages (rust-lang/cargo#16398) - feat(log): add more log events (rust-lang/cargo#16390) - chore: bump to 0.95.0; update changelog (rust-lang/cargo#16395) - Cache submodule into git db (rust-lang/cargo#16246) r? ghost
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this PR try to resolve?
fixes #16363 by splitting the documentation of
DEBUGandOPT_LEVELand listing the only possible values forDEBUGas commented by ehuss. (I hope it's okay to just take your comment as documentation 😄 )How to test and review this PR?
With
mdbook build --openfor example.