Skip to content

Commit 0542060

Browse files
authored
Be more precise in the description of register_dep (#238)
1 parent faccc07 commit 0542060

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/lib.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,11 @@ impl Config {
275275
/// Registers a dependency for this compilation on the native library built
276276
/// by Cargo previously.
277277
///
278-
/// This registration will modify the `CMAKE_PREFIX_PATH` environment
279-
/// variable for the build system generation step.
278+
/// This registration will update the `CMAKE_PREFIX_PATH` environment
279+
/// variable for the [`build`][Self::build] system generation step. The
280+
/// path will be updated to include the content of the environment
281+
/// variable `DEP_XXX_ROOT`, where `XXX` is replaced with the uppercased
282+
/// value of `dep` (if that variable exists).
280283
pub fn register_dep(&mut self, dep: &str) -> &mut Config {
281284
self.deps.push(dep.to_string());
282285
self

0 commit comments

Comments
 (0)