Skip to content

Commit

Permalink
rewrote and improved core documentation for clarity, utility and comp…
Browse files Browse the repository at this point in the history
…atibility with Markdown

git-svn-id: http://svn.apache.org/repos/asf/incubator/couchdb/trunk@642660 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
nslater committed Mar 30, 2008
1 parent 25fba91 commit 8d22c35
Show file tree
Hide file tree
Showing 9 changed files with 232 additions and 311 deletions.
24 changes: 7 additions & 17 deletions AUTHORS
@@ -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.
13 changes: 3 additions & 10 deletions BUGS
@@ -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).
35 changes: 35 additions & 0 deletions 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.
59 changes: 27 additions & 32 deletions NEWS
@@ -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.
41 changes: 12 additions & 29 deletions NOTICE
@@ -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.)

0 comments on commit 8d22c35

Please sign in to comment.