summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMark Benvenuto <mark.benvenuto@mongodb.com>2017-05-16 11:12:05 -0400
committerMark Benvenuto <mark.benvenuto@mongodb.com>2017-05-16 11:12:05 -0400
commit6403656255871205ca212f634a869257b2b8454a (patch)
treeef0b904ccb18eb41cfa9a42507ca0acb710e4a71 /docs
parent24c7c45f83155c72fee03a362b3e5a6a7b37f2a2 (diff)
downloadmongo-6403656255871205ca212f634a869257b2b8454a.tar.gz
SERVER-29028 Update docs/building.md
Diffstat (limited to 'docs')
-rw-r--r--docs/building.md51
1 files changed, 31 insertions, 20 deletions
diff --git a/docs/building.md b/docs/building.md
index 05537a87c68..dedb459f9d5 100644
--- a/docs/building.md
+++ b/docs/building.md
@@ -4,13 +4,16 @@ Building MongoDB
To build MongoDB, you will need:
* A modern C++ compiler. One of the following is required.
- * GCC 4.8.2 or newer
- * Clang 3.4 (or Apple XCode 5.1.1 Clang) or newer
- * Visual Studio 2013 Update 2 or newer
-* Python 2.7
-* SCons 2.3.5+
+ * GCC 5.4.0 or newer
+ * Clang 3.7 (or Apple XCode 7.0.2 Clang) or newer
+ * Visual Studio 2015 Update 2 or newer (See Windows section below for details)
+* Python 2.7.x and Pip modules:
+ * pyyaml
+ * typing
+
+MongoDB supports the following architectures: arm64, ppc64le, s390x, and x86-64.
+More detailed platform instructions can be found below.
-for the target x86, or x86-64 platform. More detailed platform instructions can be found below.
MongoDB Tools
--------------
@@ -20,22 +23,33 @@ have been rewritten in [Go](http://golang.org/) and are no longer included in th
The source for the tools is now available at [mongodb/mongo-tools](https://github.com/mongodb/mongo-tools).
+Python Prerequisites
+---------------
+
+In order to build MongoDB, Python 2.7.x is required, and several Python modules. To install
+the required Python modules, run:
+
+ $ pip2 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.
+
SCons
---------------
-For detail information about building, please see [the build manual](http://www.mongodb.org/about/contributors/tutorial/build-mongodb-from-source/)
+For detail information about building, please see [the build manual](https://github.com/mongodb/mongo/wiki/Build-Mongodb-From-Source)
If you want to build everything (mongod, mongo, tests, etc):
- $ scons all
+ $ python2 buildscripts/scons.py all
If you only want to build the database:
- $ scons
+ $ python2 buildscripts/scons.py scons
To install
- $ scons --prefix=/opt/mongo install
+ $ python2 buildscripts/scons.py --prefix=/opt/mongo install
Please note that prebuilt binaries are available on [mongodb.org](http://www.mongodb.org/downloads) and may be the easiest way to get started.
@@ -51,12 +65,15 @@ SCons Targets
Windows
--------------
-See [the windows build manual](http://www.mongodb.org/about/contributors/tutorial/build-mongodb-from-source/#windows-specific-instructions)
+See [the windows build manual](https://github.com/mongodb/mongo/wiki/Build-Mongodb-From-Source#windows-specific-instructions)
Build requirements:
-* Visual Studio 2013 Update 2 or newer
+* Visual Studio 2015 Update 2 or newer
* Python 2.7, ActiveState ActivePython 2.7.x Community Edition for Windows is recommended
-* SCons
+
+If using VS 2015 Update 3, a hotfix is required to build the unit tests. See
+https://support.microsoft.com/en-us/help/3207317/visual-c-optimizer-fixes-for-visual-studio-2015-update-3
+for details.
Or download a prebuilt binary for Windows at www.mongodb.org.
@@ -65,17 +82,13 @@ Debian/Ubuntu
To install dependencies on Debian or Ubuntu systems:
- # aptitude install scons build-essential
+ # aptitude install build-essential
# aptitude install libboost-filesystem-dev libboost-program-options-dev libboost-system-dev libboost-thread-dev
To run tests as well, you will need PyMongo:
# aptitude install python-pymongo
-Then build as usual with `scons`:
-
- $ scons all
-
OS X
--------------
@@ -93,7 +106,6 @@ FreeBSD
Install the following ports:
* devel/libexecinfo
- * devel/scons
* lang/clang38
* lang/python
@@ -111,7 +123,6 @@ OpenBSD
Install the following ports:
* devel/libexecinfo
- * devel/scons
* lang/gcc
* lang/python