couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r924431 - in /couchdb/branches/0.11.x: CHANGES DEVELOPERS INSTALL.Unix INSTALL.Windows Makefile.am NEWS README bootstrap etc/init/couchdb.tpl.in license.skip
Date Wed, 17 Mar 2010 19:29:05 GMT
Author: jan
Date: Wed Mar 17 19:29:04 2010
New Revision: 924431

URL: http://svn.apache.org/viewvc?rev=924431&view=rev
Log:
Backport Noah's changes:
  simplified init script options
  initial round of documentation changes
  symlink automake files
  restore INSTALL file to dist
  documentation improvements

Added:
    couchdb/branches/0.11.x/DEVELOPERS
    couchdb/branches/0.11.x/INSTALL.Unix
    couchdb/branches/0.11.x/INSTALL.Windows
Modified:
    couchdb/branches/0.11.x/CHANGES
    couchdb/branches/0.11.x/Makefile.am
    couchdb/branches/0.11.x/NEWS
    couchdb/branches/0.11.x/README
    couchdb/branches/0.11.x/bootstrap
    couchdb/branches/0.11.x/etc/init/couchdb.tpl.in
    couchdb/branches/0.11.x/license.skip

Modified: couchdb/branches/0.11.x/CHANGES
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/CHANGES?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/CHANGES (original)
+++ couchdb/branches/0.11.x/CHANGES Wed Mar 17 19:29:04 2010
@@ -6,7 +6,7 @@ Version 0.11.0
 
 This version has not been released yet.
 
-Security
+Security:
 
  * Added default cookie-authentication and users database.
  * Added Futon user interface for user signup and login.
@@ -15,22 +15,13 @@ Security
    functions.
  * Added proxy authentication handler
 
-HTTP Interface
+HTTP Interface:
 
  * Provide Content-MD5 header support for attachments.
  * Added URL Rewriter handler.
  * Added virtual host handling.
 
-Build and System Integration
-
- * Added support for building a Windows installer as part of 'make dist'.
- * Bug fix for building couch.app's module list.
- * ETap tests are now run during make distcheck. This included a number of
-   updates to the build system to properly support VPATH builds.
- * Gavin McDonald setup a build-bot instance. More info can be found at
-   http://ci.apache.org/buildbot.html
-
-View Server
+View Server:
 
  * Added optional 'raw' binary collation for faster view builds where Unicode
    collation is not important.
@@ -43,27 +34,27 @@ View Server
    support. The new HTTP interaction acts like a synchronous XHR. Example usage
    of the new system is in the JavaScript CLI test runner.
 
-Replication
+Replication:
 
  * Added option to implicitly create replication target databases.
  * Avoid leaking file descriptors on automatic replication restarts.
  * Added option to replicate a list of documents by id.
  * Allow continuous replication to be cancelled.
 
-Storage System
+Storage System:
 
  * Adds batching of multiple updating requests, to improve throughput with many
    writers. Removed the now redundant couch_batch_save module.
  * Adds configurable compression of attachments.
 
-Runtime Statistics
+Runtime Statistics:
 
  * Statistics are now calculated for a moving window instead of non-overlapping
-   timeframes. 
+   timeframes.
  * Fixed a problem with statistics timers and system sleep.
  * Moved statistic names to a term file in the priv directory.
 
-Futon
+Futon:
 
  * Added a button for view compaction.
  * JSON strings are now displayed as-is in the document view, without the escaping of
@@ -76,19 +67,28 @@ Futon
    inserts a tab character at the current caret position.
  * Fixed some font declarations.
 
+Build and System Integration:
+
+ * Added support for building a Windows installer as part of 'make dist'.
+ * Bug fix for building couch.app's module list.
+ * ETap tests are now run during make distcheck. This included a number of
+   updates to the build system to properly support VPATH builds.
+ * Gavin McDonald setup a build-bot instance. More info can be found at
+   http://ci.apache.org/buildbot.html
+
 Version 0.10.1
 --------------
 
