summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordormando <dormando@rydia.net>2011-03-30 01:50:09 -0700
committerdormando <dormando@rydia.net>2011-03-30 01:52:26 -0700
commit085c64abc297a876726ad4583e706fb02b3f3f86 (patch)
tree8706c4491c6f1f6163f60b4b356db5da2ac454ce
parentdfd51305babd9f1020c401ac56518c0a4129e840 (diff)
downloadmemcached-085c64abc297a876726ad4583e706fb02b3f3f86.tar.gz
Update the base doc files a bit.
Kill some outdated ones, make information more accessable in the remaining. Updated the AUTHORS file to point out that there're more than two.
-rw-r--r--AUTHORS4
-rw-r--r--BUILD37
-rw-r--r--HACKING6
-rw-r--r--NEWS1
-rw-r--r--README30
-rw-r--r--doc/CONTRIBUTORS32
6 files changed, 31 insertions, 79 deletions
diff --git a/AUTHORS b/AUTHORS
index fc95232..82dd3eb 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -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
diff --git a/BUILD b/BUILD
deleted file mode 100644
index d6ca4c4..0000000
--- a/BUILD
+++ /dev/null
@@ -1,37 +0,0 @@
-Ideally, you want to make a static binary, otherwise the dynamic
-linker pollutes your address space with shared libs right in the
-middle. (NOTE: actually, this shouldn't matter so much anymore, now
-that we only allocate huge, fixed-size slabs)
-
-Make sure your libevent has epoll (Linux) or kqueue (BSD) support.
-Using poll or select only is slow, and works for testing, but
-shouldn't be used for high-traffic memcache installations.
-
-To build libevent with epoll on Linux, you need two things. First,
-you need /usr/include/sys/epoll.h . To get it, you can install the
-userspace epoll library, epoll-lib. The link to the latest version
-is buried inside
-http://www.xmailserver.org/linux-patches/nio-improve.html ; currently
-it's http://www.xmailserver.org/linux-patches/epoll-lib-0.9.tar.gz .
-If you're having any trouble building/installing it, you can just copy
-epoll.h from that tarball to /usr/include/sys as that's the only thing
-from there that libevent really needs.
-
-Secondly, you need to declare syscall numbers of epoll syscalls, so
-libevent can use them. Put these declarations somewhere
-inside <sys/epoll.h>:
-
-#define __NR_epoll_create 254
-#define __NR_epoll_ctl 255
-#define __NR_epoll_wait 256
-
-After this you should be able to build libevent with epoll support.
-Once you build/install libevent, you don't need <sys/epoll.h> to
-compile memcache or link it against libevent. Don't forget that for epoll
-support to actually work at runtime you need to use a kernel with epoll
-support patch applied, as explained in the README file.
-
-BSD users are luckier, and will get kqueue support by default.
-
-
-
diff --git a/HACKING b/HACKING
index 60bfa9f..d918ac0 100644
--- a/HACKING
+++ b/HACKING
@@ -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
diff --git a/NEWS b/NEWS
deleted file mode 100644
index 78b1eca..0000000
--- a/NEWS
+++ /dev/null
@@ -1 +0,0 @@
-http://www.danga.com/memcached/news.bml
diff --git a/README b/README
index f20dd8c..3fcf114 100644
--- a/README
+++ b/README
@@ -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:
diff --git a/doc/CONTRIBUTORS b/doc/CONTRIBUTORS
index b87e5c6..7ccce8e 100644
--- a/doc/CONTRIBUTORS
+++ b/doc/CONTRIBUTORS
@@ -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:
--------------
@@ -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