blob: 416aca63dadeaf38f4e8e737f60bc31b90d762a1 [file] [log] [blame]
Willy Tarreaub1a34b62010-05-09 22:37:12 +02001 ----------------------
2 HAProxy how-to
3 ----------------------
Willy Tarreaue0c623d2012-06-04 00:42:09 +02004 version 1.5-dev11
Willy Tarreaub1a34b62010-05-09 22:37:12 +02005 willy tarreau
Willy Tarreaue0c623d2012-06-04 00:42:09 +02006 2012/06/04
willy tarreau78345332005-12-18 01:33:16 +01007
8
Willy Tarreaub1a34b62010-05-09 22:37:12 +020091) How to build it
10------------------
11
willy tarreau78345332005-12-18 01:33:16 +010012To build haproxy, you will need :
Willy Tarreaub1a34b62010-05-09 22:37:12 +020013 - GNU make. Neither Solaris nor OpenBSD's make work with the GNU Makefile.
Willy Tarreau83b30c12008-05-25 10:32:50 +020014 However, specific Makefiles for BSD and OSX are provided.
Willy Tarreaub1a34b62010-05-09 22:37:12 +020015 - GCC between 2.91 and 4.5.0. Others may work, but not tested.
willy tarreau78345332005-12-18 01:33:16 +010016 - GNU ld
17
18Also, you might want to build with libpcre support, which will provide a very
Willy Tarreaub1a34b62010-05-09 22:37:12 +020019efficient regex implementation and will also fix some badness on Solaris' one.
willy tarreau78345332005-12-18 01:33:16 +010020
21To build haproxy, you have to choose your target OS amongst the following ones
22and assign it to the TARGET variable :
23
Willy Tarreau83b30c12008-05-25 10:32:50 +020024 - linux22 for Linux 2.2
25 - linux24 for Linux 2.4 and above (default)
26 - linux24e for Linux 2.4 with support for a working epoll (> 0.21)
Willy Tarreau83b30c12008-05-25 10:32:50 +020027 - linux26 for Linux 2.6 and above
Willy Tarreaue0c623d2012-06-04 00:42:09 +020028 - linux2628 for Linux 2.6.28 and above (enables splice and tproxy)
Willy Tarreau83b30c12008-05-25 10:32:50 +020029 - solaris for Solaris 8 or 10 (others untested)
Willy Tarreaub1a34b62010-05-09 22:37:12 +020030 - freebsd for FreeBSD 5 to 8.0 (others untested)
Willy Tarreau3b8e9792012-11-22 00:43:09 +010031 - openbsd for OpenBSD 3.1 to 5.2 (others untested)
Willy Tarreau7dec9652012-06-06 16:15:03 +020032 - aix52 for AIX 5.2
Yitzhak Sapir32087312009-06-14 18:27:54 +020033 - cygwin for Cygwin
Willy Tarreau83b30c12008-05-25 10:32:50 +020034 - generic for any other OS.
35 - custom to manually adjust every setting
willy tarreau78345332005-12-18 01:33:16 +010036
37You may also choose your CPU to benefit from some optimizations. This is
38particularly important on UltraSparc machines. For this, you can assign
39one of the following choices to the CPU variable :
40
41 - i686 for intel PentiumPro, Pentium 2 and above, AMD Athlon
42 - i586 for intel Pentium, AMD K6, VIA C3.
43 - ultrasparc : Sun UltraSparc I/II/III/IV processor
Willy Tarreaua5899aa2010-11-28 07:41:00 +010044 - native : use the build machine's specific processor optimizations
willy tarreau78345332005-12-18 01:33:16 +010045 - generic : any other processor or no specific optimization. (default)
46
Willy Tarreau83b30c12008-05-25 10:32:50 +020047Alternatively, you may just set the CPU_CFLAGS value to the optimal GCC options
48for your platform.
49
Willy Tarreauef7341d2009-04-11 19:45:50 +020050You may want to build specific target binaries which do not match your native
51compiler's target. This is particularly true on 64-bit systems when you want
52to build a 32-bit binary. Use the ARCH variable for this purpose. Right now
Willy Tarreaua5899aa2010-11-28 07:41:00 +010053it only knows about a few x86 variants (i386,i486,i586,i686,x86_64), two
54generic ones (32,64) and sets -m32/-m64 as well as -march=<arch> accordingly.
Willy Tarreauef7341d2009-04-11 19:45:50 +020055
willy tarreau78345332005-12-18 01:33:16 +010056If your system supports PCRE (Perl Compatible Regular Expressions), then you
57really should build with libpcre which is between 2 and 10 times faster than
58other libc implementations. Regex are used for header processing (deletion,
59rewriting, allow, deny). The only inconvenient of libpcre is that it is not
60yet widely spread, so if you build for other systems, you might get into
61trouble if they don't have the dynamic library. In this situation, you should
62statically link libpcre into haproxy so that it will not be necessary to
Willy Tarreau83b30c12008-05-25 10:32:50 +020063install it on target systems. Available build options for PCRE are :
willy tarreau78345332005-12-18 01:33:16 +010064
Willy Tarreau83b30c12008-05-25 10:32:50 +020065 - USE_PCRE=1 to use libpcre, in whatever form is available on your system
willy tarreau78345332005-12-18 01:33:16 +010066 (shared or static)
67
Willy Tarreau83b30c12008-05-25 10:32:50 +020068 - USE_STATIC_PCRE=1 to use a static version of libpcre even if the dynamic
69 one is available. This will enhance portability.
70
71 - with no option, use your OS libc's standard regex implemntation (default).
72 Warning! group references on Solaris seem broken. Use static-pcre whenever
73 possible.
willy tarreau78345332005-12-18 01:33:16 +010074
Willy Tarreau64bc40b2011-03-23 20:00:53 +010075Recent systems can resolve IPv6 host names using getaddrinfo(). This primitive
76is not present in all libcs and does not work in all of them either. Support in
77glibc was broken before 2.3. Some embedded libs may not properly work either,
78thus, support is disabled by default, meaning that some host names which only
79resolve as IPv6 addresses will not resolve and configs might emit an error
80during parsing. If you know that your OS libc has reliable support for
81getaddrinfo(), you can add USE_GETADDRINFO=1 on the make command line to enable
82it. This is the recommended option for most Linux distro packagers since it's
83working fine on all recent mainstream distros. It is automatically enabled on
84Solaris 8 and above, as it's known to work.
85
Willy Tarreaud4508812012-09-10 09:07:41 +020086It is possible to add native support for SSL using the GNU makefile only, and
87by passing "USE_OPENSSL=1" on the make commande line. The libssl and libcrypto
88will automatically be linked with haproxy. Some systems also require libz, so
89if the build fails due to missing symbols such as deflateInit(), then try again
90with "ADDLIB=-lz".
91
William Lallemand82fe75c2012-10-23 10:25:10 +020092It is also possible to include native support for ZLIB to benefit from HTTP
93compression. For this, pass "USE_ZLIB=1" on the "make" command line and ensure
94that zlib is present on the system.
95
willy tarreau78345332005-12-18 01:33:16 +010096By default, the DEBUG variable is set to '-g' to enable debug symbols. It is
97not wise to disable it on uncommon systems, because it's often the only way to
98get a complete core when you need one. Otherwise, you can set DEBUG to '-s' to
99strip the binary.
100
101For example, I use this to build for Solaris 8 :
102
Willy Tarreau83b30c12008-05-25 10:32:50 +0200103 $ make TARGET=solaris CPU=ultrasparc USE_STATIC_PCRE=1
willy tarreau78345332005-12-18 01:33:16 +0100104
Willy Tarreau83b30c12008-05-25 10:32:50 +0200105And I build it this way on OpenBSD or FreeBSD :
willy tarreaud38e72d2006-03-19 20:56:52 +0100106
107 $ make -f Makefile.bsd REGEX=pcre DEBUG= COPTS.generic="-Os -fomit-frame-pointer -mgnu"
108
William Lallemand82fe75c2012-10-23 10:25:10 +0200109And on a recent Linux with SSL and ZLIB support :
Willy Tarreaud4508812012-09-10 09:07:41 +0200110
William Lallemand82fe75c2012-10-23 10:25:10 +0200111 $ make TARGET=linux2628 CPU=native USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreaud4508812012-09-10 09:07:41 +0200112
William Lallemand82fe75c2012-10-23 10:25:10 +0200113In order to build a 32-bit binary on an x86_64 Linux system with SSL support
114without support for compression but when OpenSSL requires ZLIB anyway :
Willy Tarreauef7341d2009-04-11 19:45:50 +0200115
Willy Tarreaud4508812012-09-10 09:07:41 +0200116 $ make TARGET=linux26 ARCH=i386 USE_OPENSSL=1 ADDLIB=-lz
Willy Tarreauef7341d2009-04-11 19:45:50 +0200117
Willy Tarreau3b8e9792012-11-22 00:43:09 +0100118The BSD and OSX makefiles do not support build options for OpenSSL nor zlib.
119Also, at least on OpenBSD, pthread_mutexattr_setpshared() does not exist so
120the SSL session cache cannot be shared between multiple processes. If you want
121to enable these options, you need to use GNU make with the default makefile as
122follows :
123
124 $ gmake TARGET=openbsd USE_OPENSSL=1 USE_ZLIB=1 USE_PRIVATE_CACHE=1
125
willy tarreau78345332005-12-18 01:33:16 +0100126If you need to pass other defines, includes, libraries, etc... then please
127check the Makefile to see which ones will be available in your case, and
Willy Tarreau83b30c12008-05-25 10:32:50 +0200128use the USE_* variables in the GNU Makefile, or ADDINC, ADDLIB, and DEFINE
129variables in the BSD makefiles.
willy tarreau78345332005-12-18 01:33:16 +0100130
Willy Tarreau97ec9692010-01-28 20:52:05 +0100131AIX 5.3 is known to work with the generic target. However, for the binary to
132also run on 5.2 or earlier, you need to build with DEFINE="-D_MSGQSUPPORT",
133otherwise __fd_select() will be used while not being present in the libc.
Willy Tarreau7dec9652012-06-06 16:15:03 +0200134If you get build errors because of strange symbols or section mismatches,
135simply remove -g from DEBUG_CFLAGS.
Willy Tarreau97ec9692010-01-28 20:52:05 +0100136
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200137
1382) How to install it
139--------------------
140
141To install haproxy, you can either copy the single resulting binary to the
142place you want, or run :
143
144 $ sudo make install
145
146If you're packaging it for another system, you can specify its root directory
147in the usual DESTDIR variable.
148
149
1503) How to set it up
151-------------------
152
153There is some documentation in the doc/ directory :
154
155 - architecture.txt : this is the architecture manual. It is quite old and
156 does not tell about the nice new features, but it's still a good starting
157 point when you know what you want but don't know how to do it.
158
159 - configuration.txt : this is the configuration manual. It recalls a few
160 essential HTTP basic concepts, and details all the configuration file
161 syntax (keywords, units). It also describes the log and stats format. It
162 is normally always up to date. If you see that something is missing from
163 it, please report it as this is a bug.
164
165 - haproxy-en.txt / haproxy-fr.txt : these are the old outdated docs. You
166 should never need them. If you do, then please report what you didn't
167 find in the other ones.
168
169 - gpl.txt / lgpl.txt : the copy of the licenses covering the software. See
170 the 'LICENSE' file at the top for more information.
171
172 - the rest is mainly for developers.
173
174There are also a number of nice configuration examples in the "examples"
175directory as well as on several sites and articles on the net which are linked
176to from the haproxy web site.
177
178
1794) How to report a bug
180----------------------
181
182It is possible that from time to time you'll find a bug. A bug is a case where
183what you see is not what is documented. Otherwise it can be a misdesign. If you
184find that something is stupidly design, please discuss it on the list (see the
185"how to contribute" section below). If you feel like you're proceeding right
186and haproxy doesn't obey, then first ask yourself if it is possible that nobody
187before you has even encountered this issue. If it's unlikely, the you probably
188have an issue in your setup. Just in case of doubt, please consult the mailing
189list archives :
190
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200191 http://marc.info/?l=haproxy
192
193Otherwise, please try to gather the maximum amount of information to help
194reproduce the issue and send that to the mailing list :
195
196 haproxy@formilux.org
197
198Please include your configuration and logs. You can mask your IP addresses and
199passwords, we don't need them. But it's essential that you post your config if
200you want people to guess what is happening.
201
202Also, keep in mind that haproxy is designed to NEVER CRASH. If you see it die
203without any reason, then it definitely is a critical bug that must be reported
204and urgently fixed. It has happened a couple of times in the past, essentially
205on development versions running on new architectures. If you think your setup
206is fairly common, then it is possible that the issue is totally unrelated.
207Anyway, if that happens, feel free to contact me directly, as I will give you
208instructions on how to collect a usable core file, and will probably ask for
209other captures that you'll not want to share with the list.
210
211
2125) How to contribute
213--------------------
214
215It is possible that you'll want to add a specific feature to satisfy your needs
216or one of your customers'. Contributions are welcome, however I'm often very
217picky about changes. I will generally reject patches that change massive parts
218of the code, or that touch the core parts without any good reason if those
219changes have not been discussed first.
220
221The proper place to discuss your changes is the HAProxy Mailing List. There are
222enough skilled readers to catch hazardous mistakes and to suggest improvements.
Willy Tarreau9a639a12011-09-10 22:48:36 +0200223I trust a number of them enough to merge a patch if they say it's OK, so using
224the list is the fastest way to get your code reviewed and merged. You can
225subscribe to it by sending an empty e-mail at the following address :
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200226
227 haproxy+subscribe@formilux.org
228
Willy Tarreau9a639a12011-09-10 22:48:36 +0200229If you have an idea about something to implement, *please* discuss it on the
230list first. It has already happened several times that two persons did the same
231thing simultaneously. This is a waste of time for both of them. It's also very
232common to see some changes rejected because they're done in a way that will
233conflict with future evolutions, or that does not leave a good feeling. It's
234always unpleasant for the person who did the work, and it is unpleasant for me
235too because I value people's time and efforts. That would not happen if these
236were discussed first. There is no problem posting work in progress to the list,
237it happens quite often in fact. Also, don't waste your time with the doc when
238submitting patches for review, only add the doc with the patch you consider
239ready to merge.
240
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200241If your work is very confidential and you can't publicly discuss it, you can
242also mail me directly about it, but your mail may be waiting several days in
243the queue before you get a response.
244
245If you'd like a feature to be added but you think you don't have the skills to
246implement it yourself, you should follow these steps :
247
248 1. discuss the feature on the mailing list. It is possible that someone
249 else has already implemented it, or that someone will tell you how to
250 proceed without it, or even why not to do it. It is also possible that
251 in fact it's quite easy to implement and people will guide you through
252 the process. That way you'll finally have YOUR patch merged, providing
253 the feature YOU need.
254
255 2. if you really can't code it yourself after discussing it, then you may
256 consider contacting someone to do the job for you. Some people on the
257 list might be OK with trying to do it. Otherwise, you can check the list
258 of contributors at the URL below, some of the regular contributors may
259 be able to do the work, probably not for free but their time is as much
260 valuable as yours after all, you can't eat the cake and have it too.
261
262The list of past and regular contributors is available below. It lists not only
263significant code contributions (features, fixes), but also time or money
264donations :
265
266 http://haproxy.1wt.eu/contrib.html
267
268Note to contributors: it's very handy when patches comes with a properly
Willy Tarreau9a639a12011-09-10 22:48:36 +0200269formated subject. There are 3 criteria of particular importance in any patch :
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200270
Willy Tarreau9a639a12011-09-10 22:48:36 +0200271 - its nature (is it a fix for a bug, a new feature, an optimization, ...)
272 - its importance, which generally reflects the risk of merging/not merging it
273 - what area it applies to (eg: http, stats, startup, config, doc, ...)
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200274
Willy Tarreau9a639a12011-09-10 22:48:36 +0200275It's important to make these 3 criteria easy to spot in the patch's subject,
276because it's the first (and sometimes the only) thing which is read when
277reviewing patches to find which ones need to be backported to older versions.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200278
Willy Tarreau9a639a12011-09-10 22:48:36 +0200279Specifically, bugs must be clearly easy to spot so that they're never missed.
280Any patch fixing a bug must have the "BUG" tag in its subject. Most common
281patch types include :
282
283 - BUG fix for a bug. The severity of the bug should also be indicated
284 when known. Similarly, if a backport is needed to older versions,
285 it should be indicated on the last line of the commit message. If
286 the bug has been identified as a regression brought by a specific
287 patch or version, this indication will be appreciated too. New
288 maintenance releases are generally emitted when a few of these
289 patches are merged.
290
291 - CLEANUP code cleanup, silence of warnings, etc... theorically no impact.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200292 These patches will rarely be seen in stable branches, though they
Willy Tarreau9a639a12011-09-10 22:48:36 +0200293 may appear when they remove some annoyance or when they make
294 backporting easier. By nature, a cleanup is always minor.
295
296 - REORG code reorganization. Some blocks may be moved to other places,
297 some important checks might be swapped, etc... These changes
298 always present a risk of regression. For this reason, they should
299 never be mixed with any bug fix nor functional change. Code is
300 only moved as-is. Indicating the risk of breakage is highly
301 recommended.
302
303 - BUILD updates or fixes for build issues. Changes to makefiles also fall
304 into this category. The risk of breakage should be indicated if
305 known. It is also appreciated to indicate what platforms and/or
306 configurations were tested after the change.
307
308 - OPTIM some code was optimised. Sometimes if the regression risk is very
309 low and the gains significant, such patches may be merged in the
310 stable branch. Depending on the amount of code changed or replaced
311 and the level of trust the author has in the change, the risk of
312 regression should be indicated.
313
314 - RELEASE release of a new version (development or stable).
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200315
Willy Tarreau9a639a12011-09-10 22:48:36 +0200316 - LICENSE licensing updates (may impact distro packagers).
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200317
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200318
Willy Tarreau9a639a12011-09-10 22:48:36 +0200319When the patch cannot be categorized, it's best not to put any tag. This is
320commonly the case for new features, which development versions are mostly made
321of.
322
323Additionally, the importance of the patch should be indicated when known. A
324single upper-case word is preferred, among :
325
326 - MINOR minor change, very low risk of impact. It is often the case for
327 code additions that don't touch live code. For a bug, it generally
328 indicates an annoyance, nothing more.
329
330 - MEDIUM medium risk, may cause unexpected regressions of low importance or
331 which may quickly be discovered. For a bug, it generally indicates
332 something odd which requires changing the configuration in an
333 undesired way to work around the issue.
334
335 - MAJOR major risk of hidden regression. This happens when I rearrange
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200336 large parts of code, when I play with timeouts, with variable
337 initializations, etc... We should only exceptionally find such
Willy Tarreau9a639a12011-09-10 22:48:36 +0200338 patches in stable branches. For a bug, it indicates severe
339 reliability issues for which workarounds are identified with or
340 without performance impacts.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200341
Willy Tarreau9a639a12011-09-10 22:48:36 +0200342 - CRITICAL medium-term reliability or security is at risk and workarounds,
343 if they exist, might not always be acceptable. An upgrade is
344 absolutely required. A maintenance release may be emitted even if
345 only one of these bugs are fixed. Note that this tag is only used
346 with bugs. Such patches must indicate what is the first version
347 affected, and if known, the commit ID which introduced the issue.
348
349If this criterion doesn't apply, it's best not to put it. For instance, most
350doc updates and most examples or test files are just added or updated without
351any need to qualify a level of importance.
352
353The area the patch applies to is quite important, because some areas are known
354to be similar in older versions, suggesting a backport might be desirable, and
355conversely, some areas are known to be specific to one version. When the tag is
356used alone, uppercase is preferred for readability, otherwise lowercase is fine
357too. The following tags are suggested but not limitative :
358
359 - doc documentation updates or fixes. No code is affected, no need to
360 upgrade. These patches can also be sent right after a new feature,
361 to document it.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200362
Willy Tarreau9a639a12011-09-10 22:48:36 +0200363 - examples example files. Be careful, sometimes these files are packaged.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200364
Willy Tarreau9a639a12011-09-10 22:48:36 +0200365 - tests regression test files. No code is affected, no need to upgrade.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200366
Willy Tarreau9a639a12011-09-10 22:48:36 +0200367 - init initialization code, arguments parsing, etc...
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200368
Willy Tarreau9a639a12011-09-10 22:48:36 +0200369 - config configuration parser, mostly used when adding new config keywords
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200370
Willy Tarreau9a639a12011-09-10 22:48:36 +0200371 - http the HTTP engine
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200372
Willy Tarreau9a639a12011-09-10 22:48:36 +0200373 - stats the stats reporting engine as well as the stats socket CLI
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200374
Willy Tarreau9a639a12011-09-10 22:48:36 +0200375 - checks the health checks engine (eg: when adding new checks)
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200376
Willy Tarreau9a639a12011-09-10 22:48:36 +0200377 - acl the ACL processing core or some ACLs from other areas
378
379 - peers the peer synchronization engine
380
381 - listeners everything related to incoming connection settings
382
383 - frontend everything related to incoming connection processing
384
385 - backend everything related to LB algorithms and server farm
386
387 - session session processing and flags (very sensible, be careful)
388
389 - server server connection management, queueing
390
391 - proxy proxy maintenance (start/stop)
392
393 - log log management
394
395 - poll any of the pollers
396
397 - halog the halog sub-component in the contrib directory
398
399 - contrib any addition to the contrib directory
400
401Other names may be invented when more precise indications are meaningful, for
402instance : "cookie" which indicates cookie processing in the HTTP core. Last,
403indicating the name of the affected file is also a good way to quickly spot
404changes. Many commits were already tagged with "stream_sock" or "cfgparse" for
405instance.
406
407It is desired that AT LEAST one of the 3 criteria tags is reported in the patch
408subject. Ideally, we would have the 3 most often. The two first criteria should
409be present before a first colon (':'). If both are present, then they should be
410delimited with a slash ('/'). The 3rd criterion (area) should appear next, also
411followed by a colon. Thus, all of the following messages are valid :
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200412
413Examples of messages :
Willy Tarreau9a639a12011-09-10 22:48:36 +0200414 - DOC: document options forwardfor to logasap
415 - DOC/MAJOR: reorganize the whole document and change indenting
416 - BUG: stats: connection reset counters must be plain ascii, not HTML
417 - BUG/MINOR: stats: connection reset counters must be plain ascii, not HTML
418 - MEDIUM: checks: support multi-packet health check responses
419 - RELEASE: Released version 1.4.2
420 - BUILD: stats: stdint is not present on solaris
421 - OPTIM/MINOR: halog: make fgets parse more bytes by blocks
422 - REORG/MEDIUM: move syscall redefinition to specific places
423
424Please do not use square brackets anymore around the tags, because they give me
425more work when merging patches. By default I'm asking Git to keep them but this
426causes trouble when patches are prefixed with the [PATCH] tag because in order
427not to store it, I have to hand-edit the patches. So as of now, I will ask Git
428to remove whatever is located between square brackets, which implies that any
429subject formatted the old way will have its tag stripped out.
430
431In fact, one of the only square bracket tags that still makes sense is '[RFC]'
432at the beginning of the subject, when you're asking for someone to review your
433change before getting it merged. If the patch is OK to be merged, then I can
434merge it as-is and the '[RFC]' tag will automatically be removed. If you don't
435want it to be merged at all, you can simply state it in the message, or use an
436alternate '[WIP]' tag ("work in progress").
437
438The tags are not rigid, follow your intuition first, anyway I reserve the right
439to change them when merging the patch. It may happen that a same patch has a
440different tag in two distinct branches. The reason is that a bug in one branch
441may just be a cleanup in the other one because the code cannot be triggered.
442
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200443
444For a more efficient interaction between the mainline code and your code, I can
445only strongly encourage you to try the Git version control system :
446
447 http://git-scm.com/
448
449It's very fast, lightweight and lets you undo/redo your work as often as you
450want, without making your mistakes visible to the rest of the world. It will
451definitely help you contribute quality code and take other people's feedback
452in consideration. In order to clone the HAProxy Git repository :
453
454 $ git clone http://git.1wt.eu/git/haproxy-1.4.git (stable 1.4)
455 $ git clone http://git.1wt.eu/git/haproxy.git/ (development)
456
457If you decide to use Git for your developments, then your commit messages will
458have the subject line in the format described above, then the whole description
459of your work (mainly why you did it) will be in the body. You can directly send
460your commits to the mailing list, the format is convenient to read and process.
461
willy tarreau78345332005-12-18 01:33:16 +0100462-- end