-Replicator
+Replicator:
 
  * Stability enhancements regarding redirects, timeouts, OAuth.
 
-Query Server
+Query Server:
 
  * Avoid process leaks
  * Allow list and view to span languages
 
-Stats
+Stats:
 
  * Eliminate new process flood on system wake
 
@@ -99,31 +99,37 @@ Build and System Integration:
 Version 0.10.0
 --------------
 
-Storage Format
+Storage Format:
 
  * Add move headers with checksums to the end of database files for extra robust
    storage and faster storage.
 
-View Server
+View Server:
 
  * Added native Erlang views for high-performance applications.
 
+HTTP Interface:
+
+ * Added optional cookie-based authentication handler.
+ * Added optional two-legged OAuth authentication handler.
+
 Build and System Integration:
 
  * Changed `couchdb` script configuration options.
  * Added default.d and local.d configuration directories to load sequence.
 
-HTTP Interface:
-
- * Added optional cookie-based authentication handler.
- * Added optional two-legged OAuth authentication handler.
 
 Version 0.9.2
 -------------
 
+Replication:
+
+ * Fix replication with 0.10 servers initiated by an 0.9 server (COUCHDB-559).
+
+Build and System Integration:
+
  * Remove branch callbacks to allow building couchjs against newer versions of
    Spidermonkey.
- * Fix replication with 0.10 servers initiated by an 0.9 server (COUCHDB-559).
 
 Version 0.9.1
 -------------
@@ -151,7 +157,7 @@ External Handlers:
 
  * Fix POST requests.
 
-Futon Utility Client:
+Futon:
 
  * Redirect when loading a deleted view URI from the cookie.
 
@@ -296,7 +302,7 @@ Build and System Integration:
  * Updated `sudo` example in `README` to use the `-i` option, this fixes
    problems when invoking from a directory the `couchdb` user cannot access.
 
-Futon Utility Client:
+Futon:
 
  * The view selector dropdown should now work in Opera and Internet Explorer
    even when it includes optgroups for design documents. (COUCHDB-81)
@@ -374,7 +380,7 @@ Build and System Integration:
  * The `couchdb` and `couchjs` scripts have been improved for portability.
  * The build and system integration have been improved for portability.
 
-Futon Utility Client:
+Futon:
 
  * When adding a field to a document, Futon now just adds a field with an
    autogenerated name instead of prompting for the name with a dialog. The name

Added: couchdb/branches/0.11.x/DEVELOPERS
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/DEVELOPERS?rev=924431&view=auto
==============================================================================
--- couchdb/branches/0.11.x/DEVELOPERS (added)
+++ couchdb/branches/0.11.x/DEVELOPERS Wed Mar 17 19:29:04 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.

