diff options
| -rw-r--r-- | DEVELOPMENT | 35 | ||||
| -rw-r--r-- | README | 36 | ||||
| -rw-r--r-- | TROUBLESHOOTING | 52 |
3 files changed, 36 insertions, 87 deletions
diff --git a/DEVELOPMENT b/DEVELOPMENT deleted file mode 100644 index 98278ede..00000000 --- a/DEVELOPMENT +++ /dev/null @@ -1,35 +0,0 @@ -# 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. @@ -233,6 +233,42 @@ your system wide `/Library/LaunchDaemons` directory. Windows documentation is incomplete. Please submit suggestions. +## 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. + [01]: http://www.gnu.org/software/automake/ [02]: http://www.gnu.org/software/autoconf/ [03]: http://www.gnu.org/software/libtool/ diff --git a/TROUBLESHOOTING b/TROUBLESHOOTING deleted file mode 100644 index 78ef7e23..00000000 --- a/TROUBLESHOOTING +++ /dev/null @@ -1,52 +0,0 @@ -# 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. Follow the [checkout instructions][1] to get a fresh copy of trunk. - - 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. - -[1]: http://incubator.apache.org/couchdb/community/code.html |