From 92bf45205fe5917d227df3131f662238267354d3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Steffen=20M=C3=BCthing?=
<steffen.muething@iwr.uni-heidelberg.de>
Date: Fri, 29 Jun 2018 22:44:48 +0200
Subject: [PATCH] Update documentation
---
cmake/modules/DunePythonVirtualenv.cmake | 28 +++++++++++++-----------
1 file changed, 15 insertions(+), 13 deletions(-)
diff --git a/cmake/modules/DunePythonVirtualenv.cmake b/cmake/modules/DunePythonVirtualenv.cmake
index 5df2dd5fe..20b54816a 100644
--- a/cmake/modules/DunePythonVirtualenv.cmake
+++ b/cmake/modules/DunePythonVirtualenv.cmake
@@ -34,16 +34,18 @@
#
# .. cmake_variable:: DUNE_PYTHON_ALLOW_GET_PIP
#
-# Set this variable to allow the Dune build system to download :code:`get-pip.py`
-# from https://bootstrap.pypa.io/get-pip.py at configure time and execute it
-# to install pip into the freshly set up virtual environment. This step became
-# necessary because of a debian bug:
-# https://bugs.launchpad.net/debian/+source/python3.4/+bug/1290847
+# The Dune build system will try to build a virtualenv with pip installed into it,
+# but this can fail in some situations, in particular on Debian and Ubuntu distributions.
+# In this case, you will se a warning message in the CMake output. If you are on Debian
+# or Ubuntu, try installing the :code:`python3-venv` (for Python 3) and / or
+# :code:`python-virtualenv` packages, delete your build directory and try configuring
+# again.
#
-# If you do not want the Dune build system to download :code:`get-pip.py`, you can
-# manually activate the virtual environment (sourcing the activate script
-# symlinked into the build directories), install pip through your favorite
-# method and reconfigure.
+# If that still does not help, set this variable to allow the Dune build system to download
+# :code:`get-pip.py` from https://bootstrap.pypa.io/get-pip.py at configure time and execute
+# it to install pip into the freshly set up virtual environment. While this should normally
+# not be necessary anymore, see https://bugs.launchpad.net/debian/+source/python3.4/+bug/1290847
+# for more information about the underlying distribution bug.
#
# First, we look through the dependency tree of this module for a build directory
@@ -135,11 +137,11 @@ else()
message(WARNING "Writing script 'run-in-dune-env' not implemented on your platform!")
endif()
-# We previously omitted pip from the env, because of this Debian bug:
+# The virtualenv might not contain pip due to the distribution bug described in
# https://bugs.launchpad.net/debian/+source/python3.4/+bug/1290847
-# We now, need to install pip. Easiest way is to download the get-pip
-# script. We ask users for permission to do so, or we allow them to
-# set it up themselves.
+# We need to install pip, so if pip is missing, we offer to download and run the get-pip
+# script. We ask users for permission to do so, or we allow them to set it up themselves.
+
dune_python_find_package(PACKAGE pip
RESULT pippresent
INTERPRETER ${DUNE_PYTHON_VIRTUALENV_EXECUTABLE}
--
GitLab