Skip to content

Commit

Permalink
Update the base doc files a bit.
Browse files Browse the repository at this point in the history
Kill some outdated ones, make information more accessable in the remaining.
Updated the AUTHORS file to point out that there're more than two.
  • Loading branch information
dormando committed Mar 30, 2011
1 parent dfd5130 commit 085c64a
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 79 deletions.
4 changes: 4 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
Original authors:

Anatoly Vorobey <mellon@pobox.com>
Brad Fitzpatrick <brad@danga.com>

For everyone else, see git or http://www.memcached.org/about
37 changes: 0 additions & 37 deletions BUILD

This file was deleted.

6 changes: 5 additions & 1 deletion HACKING
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@
- automake
- autotools
- libevent
- git

* Getting Started

After checking out a git repository, you must first run autogen.sh
once in order to create the configure script.

Next, run the configure script and start doing builds.
$ git clone git://github.com/memcached/memcached.git

Next, run the configure script and start doing builds:
$ ./config/autorun.sh && ./configure && make && make test

* Setting up Git

Expand Down
1 change: 0 additions & 1 deletion NEWS

This file was deleted.

30 changes: 19 additions & 11 deletions README
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
Super fast totally awesome distributed memory object caching daemon.

Requires a client to fully utilize, which you may research at the wiki:

http://www.memcached.org/wiki

The ASCII protocol is documented in doc/protocol.txt - the newer binary
protocol is documented on the wiki above.

Dependencies:

-- libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev)

If using Linux, you need a kernel with epoll. Sure, libevent will
work with normal select, but it sucks.
Ideally you have a recent version of libevent (1.4+), and a recent OS (at
least from the last 4 years).

epoll isn't in Linux 2.4, but there's a backport at:
QUICK INSTALL:

http://www.xmailserver.org/linux-patches/nio-improve.html
$ ./configure && make && make test && sudo make install

You want the epoll-lt patch (level-triggered).
By default memcached builds with a bundled version of libevent, to make it
easier to build on older distributions. If you are packaging memcached or
otherwise wish to use the libevent provided by your distro, build with:

If you're using MacOS, you'll want libevent 1.1 or higher to deal with
a kqueue bug.
$ ./configure --disable-bundled-libevent

Also, be warned that the -k (mlockall) option to memcached might be
dangerous when using a large cache. Just make sure the memcached machines
don't swap. memcached does non-blocking network I/O, but not disk. (it
should never go to disk, or you've lost the whole point of it)
Please try to ensure memcached isn't swapping. It is designed to be ultra fast
while relying on RAM. SWAP is not necessarily RAM.

The memcached website is at:

Expand Down
32 changes: 3 additions & 29 deletions doc/CONTRIBUTORS
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
MEMCACHED CONTRIBUTORS

This file contains a list of people who have contributed code and
effort to the memcached project. If you don't see your name mentioned
send email to the memcached mailing list so you can be immortalized.

Also see the ChangeLog for even more people who have helped over the
years by submitting fixes, patches and reporting bugs.

This is an old file describing the earliest memcached pioneers. For everyone
else, there is the web.

Major authors:
--------------
Expand All @@ -21,25 +16,4 @@ Steven Grimm <sgrimm@facebook.com> -- iov writing (less CPU), UDP mode,
Other Contributors
------------------

Evan Martin <evan@danga.com>
Nathan Neulinger <nneul@umr.edu>
Eric Hodel <drbrain@segment7.net>
Michael Johnson <ahze@ahze.net>
Paul Querna <chip@corelands.com>
Jamie McCarthy <jamie@mccarthy.vg>
Philip Neustrom <philipn@gmail.com>
Andrew O'Brien <andrewo@oriel.com.au>
Josh Rotenberg <joshrotenberg@gmail.com>
Robin H. Johnson <robbat2@gentoo.org>
Tim Yardley <liquid@haveheart.com>
Paolo Borelli <paolo.borelli@gmail.com>
Eli Bingham <eli@pandora.com>
Jean-Francois Bustarret <jfbustarret@wat.tv>
Paul G <paul-lists@perforge.com>
Paul Lindner <lindner@inuus.com>
Dormando <dormando@rydia.net>
Dustin Sallings <dustin@spy.net>
Chris Goffinet <goffinet@yahoo-inc.com>
Tomash Brechko <tomash.brechko@gmail.com>
Brian Aker <brian@tangent.org>
Trond Norbye <trond.norbye@sun.com>
See full authors list in git, or at: http://www.memcached.org/about

0 comments on commit 085c64a

Please sign in to comment.