From bccd195ff6f135d97a652640f22012eb20857131 Mon Sep 17 00:00:00 2001 From: Christophe Troestler Date: Sun, 9 Feb 2025 20:53:49 +0100 Subject: [PATCH] Be more precise in the description of `register_dep` --- src/lib.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index a569184..9054673 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -275,8 +275,11 @@ impl Config { /// Registers a dependency for this compilation on the native library built /// by Cargo previously. /// - /// This registration will modify the `CMAKE_PREFIX_PATH` environment - /// variable for the build system generation step. + /// This registration will update the `CMAKE_PREFIX_PATH` environment + /// variable for the [`build`][Self::build] system generation step. The + /// path will be updated to include the content of the environment + /// variable `DEP_XXX_ROOT`, where `XXX` is replaced with the uppercased + /// value of `dep` (if that variable exists). pub fn register_dep(&mut self, dep: &str) -> &mut Config { self.deps.push(dep.to_string()); self