diff options
| author | Ryan Egesdahl <ryan.egesdahl@mongodb.com> | 2020-07-31 19:36:15 -0700 |
|---|---|---|
| committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2020-08-10 19:23:43 +0000 |
| commit | dd70c35c560dd939dd4a9320e3ac7a619237068b (patch) | |
| tree | e69f5413fefb40b39d8285a38ffe8ff2c0fa699b | |
| parent | d8fe8fb489c6f022b14fd0807ca80ba4b301b43f (diff) | |
| download | mongo-dd70c35c560dd939dd4a9320e3ac7a619237068b.tar.gz | |
SERVER-49352 Clarify build documentation for Python 2.7
Older versions of MongoDB only build with Python 2.7.x and had a comment
that running `pip` would work to install modules. However, on newer
systems, a symlink named `pip2` may not exist even though Python 2.7.x
is installed. In such cases, users would install the modules for the
wrong Python version and become confused when the build failed. The build
documentation is clarified to use a different and more reliable way to
execute `pip` without accidentally executing the wrong Python version.
(cherry picked from commit 936ebad6b67325f068e2ae83c9e5c143778964ef)
| -rw-r--r-- | docs/building.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/building.md b/docs/building.md index 3bcaf360dac..69c8aeb9634 100644 --- a/docs/building.md +++ b/docs/building.md @@ -26,13 +26,19 @@ The source for the tools is now available at [mongodb/mongo-tools](https://githu Python Prerequisites --------------- -In order to build MongoDB, Python 2.7.x is required, and several Python modules. To install -the required Python modules, run: +In order to build MongoDB, Python 2.7.x is required, along with several Python modules. To +install the required Python modules, run: - $ pip2 install -r buildscripts/requirements.txt + $ python2.7 -m pip install -r buildscripts/requirements.txt -Note: If the `pip2` command is not available, `pip` without a suffix may be the pip command -associated with Python 2.7.x. +Note: If the `python2.7` command is not available, `python2` may be the command +associated with Python 2.7.x. To verify that, run: + + $ python2 --version + +If `pip` is not installed for Python 2.7.x, you will need to install it first. For +details, see: +* https://pip.pypa.io/en/stable/installing/ SCons --------------- |