Return-Path: Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: (qmail 1066 invoked from network); 17 Mar 2010 20:38:23 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 17 Mar 2010 20:38:23 -0000 Received: (qmail 30138 invoked by uid 500); 17 Mar 2010 20:38:22 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 30092 invoked by uid 500); 17 Mar 2010 20:38:22 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 30051 invoked by uid 99); 17 Mar 2010 20:38:21 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 17 Mar 2010 20:38:21 +0000 X-ASF-Spam-Status: No, hits=-1261.8 required=10.0 tests=ALL_TRUSTED,AWL,NORMAL_HTTP_TO_IP,WEIRD_PORT X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 17 Mar 2010 20:38:18 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id CC6FF2388AA9; Wed, 17 Mar 2010 20:37:58 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r924478 - in /couchdb/branches/0.11.x: BUILDING DEVELOPERS INSTALL.Unix INSTALL.Windows Makefile.am README license.skip Date: Wed, 17 Mar 2010 20:37:58 -0000 To: commits@couchdb.apache.org From: jan@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100317203758.CC6FF2388AA9@eris.apache.org> Author: jan Date: Wed Mar 17 20:37:58 2010 New Revision: 924478 URL: http://svn.apache.org/viewvc?rev=924478&view=rev Log: documentation improvements Added: couchdb/branches/0.11.x/DEVELOPERS Removed: couchdb/branches/0.11.x/BUILDING Modified: couchdb/branches/0.11.x/INSTALL.Unix couchdb/branches/0.11.x/INSTALL.Windows couchdb/branches/0.11.x/Makefile.am couchdb/branches/0.11.x/README couchdb/branches/0.11.x/license.skip Added: couchdb/branches/0.11.x/DEVELOPERS URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/DEVELOPERS?rev=924478&view=auto ============================================================================== --- couchdb/branches/0.11.x/DEVELOPERS (added) +++ couchdb/branches/0.11.x/DEVELOPERS Wed Mar 17 20:37:58 2010 @@ -0,0 +1,95 @@ +Apache CouchDB DEVELOPERS +========================= + +Only follow these instructions if you are building from a source checkout. + +If you're unsure what this means, ignore this document. + +Dependencies +------------ + +You will need the following installed: + + * GNU Automake (>=1.6.3) (http://www.gnu.org/software/automake/) + * GNU Autoconf (>=2.59) (http://www.gnu.org/software/autoconf/) + * GNU Libtool (http://www.gnu.org/software/libtool/) + * GNU help2man (http://www.gnu.org/software/help2man/) + +The `help2man` tool is optional, but will generate `man` pages for you. + +Debian-based (inc. Ubuntu) Systems +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can install the dependencies by running: + + apt-get install automake autoconf libtool help2man + +Be sure to update the version numbers to match your system's available packages. + +Mac OS X +~~~~~~~~ + +You can install the dependencies by running: + + port install automake autoconf libtool help2man + +You will need MacPorts installed to use the `port` command. + +Bootstrapping +------------- + +Bootstrap the pristine source by running: + + ./bootstrap + +You must repeat this step every time you update your source checkout. + +Testing +------- + +Check the test suite by running: + + make check + +Generate a coverage report by running: + + make cover + +Please report any problems to the developer's mailing list. + +Releasing +--------- + +Unix-like Systems +~~~~~~~~~~~~~~~~~ + +Configure the source by running: + + ./configure + +Prepare the release artefacts by running: + + make distcheck + +You can prepare signed release artefacts by running: + + make distsign + +The release artefacts can be found in the root source directory. + +Microsoft Windows +~~~~~~~~~~~~~~~~~ + +Configure the source by running: + + ./configure + +Prepare the release artefacts by running: + + make dist + +The release artefacts can be found in the `etc/windows` directory. + +Until the build system has been improved, you must make sure that you run this +command from a clean source checkout. If you do not, your test database and log +files will be bundled up in the release artefact. Modified: couchdb/branches/0.11.x/INSTALL.Unix URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/INSTALL.Unix?rev=924478&r1=924477&r2=924478&view=diff ============================================================================== --- couchdb/branches/0.11.x/INSTALL.Unix (original) +++ couchdb/branches/0.11.x/INSTALL.Unix Wed Mar 17 20:37:58 2010 @@ -1,18 +1,20 @@ -Installing on Unix-like Systems -=============================== +Apache CouchDB README.Unix +========================== + +A high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu. Dependencies ------------ You will need the following installed: - * Erlang OTP (>=R12B5) (http://erlang.org/) - * ICU (http://icu.sourceforge.net/) - * OpenSSL (http://www.openssl.org/) - * Mozilla SpiderMonkey (>=1.7) (http://www.mozilla.org/js/spidermonkey/) - * libcurl (http://curl.haxx.se/libcurl/) - * GNU Make (http://www.gnu.org/software/make/) - * GNU Compiler Collection (http://gcc.gnu.org/) + * Erlang OTP (>=R12B5) (http://erlang.org/) + * ICU (http://icu.sourceforge.net/) + * OpenSSL (http://www.openssl.org/) + * Mozilla SpiderMonkey (1.8) (http://www.mozilla.org/js/spidermonkey/) + * libcurl (http://curl.haxx.se/libcurl/) + * GNU Make (http://www.gnu.org/software/make/) + * GNU Compiler Collection (http://gcc.gnu.org/) It is recommended that you install Erlang OTP R12B-5 or above where possible. @@ -45,8 +47,6 @@ You will need MacPorts installed to use Installing ---------- -Skip to the - Once you have satisfied the dependencies you should run: ./configure @@ -75,6 +75,27 @@ If everything was successful you should Relax. +First Run +--------- + +You can start the CouchDB server by running: + + sudo -i -u couchdb couchdb + +This uses the `sudo` command to run the `couchdb` command as the `couchdb` user. + +When CouchDB starts it should eventually display the following message: + + Apache CouchDB has started, time to relax. + +Relax. + +To check that everything has worked, point your web browser to: + + http://127.0.0.1:5984/_utils/index.html + +From here you should run the test suite. + Security Considerations ----------------------- Modified: couchdb/branches/0.11.x/INSTALL.Windows URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/INSTALL.Windows?rev=924478&r1=924477&r2=924478&view=diff ============================================================================== --- couchdb/branches/0.11.x/INSTALL.Windows (original) +++ couchdb/branches/0.11.x/INSTALL.Windows Wed Mar 17 20:37:58 2010 @@ -1,138 +1,148 @@ -Installing on Microsoft Windows -=============================== +Apache CouchDB README.Windows +============================== -Windows -~~~~~~~ +For a high-level guide to Microsoft Windows. -The Windows build process is very similar to the Erlang build process. +Dependencies +------------ -Build Tools -^^^^^^^^^^^ +You will need the following installed: -To build on Windows, you will need the following installed: + * Erlang OTP (>=R12B5) (http://erlang.org/) + * ICU (http://icu.sourceforge.net/) + * OpenSSL (http://www.openssl.org/) + * Mozilla SpiderMonkey (1.8) (http://www.mozilla.org/js/spidermonkey/) + * libcurl (http://curl.haxx.se/libcurl/) + * Cygwin (http://www.cygwin.com/) + * Visual Studio 2008 (http://msdn.microsoft.com/en-gb/vstudio/default.aspx) - * Erlang OTP (>=R12B5) (http://erlang.org/) - * ICU (http://icu.sourceforge.net/) - * OpenSSL (http://www.openssl.org/) - * Mozilla SpiderMonkey (=1.8) (http://www.mozilla.org/js/spidermonkey/) - * libcurl (http://curl.haxx.se/libcurl/) - * Cygwin (http://www.cygwin.com/) - * Visual Studio 2008 (http://msdn.microsoft.com/en-gb/vstudio/default.aspx) +General Notes +------------- -Please note: + * When installing Erlang, you must build it from source. - * When installing Erlang, you must build it from source. The CouchDB build - makes use of a number of the Erlang build scripts. + The CouchDB build makes use of a number of the Erlang build scripts. * When installing ICU, select the binaries built with Visual Studio 2008. * When installing Cygwin, be sure to select all the `development` tools. - * When installing libcurl, be sure to install by hand as the Cygwin binaries - are built with an incompatible compiler and will not work with Erlang. + * When installing libcurl, be sure to install by hand. -Setting Up -^^^^^^^^^^ + The Cygwin binaries are incompatible and will not work with Erlang. -Before starting any Cygwin terminals, run the following command: +Setting Up Cygwin +----------------- + +Before starting any Cygwin terminals, run: set CYGWIN=nontsec -To set up your environment, run the following command: +To set up your environment, run: [VS_BIN]/vcvars32.bat Replace [VS_BIN] with the path to your Visual Studio `bin` directory. -After you have done this, `link.exe` and `cl.exe` should be on your path and -correspond to the Microsoft linker and compiler, respectively. +You must check that: -To set up your environment, run the following command: + * The `which link` command points to the Microsoft linker. - eval `./otp_build env_win32` + * The `which cl` command points to the Microsoft compiler. + +If you do not do this, the ones found in `/usr/bin` may be used instead. -Do this even if you have already built Erlang because the CouchDB build system -needs the environment variables set up by this script. +Building Erlang +--------------- -To set up your path, run the following command: +You must include OpenSSL. - export PATH=$ERL_TOP/release/win32/erts-5.7.2/bin:$PATH +However, you can skip the GUI tools by running: + + echo "skipping gs" > lib/gs/SKIP + + echo "skipping ic" > lib/ic/SKIP + +Follow the rest of the Erlang instructions as described. + +After running: + + ./otp_build release -a + +You should run: + + ./release/win32/Install.exe -Everything should be set up properly now. +This will set up the release/win32/bin directory correctly. -Building -^^^^^^^^ +To set up your environment for building CouchDB, run: -We start by bootstrapping: + eval `./otp_build env_win32` + +To set up the `ERL_TOP` environment variable, run: + + export ERL_TOP=[ERL_TOP] + +Replace `[ERL_TOP]` with the Erlang source directory name. + +Remember to use `/cygdrive/c/` instead of `c:/` as the directory prefix. + +To set up your path, run: - $ cd $COUCHDB_TOP - $ ./bootstrap - You have bootstrapped Apache CouchDB, time to relax. + export PATH=$ERL_TOP/release/win32/erts-5.7.2/bin:$PATH - Run `./configure' to configure the source before you install. - $ +If everything was successful, you should be ready to build CouchDB. Relax. -Now we need to run a complicated configure command-line. +Building CouchDB +---------------- + +Once you have satisfied the dependencies you should run: - $ ./configure \ - --with-js-include=/cygdrive/c/path_to_seamonkey_include \ - --with-js-lib=/cygdrive/c/path_to_seamonkey_lib \ - --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \ - --with-erlang=$ERL_TOP/release/win32/usr/include \ - --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \ - --with-openssl-bin-dir=/cygdrive/c/openssl/bin \ - --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \ - --prefix=$ERL_TOP/release/win32 + ./configure \ + --with-js-include=/cygdrive/c/path_to_seamonkey_include \ + --with-js-lib=/cygdrive/c/path_to_seamonkey_lib \ + --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \ + --with-erlang=$ERL_TOP/release/win32/usr/include \ + --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \ + --with-openssl-bin-dir=/cygdrive/c/openssl/bin \ + --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \ + --prefix=$ERL_TOP/release/win32 -Relax, then relax some more, then get a beer and relax some more; the -above command may take many many minutes to complete... +This command could take a while to complete. -Note that all paths must be in cygwin format (ie, using '/cygdrive/c/dir/...' -rather than 'c:/dir'.) Those starting with $ERL_TOP can be entered -literally, assuming ERL_TOP is set as described above. +If everything was successful you should see the following message: -Notes: - When building the installer, the necessary openssl binaries are pulled from - the directory pointed to --with-openssl-bin-dir. + You have configured Apache CouchDB, time to relax. -Now we can build it and "install" it into the $ERL_TOP/release/win32 (or -wherever you set --prefix to above) directory: +Relax. - $ make install +To install CouchDB you should run: -Relax on your new couch: + make install - The $ERL_TOP/release/win32 directory is now ready to .zip up, be packaged - by an installer, etc. To test it in-place, execute: +If everything was successful you should see the following message: - $ $ERL_TOP/release/win32/bin/couchdb.bat + You have installed Apache CouchDB, time to relax. - and everything should work fine. +Relax. -To create an installer, execute: +First Run +--------- - $ make dist +You can start the CouchDB server by running: -and look for etc/windows/setup-couch*.exe. Note - only do this after -a clean build, not after testing in-place - otherwise your test database and -log files will be shipped! + $ERL_TOP/release/win32/bin/couchdb.bat -Notes -^^^^^ +When CouchDB starts it should eventually display the following message: -Building Erlang -+++++++++++++++ + Apache CouchDB has started, time to relax. - * Follow the instructions as described. You do need openssl, but don't need - the GUI tools. You can skip them with the following command: +Relax. - echo "skipping gs" > lib/gs/SKIP - echo "skipping ic" > lib/ic/SKIP +To check that everything has worked, point your web browser to: - * Ensure `which link` points at the Microsoft linker. If you do not do this, - the one in /usr/bin may be found instead. + http://127.0.0.1:5984/_utils/index.html - * After executing `./otp_build release -a`, be sure to execute Install.exe in - the release/win32 directory to setup the release/win32/bin dir correctly. +From here you should run the test suite. Modified: couchdb/branches/0.11.x/Makefile.am URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/Makefile.am?rev=924478&r1=924477&r2=924478&view=diff ============================================================================== --- couchdb/branches/0.11.x/Makefile.am (original) +++ couchdb/branches/0.11.x/Makefile.am Wed Mar 17 20:37:58 2010 @@ -15,8 +15,8 @@ SUBDIRS = bin etc src share test var uti localdoc_DATA = \ AUTHORS.gz \ BUGS.gz \ - BUILDING.gz \ CHANGES.gz \ + DEVELOPERS.gz \ INSTALL.gz \ INSTALL.Unix.gz \ INSTALL.Windows.gz \ @@ -31,8 +31,8 @@ DISTCLEANFILES = $(localdoc_DATA) EXTRA_DIST = \ AUTHORS \ BUGS \ - BUILDING \ CHANGES \ + DEVELOPERS \ INSTALL \ INSTALL.Unix \ INSTALL.Windows \ @@ -49,10 +49,10 @@ AUTHORS.gz: $(top_srcdir)/AUTHORS BUGS.gz: $(top_srcdir)/BUGS -gzip -9 < $< > $@ -BUILDING.gz: $(top_srcdir)/BUILDING +CHANGES.gz: $(top_srcdir)/CHANGES -gzip -9 < $< > $@ -CHANGES.gz: $(top_srcdir)/CHANGES +DEVELOPERS.gz: $(top_srcdir)/DEVELOPERS -gzip -9 < $< > $@ INSTALL.gz: $(top_srcdir)/INSTALL Modified: couchdb/branches/0.11.x/README URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/README?rev=924478&r1=924477&r2=924478&view=diff ============================================================================== --- couchdb/branches/0.11.x/README (original) +++ couchdb/branches/0.11.x/README Wed Mar 17 20:37:58 2010 @@ -1,334 +1,43 @@ Apache CouchDB README ===================== -Building -^^^^^^^^ - -Developer build instructions are available: - - BUILDING - -Follow these instructions if you are building from a repository checkout. - -If you're unsure what this means, skip to the next section. - Installation -^^^^^^^^^^^^ +------------ -General installation instructions: +For a low-level guide, see: INSTALL -If you're running a Unix-like system, such as Ubuntu or Mac OS X: +For a high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu, see: INSTALL.Unix -If you're running Microsoft Windows: +For a high-level guide to Microsoft Windows, see: INSTALL.Windows -Follow the instructions in the proper file and return to this document. - -Running -^^^^^^^ - -You can start the CouchDB server by running: - - sudo -i -u couchdb couchdb - -This uses the `sudo` command to run the `couchdb` command as the `couchdb` user. - -When CouchDB starts it should eventually display the following message: - - Apache CouchDB has started, time to relax. - -Relax. - -To check that everything has worked, point your web browser to: +Follow the proper instructions to get CouchDB installed on your system. - http://127.0.0.1:5984/_utils/index.html - -From here you should run the test suite. - -Check the appropriate `INSTALL` file for help with running CouchDB as a daemon. +If you're having problems, skip to the next section. Troubleshooting -^^^^^^^^^^^^^^^ +---------------- -For general troubleshooting: +For troubleshooting, see: http://wiki.apache.org/couchdb/Troubleshooting -If you're getting a cryptic error message: +If you're getting a cryptic error message, see: http://wiki.apache.org/couchdb/Error_messages -The mailing lists also provide a wealth of support and knowledge for you to tap -into. Feel free to drop by with your questions or comments. See the official -CouchDB website for more information about our community resources. - -<<<<<<< .mine -======= -Note: These instructions assume you have created the `couchdb` user. See the -specific system information included below to learn how to reconfigure this. - -Note: If any of these methods report a failure you can run the `couchdb` command -manually to see the error messages it is displaying. - -The `/usr/local/etc/logrotate.d/couchdb` file is provided as a logrotate -configuration that you can use to rotate Apache CouchDB's logs. - -SysV/BSD-style Systems -++++++++++++++++++++++ - -Depending on your system the `couchdb` init script will be installed into a -direcory called `init.d` (for SysV-style systems) or `rc.d` (for BSD-style -systems). These examples use the `[init.d|rc.d]` notation to indicate this. - -You can control the Apache CouchDB daemon by running: - - /usr/local/etc/[init.d|rc.d]/couchdb [start|stop|restart|force-reload|status] - -If you wish to configure how the init script works, such as which user to run -Apache CouchDB as, you must edit the `/usr/local/etc/default/couchdb` file as -appropriate. If you are running the init script as a non-superuser you need to -remove the line with the `COUCHDB_USER` setting. - -If you wish the Apache CouchDB daemon to run as a system service you need to -copy the `/usr/local/etc/[init.d|rc.d]/couchdb` script into your system wide -`/etc/[init.d|rc.d]` directory and update your system configuration. - -You may be able to configure your system using the following command: - - sudo update-rc.d couchdb defaults - -Consult your system documentation for more information. - -Mac OS X -++++++++ - -You can use the `launchctl` command to control the Apache CouchDB daemon. - -You can load the launchd configuration by running: - - sudo launchctl load /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist - -You can stop the Apache CouchDB daemon by running: - - sudo launchctl unload /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist - -You can start Apache CouchDB by running: - - sudo launchctl start org.apache.couchdb - -You can restart Apache CouchDB by running: - - sudo launchctl stop org.apache.couchdb - -You can change the launchd configuration by running: - - open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist - -If you want the Apache CouchDB daemon to run at startup, copy the -`/usr/local/Library/LaunchDaemons/org.apache.couchdb.plist` file to your system -`/Library/LaunchDaemons` directory. - -Windows -~~~~~~~ - -The Windows build process is very similar to the erlang build process; -indeed, we re-use some of their shell-scripts. Therefore, it is recommended -you build erlang itself from sources - this will ensure that you have all the -tools and environment necessary to build couch itself. A binary build of -erlang should work for those in a hurry (see below), but it isn't really -supported. See the end of these notes or information on building erlang -which is relevant to couch. - -Build Tools ------------ - -To build on Windows, you need the following tools: - -* cygwin - it isn't clear exactly which tools you need - select all - 'development' tools. As mentioned above, if you can build erlang itself - you have everything you need. - -* VS2008 - -* Erlang - a built source distro of erlang is preferred. A binary - distribution of Erlang is OK, but you will also need a source distribution - for the cc.sh/link.sh etc wrapper shell scripts used by erlang - couch - reuses these scripts in its build process and the license isn't compatible - enough for us to clone them. - -Other tools: - -* Fetch the 'curl' sources and build them as per the instructions. The cygwin - curl binaries are built with a different compiler so are no good. - -* Download the ICU binaries built with VS2008. - -* Download and build the same version of spidermonkey the version of couch - requires - at time of writing this is 1.8. Different versions will not - work (ie, at time of writing, 1.8.1 does not work with couch). - -Build Environment ------------------ - -Setup your environment: - -For the sake of everything you find sacred: - set CYGWIN=nontsec -BEFORE starting any cygwin environments. Set this variable globally. Without -it you can expect all kinds of permissions-related problems. - -Execute the VC .bat files to setup your environment such that cl.exe etc are -on your path. Start a cygwin shell. - -Check your environment: - * which link -> should point at the MS linker. - * which cl -> should point at the MS compiler. - -If you are building from a source version of erlang: - - Executing "eval `./otp_build env_win32`" as per the Erlang build - instructions, will have set everything up, including the CC, LD etc - variables. Do this even if erlang is already built and you are just - building couch. This will have set the variables ERL_TOP, CC, LD, AD - and a number of others. - - Then, PATH must be adjusted such what 'which erl' lists the erl.exe - you built rather than the 'erl' script in the erts/etc/win32/cygwin_tools - directory - eg: - - $ export PATH=$ERL_TOP/release/win32/erts-5.7.2/bin:$PATH - -If you are building from a binary version of erlang: - - * set ERL_TOP to the top of the erlang directory - - Add to the PATH such that 'which erl' points at your erl.exe - eg: - - $ export PATH=$ERL_TOP/erts-5.6.5/bin - - You must also ensure the cc.sh etc scripts from the Erlang source tree is - on your PATH. Use "which cc.sh" to ensure the path is set correctly. - - Then set more variables: - $ export CC=cc.sh - $ export LD=ld.sh - $ export AR=ar.sh - $ export RC=rc.sh - -Set COUCHDB_TOP to the source directory. - -And we should be ready to bootstrap and build. - -Building --------- - -We start by bootstrapping: - - $ cd $COUCHDB_TOP - $ ./bootstrap - You have bootstrapped Apache CouchDB, time to relax. - - Run `./configure' to configure the source before you install. - $ - -Relax. - -Now we need to run a complicated configure command-line. - - $ ./configure \ - --with-js-include=/cygdrive/c/path_to_seamonkey_include \ - --with-js-lib=/cygdrive/c/path_to_seamonkey_lib \ - --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \ - --with-erlang=$ERL_TOP/release/win32/usr/include \ - --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \ - --with-openssl-bin-dir=c:/openssl/bin \ - --with-msvc-redist-dir=c:/dir/with/vcredist_platform_executable \ - --prefix=$ERL_TOP/release/win32 - -Relax, then relax some more, then get a beer and relax some more; the -above command may take many many minutes to complete... - -Note that all paths must be in cygwin format. Those starting with $ERL_TOP -can be entered literally, assuming ERL_TOP is set as described above. - -Notes: - When building the installer, the necessary openssl binaries are pulled from - the directory pointed to --with-openssl-bin-dir. - -Now we can build it and "install" it into the $ERL_TOP/release/win32 (or -wherever you set --prefix to above) directory: - - $ make install - -Relax on your new couch: - - The $ERL_TOP/release/win32 directory is now ready to .zip up, be packaged - by an installer, etc. To test it in-place, execute: - - $ $ERL_TOP/release/win32/bin/couchdb.bat - - and everything should work fine. - -To create an installer, execute: - - $ make dist - -and look for etc/windows/setup-couch*.exe. Note - only do this after -a clean build, not after testing in-place - otherwise your test database and -log files will be shipped! - - -Additional Notes: - -Building erlang: -* Follow the instructions as described. You do need openssl, but don't need - the GUI tools. You may like to execute: - - echo "skipping gs" > lib/gs/SKIP - echo "skipping ic" > lib/ic/SKIP - - To skip them. - -* Ensure 'which link' points at the ms linker; one in /usr/bin may be found - instead. - -* After executing './otp_build release -a', be sure to execute Install.exe in - the release/win32 directory to setup the release/win32/bin dir correctly. - -Testing with Erlang -^^^^^^^^^^^^^^^^^^^ - -First, we need to get a copy of etap to run the tests. - - $ git clone git://github.com/ngerakines/etap.git - $ cd etap - $ make && sudo make install - -Now we should be able to run the etap test suite: - - $ cd /path/to/couchdb/ - $ make check - ... - prove test/etap/*.t - test/etap/001-load........................ok - test/etap/010-file-basics.................ok - ... - All tests successful. - Files=28, Tests=363, 41 wallclock secs (...) +For general help, see: -Tests are also available to be run individually like such: + http://couchdb.apache.org/community/lists.html - $ ./test/etap/001-load.t - # Current time local 2009-09-26 23:47:44 - # Using etap version "0.3.4" - 1..39 - ok 1 - Loaded: couch_btree - ... +The mailing lists provide a wealth of support and knowledge for you to tap into. +Feel free to drop by with your questions or discussion. See the official CouchDB +website for more information about our community resources. Cryptographic Software Notice ----------------------------- Modified: couchdb/branches/0.11.x/license.skip URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/license.skip?rev=924478&r1=924477&r2=924478&view=diff ============================================================================== --- couchdb/branches/0.11.x/license.skip (original) +++ couchdb/branches/0.11.x/license.skip Wed Mar 17 20:37:58 2010 @@ -1,15 +1,30 @@ \.svn +^AUTHORS +^BUGS +^CHANGES +^DEVELOPERS +^DEVELOPERS.gz +^INSTALL +^INSTALL.Unix +^INSTALL.Unix.gz +^INSTALL.Windows +^INSTALL.Windows.gz +^INSTALL.gz +^LICENSE.gz +^Makefile +^Makefile.in +^NEWS +^NOTICE +^README +^THANKS ^aclocal.m4 ^apache-couchdb-* -^AUTHORS ^autom4te.cache/* -^bin/couchdb.1 -^bin/couchjs.1 ^bin/Makefile ^bin/Makefile.in -^BUGS +^bin/couchdb.1 +^bin/couchjs.1 ^build-aux/* -^CHANGES ^config.* ^configure ^couchdb.stderr @@ -19,35 +34,30 @@ ^erl_crash.dump ^etc/Makefile ^etc/Makefile.in -^etc/couchdb/default* -^etc/couchdb/local* ^etc/couchdb/Makefile ^etc/couchdb/Makefile.in -^etc/default/couchdb +^etc/couchdb/default* +^etc/couchdb/local* ^etc/default/Makefile ^etc/default/Makefile.in +^etc/default/couchdb ^etc/init/Makefile ^etc/init/Makefile.in -^etc/launchd/org.apache.couchdb.plist.* ^etc/launchd/Makefile ^etc/launchd/Makefile.in -^etc/logrotate.d/couchdb* +^etc/launchd/org.apache.couchdb.plist.* ^etc/logrotate.d/Makefile ^etc/logrotate.d/Makefile.in +^etc/logrotate.d/couchdb* ^etc/windows/README.txt.tpl ^libtool ^license.skip ^m4/ac_check_curl.m4* ^m4/ac_check_icu.m4* -^Makefile -^Makefile.in -^NEWS -^NOTICE -^README ^share/Makefile ^share/Makefile.in -^share/server/mimeparse.js ^share/server/json2.js +^share/server/mimeparse.js ^share/www/favicon.ico ^share/www/image/* ^share/www/script/jquery.* @@ -57,39 +67,38 @@ ^src/Makefile ^src/Makefile.in ^src/couchdb/.*beam -^src/couchdb/couch.app.tpl.in ^src/couchdb/.deps/* -^src/couchdb/couch.app* ^src/couchdb/Makefile ^src/couchdb/Makefile.in -^src/couchdb/priv/.deps/* +^src/couchdb/couch.app* +^src/couchdb/couch.app.tpl.in ^src/couchdb/priv/.*o +^src/couchdb/priv/.deps/* ^src/couchdb/priv/Makefile ^src/couchdb/priv/Makefile.in +^src/couchdb/priv/couch_icu_driver.la ^src/couchdb/priv/couchjs ^src/couchdb/priv/couchspawnkillable -^src/couchdb/priv/couch_icu_driver.la ^src/couchdb/priv/stat_descriptions.cfg ^src/erlang-oauth/* ^src/etap/* ^src/ibrowse/* ^src/mochiweb/* ^stamp-h1 +^test/Makefile +^test/Makefile.in ^test/bench/Makefile ^test/bench/Makefile.in -^test/etap/temp.* ^test/etap/.*beam -^test/local.ini -^test/Makefile -^test/Makefile.in ^test/etap/Makefile ^test/etap/Makefile.in +^test/etap/temp.* ^test/javascript/Makefile ^test/javascript/Makefile.in +^test/local.ini ^test/view_server/Makefile ^test/view_server/Makefile.in ^tmp/* -^THANKS ^utils/Makefile ^utils/Makefile.in ^var/Makefile