Added: couchdb/branches/0.11.x/INSTALL.Unix
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/INSTALL.Unix?rev=924431&view=auto
==============================================================================
--- couchdb/branches/0.11.x/INSTALL.Unix (added)
+++ couchdb/branches/0.11.x/INSTALL.Unix Wed Mar 17 19:29:04 2010
@@ -0,0 +1,222 @@
+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.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.
+
+Debian-based (inc. Ubuntu) Systems
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can install the build tools by running:
+
+    sudo apt-get install build-essential
+
+You can install the other dependencies by running:
+
+    sudo apt-get install erlang libicu-dev libmozjs-dev libcurl4-openssl-dev
+
+Be sure to update the version numbers to match your system's available packages.
+
+Mac OS X
+~~~~~~~~
+
+You can install the build tools by running:
+
+    open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
+
+You can install the other dependencies by running:
+
+    sudo port install icu erlang spidermonkey curl
+
+You will need MacPorts installed to use the `port` command.
+
+Installing
+----------
+
+Once you have satisfied the dependencies you should run:
+
+    ./configure
+
+This script will configure CouchDB to be installed into `/usr/local` by default.
+
+If you wish to customise the installation, pass `--help` to this script.
+
+If everything was successful you should see the following message:
+
+    You have configured Apache CouchDB, time to relax.
+
+Relax.
+
+To install CouchDB you should run:
+
+    make && sudo make install
+
+You only need to use `sudo` if you're installing into a system directory.
+
+Try `gmake` if `make` is giving you any problems.
+
+If everything was successful you should see the following message:
+
+    You have installed Apache CouchDB, time to relax.
+
+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
+-----------------------
+
+You should create a special `couchdb` user for CouchDB.
+
+On many Unix-like systems you can run:
+
+    adduser --system \
+            --home /usr/local/var/lib/couchdb \
+            --no-create-home \
+            --shell /bin/bash \
+            --group --gecos \
+            "CouchDB Administrator" couchdb
+
+On Mac OS X you can use the Workgroup Manager to create users:
+
+  http://www.apple.com/support/downloads/serveradmintools1047.html
+
+You must make sure that:
+
+    * The user has a working POSIX shell
+
+    * The user's home directory is `/usr/local/var/lib/couchdb`
+
+You can test this by:
+
+    * Trying to log in as the `couchdb` user
+
+    * Running `pwd` and checking the present working directory
+
+Change the ownership of the CouchDB directories by running:
+
+    chown -R couchdb:couchdb /usr/local/etc/couchdb
+    chown -R couchdb:couchdb /usr/local/var/lib/couchdb
+    chown -R couchdb:couchdb /usr/local/var/log/couchdb
+    chown -R couchdb:couchdb /usr/local/var/run/couchdb
+
+Change the permission of the CouchDB directories by running:
+
+    chmod 0770 /usr/local/etc/couchdb
+    chmod 0770 /usr/local/var/lib/couchdb
+    chmod 0770 /usr/local/var/log/couchdb
+    chmod 0770 /usr/local/var/run/couchdb
+
+Running as a Daemon
+-------------------
+
+SysV/BSD-style Systems
+~~~~~~~~~~~~~~~~~~~~~~
+
+You can use the `couchdb` init script to control the CouchDB daemon.
+
+On SysV-style systems, the init script will be installed into:
+
+    /usr/local/etc/init.d
+
+On BSD-style systems, the init script will be installed into:
+
+    /usr/local/etc/rc.d
+
+We use the `[init.d|rc.d]` notation to refer to both of these directories.
+
+You can control the CouchDB daemon by running:
+
+    /usr/local/etc/[init.d|rc.d]/couchdb [start|stop|restart|status]
+
+If you wish to configure how the init script works, you can edit:
+
+    /usr/local/etc/default/couchdb
+
+Comment out the `COUCHDB_USER` setting if you're running as a non-superuser.
+
+To start the daemon on boot, copy the init script to:
+
+    /etc/[init.d|rc.d]
+
+You should then configure your system to run the init script automatically.
+
+You may be able to run:
+
+    sudo update-rc.d couchdb defaults
+
+If this fails, consult your system documentation for more information.
+
+A `logrotate` configuration is installed into:
+
+    /usr/local/etc/logrotate.d/couchdb
+
+Consult your `logrotate` documentation for more information.
+
+It is critical that the CouchDB logs are rotated so as not to fill your disk.
+
+Mac OS X
+~~~~~~~~
+
+You can use the `launchctl` command to control the CouchDB daemon.
+
+You can load the configuration by running:
+
+    sudo launchctl load \
+         /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+You can stop the CouchDB daemon by running:
+
+    sudo launchctl unload \
+         /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+You can start CouchDB by running:
+
+    sudo launchctl start org.apache.couchdb
+
+You can restart CouchDB by running:
+
+    sudo launchctl stop org.apache.couchdb
+
+You can edit the launchd configuration by running:
+
+    open /usr/local/Library/LaunchDaemons/org.apache.couchdb.plist
+
+To start the daemon on boot, copy the configuration file to:
+
+    /Library/LaunchDaemons
+
+Consult your system documentation for more information.

