Improve override docs

rapidsai · Sep 8, 2021 · eb2c995 · eb2c995
1 parent c615c75
commit eb2c995
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/rapids-cmake/cpm/init.cmake b/rapids-cmake/cpm/init.cmake
@@ -32,6 +32,14 @@ The CPM module will be downloaded based on the state of :cmake:variable:`CPM_SOU
 same download of CPM. If those variables aren't set the file will be cached
 in the build tree of the calling project
 
+``OVERRIDE``
+.. versionadded:: v21.10.00
+  Override the `CPM` preset package information for the project. The user provided
+  json file must follow the `versions.json` format, which is :ref:`documented here<cpm_version_format>`.
+
+  If the override file doesn't specify a value or package entry the default
+  version will be used.
+
 .. note::
   Must be called before any invocation of :cmake:command:`rapids_cpm_find`.
 

diff --git a/rapids-cmake/cpm/package_override.cmake b/rapids-cmake/cpm/package_override.cmake
@@ -37,7 +37,7 @@ example:
 .. literalinclude:: /packages/example.json
   :language: json
 
-If the override doesn't specify a value or package entry the default
+If the override file doesn't specify a value or package entry the default
 version will be used.
 
 #]=======================================================================]