Skip to content

Commit

Permalink
SERVER-14397: Update Building.md & Contributing.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
markbenvenuto committed Jul 1, 2014
1 parent 8407b0e commit 44c3347
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 45 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
19 changes: 0 additions & 19 deletions docs/building.debian.etch.ec2.md

This file was deleted.

67 changes: 42 additions & 25 deletions docs/building.md
Original file line number Diff line number Diff line change
@@ -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):

Expand All @@ -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
Expand All @@ -64,31 +68,44 @@ 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

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)

0 comments on commit 44c3347

Please sign in to comment.