Fix typos regarding FindPython3 CMake module hint.
authorM. Eric Irrgang <ericirrgang@gmail.com>
Wed, 13 Oct 2021 14:42:03 +0000 (17:42 +0300)
committerM. Eric Irrgang <ericirrgang@gmail.com>
Wed, 13 Oct 2021 14:43:08 +0000 (17:43 +0300)
`_ROOT` is a standard suffix for hints to `find_package()`,
but the `FindPython3` cmake module specifically uses `_ROOT_DIR` for
an analogous hint.

docs/gmxapi/userguide/install.rst
docs/release-notes/2021/major/portability.rst

index 7e96486f7f45f467a73cdbcfebaef108d0599422..8588156a48b3d85140459260e93457ec49e99d3f 100644 (file)
@@ -498,14 +498,14 @@ extract Python docstrings.
 
 Sometimes the build environment can choose a different Python interpreter than
 the one you intended.
-You can set the ``Python3_ROOT`` or ``CMAKE_PREFIX_PATH`` CMake variable to
+You can set the ``Python3_ROOT_DIR`` or ``CMAKE_PREFIX_PATH`` CMake variable to
 explicitly choose the Python installation or *venv* directory.
 
 If you use pyenv or pyenv-virtualenv to dynamically manage your Python version,
 you can help identify a particular version with ``pyenv version-name`` and the
 directory with ``pyenv prefix {version}``. For example::
 
-    -DPython3_ROOT=$(pyenv prefix $(pyenv version-name))
+    -DPython3_ROOT_DIR=$(pyenv prefix $(pyenv version-name))
 
 Docker web server
 -----------------
index f688a2b01d3b6aad133c4042b8763de0cd2bcd08..4c1a22e13eaa4d1b4c0d41d6362f50633c160489 100644 (file)
@@ -12,7 +12,7 @@ CMake now detects Python using
 If you previously used ``PYTHON_EXECUTABLE`` to hint the location of the Python
 interpreter, you should instead specify the Python "root" or "prefix" path
 (the directory containing ``./bin/python3``) with CMake variable
-``Python3_ROOT`` or ``CMAKE_PREFIX_PATH``. As other infrastructure evolves,
+``Python3_ROOT_DIR`` or ``CMAKE_PREFIX_PATH``. As other infrastructure evolves,
 ``PYTHON_EXECUTABLE`` may cease to have the desired effect without warning.
 
 .. Note to developers!