Added: couchdb/branches/0.11.x/INSTALL.Windows
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/INSTALL.Windows?rev=924431&view=auto
==============================================================================
--- couchdb/branches/0.11.x/INSTALL.Windows (added)
+++ couchdb/branches/0.11.x/INSTALL.Windows Wed Mar 17 19:29:04 2010
@@ -0,0 +1,148 @@
+Apache CouchDB README.Windows
+==============================
+
+For a high-level guide to Microsoft Windows.
+
+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.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
+-------------
+
+ * When installing Erlang, you must build it from source.
+
+   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.
+
+   The Cygwin binaries are incompatible and will not work with Erlang.
+
+Setting Up Cygwin
+-----------------
+
+Before starting any Cygwin terminals, run:
+
+    set CYGWIN=nontsec
+
+To set up your environment, run:
+
+    [VS_BIN]/vcvars32.bat
+
+Replace [VS_BIN] with the path to your Visual Studio `bin` directory.
+
+You must check that:
+
+    * The `which link` command points to the Microsoft linker.
+
+    * 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.
+
+Building Erlang
+---------------
+
+You must include OpenSSL.
+
+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
+
+This will set up the release/win32/bin directory correctly.
+
+To set up your environment for building CouchDB, run:
+
+    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:
+
+    export PATH=$ERL_TOP/release/win32/erts-5.7.2/bin:$PATH
+
+If everything was successful, you should be ready to build CouchDB.
+
+Relax.
+
+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
+
+This command could take a while to complete.
+
+If everything was successful you should see the following message:
+
+    You have configured Apache CouchDB, time to relax.
+
+Relax.
+
+To install CouchDB you should run:
+
+    make install
+
+If everything was successful you should see the following message:
+
+    You have installed Apache CouchDB, time to relax.
+
+Relax.
+
+First Run
+---------
+
+You can start the CouchDB server by running:
+
+    $ERL_TOP/release/win32/bin/couchdb.bat
+
+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.

Modified: couchdb/branches/0.11.x/Makefile.am
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/Makefile.am?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/Makefile.am (original)
+++ couchdb/branches/0.11.x/Makefile.am Wed Mar 17 19:29:04 2010
@@ -12,11 +12,36 @@
 
 SUBDIRS = bin etc src share test var utils
 
-localdoc_DATA = AUTHORS.gz BUGS.gz CHANGES.gz NEWS.gz README.gz THANKS.gz
+localdoc_DATA = \
+    AUTHORS.gz \
+    BUGS.gz \
+    CHANGES.gz \
+    DEVELOPERS.gz \
+    INSTALL.gz \
+    INSTALL.Unix.gz \
+    INSTALL.Windows.gz \
+    LICENSE.gz \
+    NEWS.gz \
+    NOTICE.gz \
+    README.gz \
+    THANKS.gz
 
 DISTCLEANFILES = $(localdoc_DATA)
 
-EXTRA_DIST = AUTHORS BUGS CHANGES LICENSE NEWS NOTICE README THANKS license.skip
+EXTRA_DIST = \
+    AUTHORS \
+    BUGS \
+    CHANGES \
+    DEVELOPERS \
+    INSTALL \
+    INSTALL.Unix \
+    INSTALL.Windows \
+    LICENSE \
+    NEWS \
+    NOTICE \
+    README \
+    THANKS \
+    license.skip
 
 AUTHORS.gz: $(top_srcdir)/AUTHORS
 	-gzip -9 < $< > $@
@@ -27,9 +52,27 @@ BUGS.gz: $(top_srcdir)/BUGS
 CHANGES.gz: $(top_srcdir)/CHANGES
 	-gzip -9 < $< > $@
 
