diff options
| -rw-r--r-- | CONTRIBUTING.rst | 3 | ||||
| -rw-r--r-- | docs/building.debian.etch.ec2.md | 19 | ||||
| -rw-r--r-- | docs/building.md | 67 |
3 files changed, 44 insertions, 45 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 447fda131f6..0d59013ee52 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -17,6 +17,7 @@ Getting Started - Create a `MongoDB JIRA account`_. - Create a `Github account`_. - Fork the repository on Github at https://github.com/mongodb/mongo. +- For more details see http://www.mongodb.org/about/contributors/ .. _MongoDB JIRA account: https://jira.mongodb.org/secure/Signup!default.jspa .. _Github account: https://github.com/signup/free @@ -77,7 +78,7 @@ Testing ------- Every non-trivial change to the code base should be accompanied by a relevant addition to or -modification of the test suite. If you don't believe this is necessary, please add an explanation +modification of the test suite. If you do not believe this is necessary, please add an explanation in the JIRA ticket why no such changes are either needed or possible. All changes must also pass the full test suite (including your test additions/changes) on your diff --git a/docs/building.debian.etch.ec2.md b/docs/building.debian.etch.ec2.md deleted file mode 100644 index d01c4e76c54..00000000000 --- a/docs/building.debian.etch.ec2.md +++ /dev/null @@ -1,19 +0,0 @@ -# Building on Debian etch on Amazon EC2 - -ami-f2f6159b - - apt-get update - apt-get install git-core "g++-4.1" - apt-get install python-setuptools libpcre3-dev - apt-get install libboost-filesystem-dev libboost-dev libboost-thread-dev libboost-program-options-dev libboost-date-time-dev - -See: http://dochub.mongodb.org/core/buildingspidermonkey - - ln -s /usr/bin/g++-4.1 /usr/bin/g++ - ln -s /usr/bin/gcc-4.1 /usr/bin/gcc - - easy_install scons - - git clone git://github.com/mongodb/mongo.git - cd mongo - scons all diff --git a/docs/building.md b/docs/building.md index 420ad4329e1..de8d515cce8 100644 --- a/docs/building.md +++ b/docs/building.md @@ -1,10 +1,19 @@ Building MongoDB ================ -SCONS +To build MongoDB, you will need: + +* A modern C++ compiler. MongoDB has been tested with Clang 3.x, GCC 4.1+, and Visual Studio 201x. Older versions +of the compilers are not supported. +* Python 2.7 +* SCons 2.3 + +for the target x86, or x86-64 platform. More detailed platform instructions can be found below. + +SCons --------------- -For detail information about building, please see [the manual](http://dochub.mongodb.org/core/building). +For detail information about building, please see [the build manual](http://www.mongodb.org/about/contributors/tutorial/build-mongodb-from-source/) If you want to build everything (mongod, mongo, tools, etc): @@ -20,38 +29,33 @@ To 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. -SCONS TARGETS +SCons Targets -------------- * mongod * mongos * mongo -* mongoclient +* core (includes mongod, mongos, mongo) +* tools (includes all tools) * all -COMPILER VERSIONS --------------- - -Mongo has been tested with GCC 4.x and Visual Studio 2008 and 2010. Older versions -of GCC may not be happy. - -WINDOWS +Windows -------------- -See http://dochub.mongodb.org/core/buildingforwindows +See [the windows build manual](http://www.mongodb.org/about/contributors/tutorial/build-mongodb-from-source/#windows-specific-instructions) Build requirements: -* vc++ express or visual studio -* python 2.5 (for scons - 2.6 might be needed for some regression tests) -* scons -* boost 1.35 (or higher) +* VC++ 2010 Express or later, OR Visual Studio 2010 or later +* Python 2.7, ActiveState ActivePython 2.7.x Community Edition for Windows is recommended +* SCons +* Boost 1.35 (or higher) Or download a prebuilt binary for Windows at www.mongodb.org. -UBUNTU +Debian/Ubuntu -------------- -To install dependencies on Ubuntu systems: +To install dependencies on Debian or Ubuntu systems: # aptitude install scons build-essential # aptitude install libboost-filesystem-dev libboost-program-options-dev libboost-system-dev libboost-thread-dev @@ -64,11 +68,10 @@ Then build as usual with `scons`: $ scons all - OS X -------------- -Using [Homebrew](http://mxcl.github.com/homebrew/): +Using [Homebrew](http://brew.sh): $ brew install mongodb @@ -76,19 +79,33 @@ Using [MacPorts](http://www.macports.org): $ sudo port install mongodb -FREEBSD +FreeBSD -------------- Install the following ports: - * devel/boost * devel/libexecinfo + * devel/scons + * lang/gcc + * lang/python + +Optional Components if you want to use system libraries instead of the libraries included with MongoDB + + * archivers/snappy + * lang/v8 + * devel/boost * devel/pcre - * lang/spidermonkey +OpenBSD +-------------- +Install the following ports: + + * devel/libexecinfo + * devel/scons + * lang/gcc + * lang/python Special Build Notes -------------- - * [debian etch on ec2](building.debian.etch.ec2.html) - * [open solaris on ec2](building.opensolaris.ec2.html) + * [open solaris on ec2](building.opensolaris.ec2.md) |