diff options
author | Keith Bostic <keith@wiredtiger.com> | 2012-02-17 09:51:16 +0000 |
---|---|---|
committer | Keith Bostic <keith@wiredtiger.com> | 2012-02-17 09:51:16 +0000 |
commit | 1897a76dc8ccb7017c794f548b690ffaf7c1f16e (patch) | |
tree | ecb20f729029051e1dded7903196e83744d1addf | |
parent | c73bfdb51fecc235c82eb3f57a606d1ccdab99c1 (diff) | |
download | mongo-1897a76dc8ccb7017c794f548b690ffaf7c1f16e.tar.gz |
Add a paragraph to the install page about building from the a GitHub
clone.
Move port information into the main page (not great, but shouldn't
be in the "install" page, either).
Re-order the introduction a bit.
-rw-r--r-- | docs/src/install.dox | 37 | ||||
-rw-r--r-- | docs/src/introduction.dox | 36 | ||||
-rw-r--r-- | docs/src/spell.ok | 4 |
3 files changed, 53 insertions, 24 deletions
diff --git a/docs/src/install.dox b/docs/src/install.dox index ec824257647..a6774cc5a38 100644 --- a/docs/src/install.dox +++ b/docs/src/install.dox @@ -2,16 +2,37 @@ This section explains how to build and install the WiredTiger software. -@section ports Ports +@section github Building using Git and GitHub -WiredTiger has been tested on the following systems: -@par -Linux\n -FreeBSD\n -Mac OS X\n +Skip this step if you are building from a WiredTiger release package, +and proceed with @ref building. -WiredTiger should be portable to any system that supports the ANSI C99, -POSIX 1003.1 and POSIX 1003.1c (threads extension) standards. +To clone WiredTiger and build from the WiredTiger GitHub repository +requires the +<a href="http://gcc.gnu.org/">GNU Compiler Collection</a> +(GCC) toolchain for configuration and building, including +<a href="http://www.gnu.org/software/autoconf/autoconf.html">autoconf</a>, +<a href="http://www.gnu.org/software/autoconf/automake.html">automake</a>, +<a href="http://www.gnu.org/software/libtool/libtool.html">libtool</a> and +related tools. The standard options for those tools can be specified +when configuring and building WiredTiger. + +First, clone the repository: + +@code +git clone git@github.com:wiredtiger/wiredtiger.git wiredtiger +@endcode + +Second, change into the \c build_posix directory of the repository, and +run the \c reconf script. + +@code +cd wiredtiger/build_posix +sh ./reconf +@endcode + +This creates the \c wiredtiger/configure autoconf script, and you can +now proceed with @ref building. @section building Building WiredTiger diff --git a/docs/src/introduction.dox b/docs/src/introduction.dox index 9aa058cc804..45eb79a62ac 100644 --- a/docs/src/introduction.dox +++ b/docs/src/introduction.dox @@ -1,19 +1,23 @@ -/*! @mainpage Reference Guide - -WiredTiger is an extensible platform for data management. This -documentation describes the programming interface to WiredTiger used by -developers to construct applications. - -We follow SQL terminology: a database is set of tables managed together. -Tables consist of rows, where each row is a key and its associated -value. Tables may optionally have an associated schema, splitting the -value into a set of columns. Tables may also have associated indices, -each of which is ordered by one or more columns. - -In addition to the traditional row-oriented storage where all columns -of a row are stored together, WiredTiger supports column-oriented -storage, where one or more columns can be stored individually, allowing -more efficient access and storage. +-/*! @mainpage Reference Guide + +WiredTiger is an extensible platform for data management.\n + +WiredTiger supports both traditional row-oriented storage, where all +columns of a row are stored together, and column-oriented storage, where +one or more columns can be stored individually, allowing more efficient +access and storage. + +This documentation describes the programming interface to WiredTiger +used by developers to construct applications. We follow SQL +terminology: a database is set of tables managed together. Tables +consist of rows, where each row is a key and its associated value. +Tables may optionally have an associated schema, splitting the value +into a set of columns. Tables may also have associated indices, each +of which is ordered by one or more columns. + +WiredTiger distributions are tested on Linux, FreeBSD and Mac OS X. +WiredTiger should be portable to any system that supports the ANSI C99, +POSIX 1003.1 and POSIX 1003.1c (threads extension) standards. To browse or download the WiredTiger source code, visit our diff --git a/docs/src/spell.ok b/docs/src/spell.ok index 103ba5f3fe9..9692a2bab40 100644 --- a/docs/src/spell.ok +++ b/docs/src/spell.ok @@ -13,6 +13,7 @@ EB EmpId FreeBSD GCC +GitHub IEC LDFLAGS LIBS @@ -36,6 +37,7 @@ apiflags ar arg autoconf +automake bdb bdbmap bindir @@ -111,6 +113,7 @@ gdbm getopt getter gid +github hb hotbackup href @@ -218,6 +221,7 @@ realloc'd recno recnoN recnum +reconf recs rerequests ret |