+DEVELOPERS.gz: $(top_srcdir)/DEVELOPERS
+	-gzip -9 < $< > $@
+
+INSTALL.gz: $(top_srcdir)/INSTALL
+	-gzip -9 < $< > $@
+
+INSTALL.Unix.gz: $(top_srcdir)/INSTALL.Unix
+	-gzip -9 < $< > $@
+
+INSTALL.Windows.gz: $(top_srcdir)/INSTALL.Windows
+	-gzip -9 < $< > $@
+
+LICENSE.gz: $(top_srcdir)/LICENSE
+	-gzip -9 < $< > $@
+
 NEWS.gz: $(top_srcdir)/NEWS
 	-gzip -9 < $< > $@
 
+NOTICE.gz: $(top_srcdir)/NOTICE
+	-gzip -9 < $< > $@
+
 README.gz: $(top_srcdir)/README
 	-gzip -9 < $< > $@
 
@@ -59,6 +102,10 @@ dev: all
 	mkdir -p $(top_builddir)/tmp/log
 	mkdir -p $(top_builddir)/tmp/run/couchdb
 
+install-data-hook:
+	@echo
+	@echo "You have installed Apache CouchDB, time to relax."
+
 distclean-local:
 	rm -fr $(top_builddir)/tmp
 

Modified: couchdb/branches/0.11.x/NEWS
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/NEWS?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/NEWS (original)
+++ couchdb/branches/0.11.x/NEWS Wed Mar 17 19:29:04 2010
@@ -46,8 +46,7 @@ This version has not been released yet.
  * Added ability to replicate documents by id.
  * Added virtual host handling.
  * Query server uses json2.js for JSON serialization compatiblity with native JSON.
- 
- 
+
 Version 0.10.1
 --------------
 

Modified: couchdb/branches/0.11.x/README
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/README?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/README (original)
+++ couchdb/branches/0.11.x/README Wed Mar 17 19:29:04 2010
@@ -1,56 +1,8 @@
 Apache CouchDB README
 =====================
 
-Apache CouchDB is beta software and still under heavy development. Please be
-aware that important areas such as the public API or internal database format
-may see backwards incompatible changes between versions.
-
-Building From Checkout
-----------------------
-
-You can skip this section if you are installing from a release tarball.
-
-Dependencies
-~~~~~~~~~~~~
-
-To build Apache CouchDB from checkout you need some of 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/)
-
-Debian-based (inc. Ubuntu) Systems
-++++++++++++++++++++++++++++++++++
-
-You can install the dependencies by running:
-
-    apt-get install automake autoconf libtool help2man
-
-Mac OS X
-++++++++
-
-You can install the dependencies using MacPorts by running:
-
-    port install automake autoconf libtool help2man
-
-Bootstrapping
-~~~~~~~~~~~~~
-
-Note: You must repeat this step every time you update your checkout.
-
-Bootstrap the pristine source by running:
-
-    ./bootstrap
-
-Installation and First Run
---------------------------
-
-Unix-like Operating Systems (inc. Mac OS X)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Dependencies
-^^^^^^^^^^^^
+Installation
+------------
 
 To build and install Apache CouchDB you will need the following installed:
 
@@ -64,136 +16,42 @@ To build and install Apache CouchDB you 
 
 It is recommended that you install Erlang OTP R12B-5 or above where possible.
 
-Debian-based (inc. Ubuntu) Systems
-++++++++++++++++++++++++++++++++++
-
-You can install the dependencies by running:
-
-    apt-get install build-essential erlang libicu-dev libmozjs-dev libcurl4-openssl-dev
-
-If you get an error regarding the `libicu38` or `libicu-dev` be sure to check
-the version used by your distribution (using `apt-cache search libicu`) and
-install those packages instead. `libcurl4-openssl-dev` is the current version of
-`libcurl-dev` supplied by Ubuntu. You may need to specify an alternate package
-name for libcurl bindings.
-
-Mac OS X
-++++++++
-
-To install GNU Make and the GNU Compiler Collection on Mac OS X you should
-install the Xcode Tools metapackage by running:
-
-    open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg
-
-You can install the dependencies using MacPorts by running:
-
-    port install icu erlang spidermonkey curl
-
-Installing
-^^^^^^^^^^
-
-Once you have satisfied the dependencies you should run:
+General installation instructions:
 
