diff options
| author | Noah Slater <nslater@apache.org> | 2008-03-30 02:14:29 +0000 |
|---|---|---|
| committer | Noah Slater <nslater@apache.org> | 2008-03-30 02:14:29 +0000 |
| commit | c17bae2a8607479a9f8df7fc9e6defde2078909f (patch) | |
| tree | 454a25ea60bba0a861a7edf5ed7657f76a2e24af | |
| parent | a14b46824adcc717573391ec403ba4ce401d5772 (diff) | |
rewrote and improved core documentation for clarity, utility and compatibility with Markdown
git-svn-id: https://svn.apache.org/repos/asf/incubator/couchdb/trunk@642660 13f79535-47bb-0310-9956-ffa450edef68
| -rw-r--r-- | AUTHORS | 24 | ||||
| -rw-r--r-- | BUGS | 13 | ||||
| -rw-r--r-- | DEVELOPMENT | 35 | ||||
| -rw-r--r-- | NEWS | 59 | ||||
| -rw-r--r-- | NOTICE | 41 | ||||
| -rw-r--r-- | README | 287 | ||||
| -rw-r--r-- | THANKS | 11 | ||||
| -rw-r--r-- | TROUBLESHOOTING | 52 | ||||
| -rw-r--r-- | authors.xml | 21 |
9 files changed, 232 insertions, 311 deletions
@@ -1,25 +1,15 @@ -Apache CouchDB Authors -====================== +# Authors # -Project Lead ------------- - -Apache CouchDB was originally developed by Damien Katz <damien_katz@yahoo.com> -and he remains the project lead. - -Contributers ------------- +Apache CouchDB was originally developed by Damien Katz <damien@apache.org> and +he remains the project lead. A number of people have contributed directly to Apache CouchDB by writing documentation or developing software. A list of these people is included below. * William Beh <willbeh@gmail.com> - * Jan Lehnardt <janlehnardt@gmail.com> - * Christopher Lenz <cmlenz@gmx.de> + * Jan Lehnardt <jan@apache.org> + * Christopher Lenz <cmlenz@apache.org> * Dirk Schalge <dirk@epd-me.net> - * Noah Slater <nslater@bytesexual.org> - -See Also --------- + * Noah Slater <nslater@apache.org> -For a list of other credits see the `THANKS' file. +For a list of other credits see the `THANKS` file. @@ -1,12 +1,5 @@ -Apache CouchDB Bugs -=================== +# Bugs # -Web ---- +Report bugs via [the web](http://groups.google.com/group/couchdb). -Report bugs via the web at <http://groups.google.com/group/couchdb>. - -Email ------ - -Report bugs via email to <couchdb@googlegroups.com>. +Report bugs via [email](couchdb@googlegroups.com). diff --git a/DEVELOPMENT b/DEVELOPMENT new file mode 100644 index 00000000..98278ede --- /dev/null +++ b/DEVELOPMENT @@ -0,0 +1,35 @@ +# Development # + +## Reconfiguring the Build System ## + +If you have edited any of the files used by the build system, such as the +`Makefile.am` files, you will need to reconfigure your source. + +To reconfigure the source run the following command from the root directory: + + autoreconf && ./confgure + +## Checking In Changes ## + +If your source directory has been configured or built you will need to clean +the generated files before checking into the repository by running the +following command: + + make local-clean + +If everything was successful you should now have a pristine checkout. + +## Preparing For Distribution ## + +To build the source for distribution you should then run the following command: + + ./configure && make distcheck + +If everything was successful you should see a `zip` file and/or a `tar.gz` file +sitting in the root directory ready for distribution. + +## Release Checklist ## + + 1. Update the `README` file with important information. + 2. Update the `NEWS` file with change information. + 3. Update the `acinclude.m4` file with version information. @@ -1,75 +1,70 @@ -Apache CouchDB News -=================== +# News # -Version 0.7.3a1 --------------- +## Version 0.7.3a1 ## + +This version is unreleased and only available from the source repository. * Changed core licensing to the Apache License 2.0. - * Improved handling of ICU shared libraries. - * Apache CouchDB can automatically respawn following a server crash. - * Apache CouchDB no longer refuses to start with a stale PID file. + * Miscellaneous refactoring of the core Erlang database engine. + * Miscellaneous improvements to Futon, the web administration console. + * Miscellaneous improvements to the `couchdb` command. + * Database server can automatically respawn following a server crash. + * Database server no longer refuses to start with a stale PID file. * System logrotate configuration provided. - * Miscellaneous improvements to the `couchdb' command. + * Improved handling of ICU shared libraries. -Version 0.7.2 -------------- +## Version 0.7.2 ## - * Small changes to build process and couchdb command. - * CouchDB's official port is now 5984 TCP/UDP instead of 8888. + * Small changes to build process and `couchdb` command. + * Database server official port is now 5984 TCP/UDP instead of 8888. -Version 0.7.1 -------------- +## Version 0.7.1 ## * Small compatibility issue with Firefox 3 fixed. -Version 0.7.0 -------------- +## Version 0.7.0 ## - * CouchDB has been rewritten to use the GNU build system for portability. + * Infrastructure rewritten to use the GNU build system for portability. * The built-in database browsing tool has been rewritten to provide a much nicer interface for interacting directly with CouchDB from your web browser. * XML and Fabric have been replaced with JSON and JavaScript for data transport and View definitions. -Version 0.6.0 -------------- +## Version 0.6.0 ## * A replication facility is now available. * CouchPeek can now create, delete and view documents. * Building from source is easier and less error prone. -Version 0.5.0 -------------- +## Version 0.5.0 ## * A built-in CouchPeek utility. * A full install kit buildable from a single command. * A new GNU/Linux version is available. An OS X version is coming soon. -Version 0.4.0 -------------- +## Version 0.4.0 ## * Non-existant variables are now nil lists. * Couch error codes and messages are no longer sent in the HTTP fields, instead they are exclusively returned in the XML body. This is to avoid HTTP header parsing problems with oddly formed error messages. - * Returned error messages are now logged at the server at the `info' level to + * Returned error messages are now logged at the server at the `info` level to make general debugging easier. * Fixed a problem where big table builds caused timesout errors. * Lots of changes in the low level machinery. Most formulas will continue to function the same. * Added full compiler support for extended characters in formula source. * Support for Perl/Ruby like regular expressions. - * Added `total_rows' and `result_start' attributes to tables. + * Added `total_rows` and `result_start` attributes to tables. -Version 0.3.0 -------------- +## Version 0.3.0 ## * CouchDB now fully supports Unicode and locale specific collation via the ICU library, both in the Fabric engine and computed tables. - * The `in' operator has been added to Fabric. - * The `startdoc' query string variable specifies the starting document to use if + * The `in` operator has been added to Fabric. + * The `startdoc` query string variable specifies the starting document to use if there are multiple rows with identical startkeys. - * The `skip' query string variable specifies the number of rows to skip before - returning results. The `skip' value must be a positive integer. If used with - a `count' variable the skipped rows aren't counted as output. + * The `skip` query string variable specifies the number of rows to skip before + returning results. The `skip` value must be a positive integer. If used with + a `count` variable the skipped rows aren't counted as output. * Various changes to the output XML format. @@ -1,34 +1,17 @@ -Apache CouchDB Notice -===================== +# Notice # -Core Software -------------- +Developed at [The Apache Software Foundation](http://www.apache.org/). - * Copyright (C) 2008 Damien Katz <damien_katz@yahoo.com> - * Copyright (C) 2008 Jan Lehnardt <jan@php.net> - * Copyright (C) 2008 Noah Slater <nslater@bytesexual.org> +Core software: -Developed at The Apache Software Foundation <http://www.apache.org/>. + * Copyright (C) 2008 Damien Katz <damien@apache.org>. + * Copyright (C) 2008 Jan Lehnardt <jan@apache.org>. + * Copyright (C) 2008 Christopher Lenz <cmlenz@apache.org>. + * Copyright (C) 2008 Noah Slater <nslater@apache.org>. -Supporting Software -------------------- +Supporting software: -m4/ac_check_icu.m4 -~~~~~~~~~~~~~~~~~~ - - * Copyright (C) 2005 Akos Maroy <darkeye@tyrell.hu> - -share/www/script/jquery.js -~~~~~~~~~~~~~~~~~~~~~~~~~~ - - * Copyright (C) 2008 John Resig - -share/www/script/json2.js -~~~~~~~~~~~~~~~~~~~~~~~~~ - -This file is in the public domain. - -src/couch_inets -~~~~~~~~~~~~~~~ - - * Copyright (C) 1999 Ericsson Utvecklings AB + * m4/ac_check_icu.m4 (Copyright (C) 2005 Akos Maroy <darkeye@tyrell.hu>.) + * share/www/script/jquery.js (Copyright (C) 2008 John Resig.) + * share/www/script/json2.js (This file is in the public domain.) + * src/couch_inets (Copyright (C) 1999 Ericsson Utvecklings AB.) @@ -1,343 +1,232 @@ -Apache CouchDB Readme -===================== +# Readme # -Documentation -------------- +## Building From Subversion ## -Visit the wiki <http://www.couchdbwiki.com/> for more documentation. - -Building From Subversion ------------------------- - -Dependencies -~~~~~~~~~~~~ +### 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/> (required) - * GNU Autoconf (>=2.59) <http://www.gnu.org/software/autoconf/> (required) - * GNU Libtool <http://www.gnu.org/software/libtool/> (required) - * svn2cl <http://ch.tudelft.nl/~arthur/svn2cl/> (optional) - * xsltproc <http://xmlsoft.org/XSLT/xsltproc2.html> (optional) - * help2man <http://www.gnu.org/software/help2man/> (optional) + * [GNU Automake](http://www.gnu.org/software/automake/) (>=1.6.3) (required) + * [GNU Autoconf](http://www.gnu.org/software/autoconf/) (>=2.59) (required) + * [GNU Libtool](http://www.gnu.org/software/libtool/) (required) + * [svn2cl](http://ch.tudelft.nl/~arthur/svn2cl/) (optional) + * [xsltproc](http://xmlsoft.org/XSLT/xsltproc2.html) (optional) + * [help2man](http://www.gnu.org/software/help2man/) (optional) If you are running a Debian GNU/Linux system (or a derivative such as Ubuntu -GNU/Linux) you can install these dependencies using the `apt-get' command: +GNU/Linux) you can install these dependencies using the `apt-get` command: --------------------------------------------------------------------------------- -apt-get install automake autoconf libtool subversion-tools help2man --------------------------------------------------------------------------------- + apt-get install automake autoconf libtool subversion-tools help2man -If you are running OS X and have MacPorts <http://www.macports.org/> installed -you can install some of these dependencies by using the `port' command: +If you are running OS X and have [MacPorts](http://www.macports.org/) installed +you can install some of these dependencies by using the `port` command: --------------------------------------------------------------------------------- -port install automake autoconf libtool help2man --------------------------------------------------------------------------------- + port install automake autoconf libtool help2man Note: OS X users should already have Automake, Autoconf and Libtool installed. Note: MacPorts users will need to install svn2cl by hand. -Bootstrapping -~~~~~~~~~~~~~ +### Bootstrapping ### Note: You must repeat this step every time you update your Subversion checkout. Bootstrap the pristine source by running the following command: --------------------------------------------------------------------------------- -./bootstrap --------------------------------------------------------------------------------- + ./bootstrap -You can use the `-C' option to generate a dummy `ChangeLog' file. +You can use the `-C` option to generate a dummy `ChangeLog` file. -Installation And First Run --------------------------- +## Installation And First Run ## You will need the following installed: - * Erlang OTP <http://erlang.org/> (required) - * ICU <http://icu.sourceforge.net/> (required) - * Mozilla SpiderMonkey <http://www.mozilla.org/js/spidermonkey/> (required) - * GNU Make <http://www.gnu.org/software/make/> (required) - * GNU Compiler Collection <http://gcc.gnu.org/> (required) + * [Erlang OTP](http://erlang.org/) (required) + * [ICU](http://icu.sourceforge.net/) (required) + * [Mozilla SpiderMonkey](http://www.mozilla.org/js/spidermonkey/) (required) + * [GNU Make](http://www.gnu.org/software/make/) (required) + * [GNU Compiler Collection](http://gcc.gnu.org/) (required) -UNIX-like Operating Systems (inc. OS X) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +### UNIX-like Operating Systems (inc. OS X) ### -Dependencies -^^^^^^^^^^^^ +#### Dependencies #### -Debian-based (inc. Ubuntu) Systems -++++++++++++++++++++++++++++++++++ +##### Debian-based (inc. Ubuntu) Systems ##### If you are running a Debian GNU/Linux system (or a derivative such as Ubuntu -GNU/Linux) you can install the dependencies using the `apt-get' command: +GNU/Linux) you can install the dependencies using the `apt-get` command: --------------------------------------------------------------------------------- -apt-get install build-essential erlang libicu36 libicu36-dev libmozjs-dev --------------------------------------------------------------------------------- + apt-get install build-essential erlang libicu36 libicu36-dev libmozjs-dev -If you get an error regarding the `libicu36' or `libicu36-dev' be sure to check -the version used by your distribution (using `apt-cache search libicu') and +If you get an error regarding the `libicu36` or `libicu36-dev` be sure to check +the version used by your distribution (using `apt-cache search libicu`) and install those packages instead. -OS X -++++ +##### OS X ##### To install GNU Make and the GNU Compiler Collection on OS X you should install the Xcode Tools metapackage by running the following command: --------------------------------------------------------------------------------- -open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg --------------------------------------------------------------------------------- + open /Applications/Installers/Xcode\ Tools/XcodeTools.mpkg -We recommend that you satisfy the other dependancies by installing MacPorts -<http://www.macports.org/> and running the following command: +We recommend that you satisfy the other dependancies by installing +[MacPorts](http://www.macports.org/) and running the following command: --------------------------------------------------------------------------------- -port install icu erlang spidermonkey --------------------------------------------------------------------------------- + port install icu erlang spidermonkey Note: Don't forget to open a new terminal after you have installed MacPorts -as it updates your PATH and you will not be able to run the `port' command +as it updates your PATH and you will not be able to run the `port` command without the effects of this change. -To update your `locate' database you may want to run the following command: +To update your `locate` database you may want to run the following command: --------------------------------------------------------------------------------- -sudo /usr/libexec/locate.updatedb --------------------------------------------------------------------------------- + sudo /usr/libexec/locate.updatedb -Installing -^^^^^^^^^^ +#### Installing #### Once you have satisfied dependencies you should run the following command: --------------------------------------------------------------------------------- -./configure --------------------------------------------------------------------------------- + ./configure -Note: Apache CouchDB is installed into `/usr/local' by default. If you want to +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. +read the output from running the `./configure --help` command. -Note: All the examples assume you have installed into `/usr/local'. +Note: All the examples assume you have installed into `/usr/local`. If everything was successful you should see the following message: --------------------------------------------------------------------------------- -You have configured Apache CouchDB. Time to relax. --------------------------------------------------------------------------------- + You have configured Apache CouchDB. Time to relax. Relax. To install Apache CouchDB you should then run the following command: --------------------------------------------------------------------------------- -make && sudo make install --------------------------------------------------------------------------------- + make && sudo make install If you do not wish to be prompted to overwrite any existing Apache CouchDB configuration files you should run the following command: --------------------------------------------------------------------------------- -sudo make && yes | sudo make install --------------------------------------------------------------------------------- + sudo make && yes | sudo make install -Note: Use of the `sudo' command is only required if you are installing into a +Note: 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. -More options can be found by reading the `INSTALL' file. +More options can be found by reading the `INSTALL` file. -Security Considerations -^^^^^^^^^^^^^^^^^^^^^^^ +#### 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. +You can use whatever tool your system provides to create a new `couchdb` user. On many UNIX-like systems you can run the following command: --------------------------------------------------------------------------------- -adduser couchdb --------------------------------------------------------------------------------- + adduser couchdb 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>. +can be downloaded as part of the [Server Admin Tools]( +http://www.apple.com/support/downloads/serveradmintools1047.html). -You should set the home directory of the `couchdb' user to -`/usr/local/var/lib/couchdb' which is the Apache CouchDB database directory. +You should set the home directory of the `couchdb` user to +`/usr/local/var/lib/couchdb` which is the Apache CouchDB database directory. Make sure to change the ownership of the Apache CouchDB data directories by running the following commands: --------------------------------------------------------------------------------- -chown -R couchdb /usr/local/var/lib/couchdb -chown -R couchdb /usr/local/var/log/couchdb --------------------------------------------------------------------------------- + chown -R couchdb /usr/local/var/lib/couchdb + chown -R couchdb /usr/local/var/log/couchdb -Running Manually -^^^^^^^^^^^^^^^^ +#### Running Manually #### To start the Apache CouchDB server you should run the following command: --------------------------------------------------------------------------------- -sudo -u couchdb couchdb --------------------------------------------------------------------------------- + sudo -u couchdb couchdb -This uses the `sudo' command to run the `couchdb' command as the `couchdb' user. +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. --------------------------------------------------------------------------------- + Apache CouchDB has started. Time to relax. Relax. To check that everything has worked point your web browser to -<http://localhost:5984/_utils/index.html> and run the test suite. +http://localhost:5984/_utils/index.html and run the test suite. -OS X -++++ +##### OS X ##### If you get error when running Apache CouchDB that look like the following: --------------------------------------------------------------------------------- -dyld: Library not loaded: libicuuc.38.dy --------------------------------------------------------------------------------- + dyld: Library not loaded: libicuuc.38.dy -You should make sure that your `~/.profile' file contains the following line: +You should make sure that your `~/.profile` file contains the following line: --------------------------------------------------------------------------------- -export DYLD_LIBRARY_PATH=/opt/local/lib:$DYLD_LIBRARY_PATH --------------------------------------------------------------------------------- + export DYLD_LIBRARY_PATH=/opt/local/lib:$DYLD_LIBRARY_PATH This should have been added for you by MacPorts but may be missing. -Running as a Daemon -^^^^^^^^^^^^^^^^^^^ +#### Running as a Daemon #### -Note: These instructions assume you have created the `couchdb' user. See the +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' +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 +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 -++++++++++++++++++++++ +##### 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. +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 the following command: --------------------------------------------------------------------------------- -/usr/local/etc/[init.d|rc.d]/couchdb [start|stop|restart|force-reload|status] --------------------------------------------------------------------------------- + /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 +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. +remove the line with the `COUCHDB_USER` setting. If you wish the ApacheCouchDB 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 as +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 as appropriate. Consult your system documentation for more information. If you are running a Debian GNU/Linux system (or a derivative such as Ubuntu GNU/Linux) you can configure your system using the following command: --------------------------------------------------------------------------------- -sudo update-rc.d couchdb defaults --------------------------------------------------------------------------------- + sudo update-rc.d couchdb defaults -OS X -++++ +##### OS X ##### -You can use the `launchctl' command to control the Apache CouchDB daemon. +You can use the `launchctl` command to control the Apache CouchDB daemon. To load the launchd configuration you must run the following command: --------------------------------------------------------------------------------- -sudo launchctl load /usr/local/Library/LaunchDaemons/org.apache.couchdb --------------------------------------------------------------------------------- + sudo launchctl load /usr/local/Library/LaunchDaemons/org.apache.couchdb You can stop the Apache CouchDB daemon by running the following command: --------------------------------------------------------------------------------- -sudo launchctl unload /usr/local/Library/LaunchDaemons/org.apache.couchdb --------------------------------------------------------------------------------- + sudo launchctl unload /usr/local/Library/LaunchDaemons/org.apache.couchdb If you wish to change the launchd configuration, such as which user to run Apache CouchDB as, you must edit the -`/usr/local/Library/LaunchDaemons/org.apache.couchdb.plist' file as +`/usr/local/Library/LaunchDaemons/org.apache.couchdb.plist` file as appropriate. If you wish the Apache CouchDB daemon to run as a system service you need to -copy the `/usr/local/Library/LaunchDaemons/org.apache.couchdb.plist' file into -your system wide `/Library/LaunchDaemons' directory. +copy the `/usr/local/Library/LaunchDaemons/org.apache.couchdb.plist` file into +your system wide `/Library/LaunchDaemons` directory. -Windows -~~~~~~~ +### Windows ### Windows documentation is incomplete. Please submit suggestions. - -Development and Distribution ----------------------------- - -Reconfiguring the Build System -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you have edited any of the files used by the build system, such as the -`Makefile.am' files, you will need to reconfigure your source. - -To reconfigure the source run the following command from the root directory: - --------------------------------------------------------------------------------- -autoreconf && ./confgure --------------------------------------------------------------------------------- - -Checking In Changes -~~~~~~~~~~~~~~~~~~~ - -If your source directory has been configured or built you will need to clean -the generated files before checking into the repository by running the -following command: - --------------------------------------------------------------------------------- -make local-clean --------------------------------------------------------------------------------- - -If everything was successful you should now have a pristine checkout. - -Preparing For Distribution -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To build the source for distribution you should then run the following command: - --------------------------------------------------------------------------------- -./configure && make distcheck --------------------------------------------------------------------------------- - -If everything was successful you should see a `zip' file and/or a `tar.gz' file -sitting in the root directory ready for distribution. - -Release Checklist -~~~~~~~~~~~~~~~~~ - - 1. Update this file with important information. - 2. Update the `NEWS' file with change information. - 3. Update the `acinclude.m4' file with version information. @@ -1,8 +1,4 @@ -Apache CouchDB Thanks -===================== - -Credits -------- +# Thanks # Apache CouchDB was originally developed by Damien Katz <damien_katz@yahoo.com> and a number of other contributors. Many people further contributed to Apache @@ -15,7 +11,4 @@ changes. A list of these people is included below. * Sam Ruby <rubys@intertwingly.net> * Carlos Valiente <superdupont@gmail.com> -See Also --------- - -For a list of authors see the `AUTHORS' file. +For a list of authors see the `AUTHORS` file. diff --git a/TROUBLESHOOTING b/TROUBLESHOOTING new file mode 100644 index 00000000..e7582b12 --- /dev/null +++ b/TROUBLESHOOTING @@ -0,0 +1,52 @@ +# Troubleshooting # + +## Upgrade ## + +Have you built CouchDB from the Subversion repository? + +Did you do a svn up that seemed to break everything? + +After every update you must run the following command: + + ./bootstrap -C + +If you still have problems building try the next troubleshooting tip. + +## First Run ## + +Having problems getting CouchDB to run for the first time? + +Follow this simple procedure and report back to mailing list (or IRC) with the +output of each step. + + 1. Note down the name of your operating system and your processor + architecture. + + 2. Note down the installed versions of CouchDB's dependancies. + + 3. Checkout a fresh version from Subversion: + + svn checkout http://couchdb.googlecode.com/svn/trunk/ couchdb + + 4. Bootstrap from the couchdb directory: + + ./bootstrap -C + + 5. Build into a temporary directory: + + ./configure --prefix=/tmp/couchdb && make && make install + + 6. Run the couchdb command and log the output: + + /tmp/couchdb/bin/couchdb + + 7. Use your system's kernel trace tool and log the output of the above + command. + + 1. Linux systems should use strace: + + strace /tmp/couchdb/bin/couchdb 2> strace.out + + 2. Please add documentation for your system... + + 8. Report back to the mailing list (or IRC) with the output from each step. diff --git a/authors.xml b/authors.xml index 0e77cfbf..7eb750dc 100644 --- a/authors.xml +++ b/authors.xml @@ -1,24 +1,15 @@ <?xml version="1.0" encoding="utf-8"?> <authors> - <author uid="willbeh"> - William Beh <willbeh@gmail.com> + <author uid="damien"> + Damien Katz <damien@apache.org> </author> - <author uid="damienkatz"> - Damien Katz <damien_katz@yahoo.com> - </author> - <author uid="JanLehnardt"> - Jan Lehnardt <janlehnardt@gmail.com> + <author uid="jan"> + Jan Lehnardt <jan@apache.org> </author> <author uid="cmlenz"> - Christopher Lenz <cmlenz@gmx.de> - </author> - <author uid="DirkSchalge"> - Dirk Schalge <dirk@epd-me.net> + Christopher Lenz <cmlenz@apache.org> </author> <author uid="nslater"> - Noah Slater <nslater@bytesexual.org> - </author> - <author uid="nslater@bytesexual.org"> - Noah Slater <nslater@bytesexual.org> + Noah Slater <nslater@apache.org> </author> </authors> |