From c7d30ad9d5ee494c7c4f1c3c9a9238c4984a9e26 Mon Sep 17 00:00:00 2001 From: "M. Eric Irrgang" Date: Wed, 13 Oct 2021 17:42:03 +0300 Subject: [PATCH] Fix typos regarding FindPython3 CMake module hint. `_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 | 4 ++-- docs/release-notes/2021/major/portability.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/gmxapi/userguide/install.rst b/docs/gmxapi/userguide/install.rst index 7e96486f7f..8588156a48 100644 --- a/docs/gmxapi/userguide/install.rst +++ b/docs/gmxapi/userguide/install.rst @@ -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 ----------------- diff --git a/docs/release-notes/2021/major/portability.rst b/docs/release-notes/2021/major/portability.rst index f688a2b01d..4c1a22e13e 100644 --- a/docs/release-notes/2021/major/portability.rst +++ b/docs/release-notes/2021/major/portability.rst @@ -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! -- 2.22.0