-    ./configure
+For a low-level guide, see:
 
-Note: Apache CouchDB is installed into `/usr/local` by default. If you want to
-change where Apache CouchDB is installed (or where to find Erlang) be sure to
-read the output from running the `./configure --help` command.
+    INSTALL
 
-Note: All the examples assume you have installed into `/usr/local`.
+For a high-level guide to Unix-like systems, inc. Mac OS X and Ubuntu, see:
 
-If everything was successful you should see the following message:
+    INSTALL.Unix
 
-    You have configured Apache CouchDB, time to relax.
+For a high-level guide to Microsoft Windows, see:
 
-Relax.
-
-To install Apache CouchDB you should then run the following command:
-
-    make && sudo make install
-
-Note: The use of the `sudo` command is only required if you are installing into
-a system owned directory. You do not need to do this if you are installing
-elsewhere, such as your home directory.
-
-If you are having problems running `make` you may want to try running `gmake` if
-this is available on your system.
-
-More options can be found by reading the `INSTALL` file.
-
-Security Considerations
-^^^^^^^^^^^^^^^^^^^^^^^
-
-It is not advisable to run Apache CouchDB as the superuser. We strongly
-recommend that you create a specific user to run Apache CouchDB and own the
-data/log directories.
-
-You can use whatever tool your system provides to create a new `couchdb` user.
-
-On many Unix-like systems you can run:
-
-    adduser --system --home /usr/local/var/lib/couchdb --no-create-home \
-            --shell /bin/bash --group --gecos "CouchDB Administrator" couchdb
-
-Mac OS X provides the standard Accounts option from the System Preferences
-application or you can optionally use the Workgroup Manager application which
-can be downloaded as part of the Server Admin Tools:
-
-  http://www.apple.com/support/downloads/serveradmintools1047.html
-
-You should make sure that the `couchdb` user has a working POSIX shell and set
-the home directory to `/usr/local/var/lib/couchdb` which is the Apache CouchDB
-database directory.
-
-Change the ownership of the Apache CouchDB directories by running:
-
-    chown -R couchdb:couchdb /usr/local/etc/couchdb
-    chown -R couchdb:couchdb /usr/local/var/lib/couchdb
-    chown -R couchdb:couchdb /usr/local/var/log/couchdb
-    chown -R couchdb:couchdb /usr/local/var/run/couchdb
+    INSTALL.Windows
 
-Change the permission of the Apache CouchDB directories by running:
+Follow the proper instructions to get CouchDB installed on your system.
 
-    chmod -R 0770 /usr/local/etc/couchdb
-    chmod -R 0770 /usr/local/var/lib/couchdb
-    chmod -R 0770 /usr/local/var/log/couchdb
-    chmod -R 0770 /usr/local/var/run/couchdb
-
-Running Manually
-^^^^^^^^^^^^^^^^
-
-You can start the Apache CouchDB server by running:
-
-    sudo -i -u couchdb couchdb -b
-
-This uses the `sudo` command to run the `couchdb` command as the `couchdb` user.
-
-When Apache 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.
+If you're having problems, skip to the next section.
 
 Troubleshooting
-^^^^^^^^^^^^^^^
+----------------
 
-If you're getting a cryptic error message, visit the wiki:
+For troubleshooting, see:
 
-  http://wiki.apache.org/couchdb/Error_messages
+    http://wiki.apache.org/couchdb/Troubleshooting
 
-For general troubleshooting, visit the wiki:
+If you're getting a cryptic error message, see:
 
-  http://wiki.apache.org/couchdb/Troubleshooting
+    http://wiki.apache.org/couchdb/Error_messages
 
