xref: /memcached-1.4.29/HACKING (revision ff24fb8f)
1* Hacking Memcached
2
3* Prerequisites
4
5 - autoconf
6 - automake
7 - autotools
8 - libevent
9
10* Getting Started
11
12After checking out a git repository, you must first run autogen.sh
13once in order to create the configure script.
14
15Next, run the configure script and start doing builds.
16
17* Setting up Git
18
19Though not required, there are a couple of things you can add to git
20to help development.
21
22** Pre Commit Hook
23
24The pre-commit hook can be used to ensure that your tree passes tests
25before allowing a commit.  To do so, add the following to
26.git/hooks/pre-commit (which must be executable):
27
28    #!/bin/sh
29    make test
30
31** Post Commit Hook
32
33Because the version number changes on each commit, it's good to use a
34post commit hook to update the version number after each commit so as
35to keep the reporting accurate.  To do so, add the following to
36.git/hooks/post-commit (which must be executable)
37
38    #!/bin/sh
39    ./version.sh
40
41** Running memcached in gdb for tests.
42
43By default `make test` will spawn a memcached daemon for each test.
44This doesn't let you easily drop into gdb or run verbosely.
45
46If you export the environment variable
47T_MEMD_USE_DAEMON="127.0.0.1:11211" the tests will use an existing
48daemon at that address.
49
50* Sending patches
51
52See current instructions at http://contributing.appspot.com/memcached
53