indicate full hierarchy of config option (#1776)

This commit is contained in:
Tshepang Mbambo 2023-08-27 02:58:31 +02:00 committed by GitHub
parent 075c46f496
commit 5264530f0b
1 changed files with 6 additions and 6 deletions

View File

@ -56,14 +56,14 @@ statically links coverage-instrumented binaries with LLVM runtime code
([compiler-rt][compiler-rt-profile]) that implements program hooks ([compiler-rt][compiler-rt-profile]) that implements program hooks
(such as an `exit` hook) to write the counter values to the `.profraw` file. (such as an `exit` hook) to write the counter values to the `.profraw` file.
In the `rustc` source tree, `library/profiler_builtins` bundles the LLVM In the `rustc` source tree,
`compiler-rt` code into a Rust library crate. (When building `rustc`, the `library/profiler_builtins` bundles the LLVM `compiler-rt` code into a Rust library crate.
`profiler_builtins` library is only included when `profiler = true` is set Note that when building `rustc`,
in `rustc`'s `config.toml`.) `profiler_builtins` is only included when `build.profiler = true` is set in `config.toml`.
When compiling with `-C instrument-coverage`, When compiling with `-C instrument-coverage`,
[`CrateLoader::postprocess()`][crate-loader-postprocess] dynamically loads the [`CrateLoader::postprocess()`][crate-loader-postprocess] dynamically loads
`profiler_builtins` library by calling `inject_profiler_runtime()`. `profiler_builtins` by calling `inject_profiler_runtime()`.
[compiler-rt-profile]: https://github.com/llvm/llvm-project/tree/main/compiler-rt/lib/profile [compiler-rt-profile]: https://github.com/llvm/llvm-project/tree/main/compiler-rt/lib/profile
[crate-loader-postprocess]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_metadata/creader/struct.CrateLoader.html#method.postprocess [crate-loader-postprocess]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_metadata/creader/struct.CrateLoader.html#method.postprocess