-Running as a Daemon
-^^^^^^^^^^^^^^^^^^^
+<<<<<<< HEAD:README
+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.
 
@@ -454,10 +312,20 @@ Tests are also available to be run indiv
     1..39
     ok 1  - Loaded: couch_btree
     ...
+=======
+For general help, see:
+
+     http://couchdb.apache.org/community/lists.html
+
+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.
+>>>>>>> f3303f2... documentation improvements:README
 
 Cryptographic Software Notice
 -----------------------------
 
+<<<<<<< HEAD:README
    This distribution includes cryptographic software.  The country in
    which you currently reside may have restrictions on the import,
    possession, use, and/or re-export to another country, of
@@ -481,3 +349,25 @@ Cryptographic Software Notice
    software:
 
    CouchDB includes a HTTP client (ibrowse) with SSL functionality.
+=======
+This distribution includes cryptographic software. The country in which you
+currently reside may have restrictions on the import, possession, use, and/or
+re-export to another country, of encryption software. BEFORE using any
+encryption software, please check your country's laws, regulations and policies
+concerning the import, possession, or use, and re-export of encryption software,
+to see if this is permitted. See <http://www.wassenaar.org/> for more
+information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and Security
+(BIS), has classified this software as Export Commodity Control Number (ECCN)
+5D002.C.1, which includes information security software using or performing
+cryptographic functions with asymmetric algorithms. The form and manner of this
+Apache Software Foundation distribution makes it eligible for export under the
+License Exception ENC Technology Software Unrestricted (TSU) exception (see the
+BIS Export Administration Regulations, Section 740.13) for both object code and
+source code.
+
+The following provides more details on the included cryptographic software:
+
+CouchDB includes a HTTP client (ibrowse) with SSL functionality.
+>>>>>>> df02faf... initial round of documentation changes:README

Modified: couchdb/branches/0.11.x/bootstrap
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/bootstrap?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/bootstrap (original)
+++ couchdb/branches/0.11.x/bootstrap Wed Mar 17 19:29:04 2010
@@ -56,9 +56,11 @@ fi
 
 aclocal -I m4
 autoheader -f
-automake -f -c -a --gnits 2>&1 | sed -e "/install/d"
+automake -f -a 2>&1 | sed -e "/install/d"
 autoconf -f
 
+ln -f -s "`dirname \`readlink build-aux/missing\``/INSTALL"
+
 cat << EOF
 You have bootstrapped Apache CouchDB, time to relax.
 

Modified: couchdb/branches/0.11.x/etc/init/couchdb.tpl.in
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/etc/init/couchdb.tpl.in?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/etc/init/couchdb.tpl.in (original)
+++ couchdb/branches/0.11.x/etc/init/couchdb.tpl.in Wed Mar 17 19:29:04 2010
@@ -141,7 +141,7 @@ parse_script_option_list () {
                 log_end_msg $SCRIPT_ERROR
             fi
             ;;
-        restart|force-reload)
+        restart)
             log_daemon_msg "Restarting $DESCRIPTION" $NAME
             if stop_couchdb; then
                 if start_couchdb; then
@@ -158,7 +158,7 @@ parse_script_option_list () {
             ;;
         *)
             cat << EOF >&2
-Usage: $SCRIPT_NAME {start|stop|restart|force-reload|status}
+Usage: $SCRIPT_NAME {start|stop|restart|status}
 EOF
             exit $SCRIPT_ERROR
             ;;

Modified: couchdb/branches/0.11.x/license.skip
URL: http://svn.apache.org/viewvc/couchdb/branches/0.11.x/license.skip?rev=924431&r1=924430&r2=924431&view=diff
==============================================================================
--- couchdb/branches/0.11.x/license.skip (original)
+++ couchdb/branches/0.11.x/license.skip Wed Mar 17 19:29:04 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



Mime
View raw message