blob: 0da3720184034f5d203c0ddc5c4021ac8fc107f0 [file] [log] [blame]
Willy Tarreaub1a34b62010-05-09 22:37:12 +02001 ----------------------
2 HAProxy how-to
3 ----------------------
Willy Tarreaua3ecbd92012-12-28 15:04:05 +01004 version 1.5-dev17
Willy Tarreaub1a34b62010-05-09 22:37:12 +02005 willy tarreau
Willy Tarreaua3ecbd92012-12-28 15:04:05 +01006 2012/12/28
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 Tarreau32e65ef2013-04-02 08:14:29 +020015 - GCC between 2.91 and 4.7. 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
Willy Tarreau663148c2012-12-12 00:38:22 +010071 - with no option, use your OS libc's standard regex implementation (default).
Willy Tarreau83b30c12008-05-25 10:32:50 +020072 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
Willy Tarreau663148c2012-12-12 00:38:22 +0100109And on a classic Linux with SSL and ZLIB support (eg: Red Hat 5.x) :
110
111 $ make TARGET=linux26 CPU=native USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
112
113And on a recent Linux >= 2.6.28 with SSL and ZLIB support :
Willy Tarreaud4508812012-09-10 09:07:41 +0200114
William Lallemand82fe75c2012-10-23 10:25:10 +0200115 $ make TARGET=linux2628 CPU=native USE_PCRE=1 USE_OPENSSL=1 USE_ZLIB=1
Willy Tarreaud4508812012-09-10 09:07:41 +0200116
William Lallemand82fe75c2012-10-23 10:25:10 +0200117In order to build a 32-bit binary on an x86_64 Linux system with SSL support
118without support for compression but when OpenSSL requires ZLIB anyway :
Willy Tarreauef7341d2009-04-11 19:45:50 +0200119
Willy Tarreaud4508812012-09-10 09:07:41 +0200120 $ make TARGET=linux26 ARCH=i386 USE_OPENSSL=1 ADDLIB=-lz
Willy Tarreauef7341d2009-04-11 19:45:50 +0200121
Willy Tarreau3b8e9792012-11-22 00:43:09 +0100122The BSD and OSX makefiles do not support build options for OpenSSL nor zlib.
123Also, at least on OpenBSD, pthread_mutexattr_setpshared() does not exist so
124the SSL session cache cannot be shared between multiple processes. If you want
125to enable these options, you need to use GNU make with the default makefile as
126follows :
127
128 $ gmake TARGET=openbsd USE_OPENSSL=1 USE_ZLIB=1 USE_PRIVATE_CACHE=1
129
willy tarreau78345332005-12-18 01:33:16 +0100130If you need to pass other defines, includes, libraries, etc... then please
131check the Makefile to see which ones will be available in your case, and
Willy Tarreau83b30c12008-05-25 10:32:50 +0200132use the USE_* variables in the GNU Makefile, or ADDINC, ADDLIB, and DEFINE
133variables in the BSD makefiles.
willy tarreau78345332005-12-18 01:33:16 +0100134
Willy Tarreau97ec9692010-01-28 20:52:05 +0100135AIX 5.3 is known to work with the generic target. However, for the binary to
136also run on 5.2 or earlier, you need to build with DEFINE="-D_MSGQSUPPORT",
137otherwise __fd_select() will be used while not being present in the libc.
Willy Tarreau7dec9652012-06-06 16:15:03 +0200138If you get build errors because of strange symbols or section mismatches,
139simply remove -g from DEBUG_CFLAGS.
Willy Tarreau97ec9692010-01-28 20:52:05 +0100140
Willy Tarreau32e65ef2013-04-02 08:14:29 +0200141You can easily define your own target with the GNU Makefile. Unknown targets
142are processed with no default option except USE_POLL=default. So you can very
143well use that property to define your own set of options. USE_POLL can even be
144disabled by setting USE_POLL="". For example :
145
146 $ gmake TARGET=tiny USE_POLL="" TARGET_CFLAGS=-fomit-frame-pointer
147
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200148
1492) How to install it
150--------------------
151
152To install haproxy, you can either copy the single resulting binary to the
153place you want, or run :
154
155 $ sudo make install
156
157If you're packaging it for another system, you can specify its root directory
158in the usual DESTDIR variable.
159
160
1613) How to set it up
162-------------------
163
164There is some documentation in the doc/ directory :
165
166 - architecture.txt : this is the architecture manual. It is quite old and
167 does not tell about the nice new features, but it's still a good starting
168 point when you know what you want but don't know how to do it.
169
170 - configuration.txt : this is the configuration manual. It recalls a few
171 essential HTTP basic concepts, and details all the configuration file
172 syntax (keywords, units). It also describes the log and stats format. It
173 is normally always up to date. If you see that something is missing from
174 it, please report it as this is a bug.
175
176 - haproxy-en.txt / haproxy-fr.txt : these are the old outdated docs. You
177 should never need them. If you do, then please report what you didn't
178 find in the other ones.
179
180 - gpl.txt / lgpl.txt : the copy of the licenses covering the software. See
181 the 'LICENSE' file at the top for more information.
182
183 - the rest is mainly for developers.
184
185There are also a number of nice configuration examples in the "examples"
186directory as well as on several sites and articles on the net which are linked
187to from the haproxy web site.
188
189
1904) How to report a bug
191----------------------
192
193It is possible that from time to time you'll find a bug. A bug is a case where
194what you see is not what is documented. Otherwise it can be a misdesign. If you
195find that something is stupidly design, please discuss it on the list (see the
196"how to contribute" section below). If you feel like you're proceeding right
197and haproxy doesn't obey, then first ask yourself if it is possible that nobody
198before you has even encountered this issue. If it's unlikely, the you probably
199have an issue in your setup. Just in case of doubt, please consult the mailing
200list archives :
201
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200202 http://marc.info/?l=haproxy
203
204Otherwise, please try to gather the maximum amount of information to help
205reproduce the issue and send that to the mailing list :
206
207 haproxy@formilux.org
208
209Please include your configuration and logs. You can mask your IP addresses and
210passwords, we don't need them. But it's essential that you post your config if
211you want people to guess what is happening.
212
213Also, keep in mind that haproxy is designed to NEVER CRASH. If you see it die
214without any reason, then it definitely is a critical bug that must be reported
215and urgently fixed. It has happened a couple of times in the past, essentially
216on development versions running on new architectures. If you think your setup
217is fairly common, then it is possible that the issue is totally unrelated.
218Anyway, if that happens, feel free to contact me directly, as I will give you
219instructions on how to collect a usable core file, and will probably ask for
220other captures that you'll not want to share with the list.
221
222
2235) How to contribute
224--------------------
225
226It is possible that you'll want to add a specific feature to satisfy your needs
227or one of your customers'. Contributions are welcome, however I'm often very
228picky about changes. I will generally reject patches that change massive parts
229of the code, or that touch the core parts without any good reason if those
230changes have not been discussed first.
231
232The proper place to discuss your changes is the HAProxy Mailing List. There are
233enough skilled readers to catch hazardous mistakes and to suggest improvements.
Willy Tarreau9a639a12011-09-10 22:48:36 +0200234I trust a number of them enough to merge a patch if they say it's OK, so using
235the list is the fastest way to get your code reviewed and merged. You can
236subscribe to it by sending an empty e-mail at the following address :
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200237
238 haproxy+subscribe@formilux.org
239
Willy Tarreau9a639a12011-09-10 22:48:36 +0200240If you have an idea about something to implement, *please* discuss it on the
241list first. It has already happened several times that two persons did the same
242thing simultaneously. This is a waste of time for both of them. It's also very
243common to see some changes rejected because they're done in a way that will
244conflict with future evolutions, or that does not leave a good feeling. It's
245always unpleasant for the person who did the work, and it is unpleasant for me
246too because I value people's time and efforts. That would not happen if these
247were discussed first. There is no problem posting work in progress to the list,
248it happens quite often in fact. Also, don't waste your time with the doc when
249submitting patches for review, only add the doc with the patch you consider
250ready to merge.
251
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200252If your work is very confidential and you can't publicly discuss it, you can
253also mail me directly about it, but your mail may be waiting several days in
254the queue before you get a response.
255
256If you'd like a feature to be added but you think you don't have the skills to
257implement it yourself, you should follow these steps :
258
259 1. discuss the feature on the mailing list. It is possible that someone
260 else has already implemented it, or that someone will tell you how to
261 proceed without it, or even why not to do it. It is also possible that
262 in fact it's quite easy to implement and people will guide you through
263 the process. That way you'll finally have YOUR patch merged, providing
264 the feature YOU need.
265
266 2. if you really can't code it yourself after discussing it, then you may
267 consider contacting someone to do the job for you. Some people on the
268 list might be OK with trying to do it. Otherwise, you can check the list
269 of contributors at the URL below, some of the regular contributors may
270 be able to do the work, probably not for free but their time is as much
271 valuable as yours after all, you can't eat the cake and have it too.
272
273The list of past and regular contributors is available below. It lists not only
274significant code contributions (features, fixes), but also time or money
275donations :
276
277 http://haproxy.1wt.eu/contrib.html
278
279Note to contributors: it's very handy when patches comes with a properly
Willy Tarreau9a639a12011-09-10 22:48:36 +0200280formated subject. There are 3 criteria of particular importance in any patch :
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200281
Willy Tarreau9a639a12011-09-10 22:48:36 +0200282 - its nature (is it a fix for a bug, a new feature, an optimization, ...)
283 - its importance, which generally reflects the risk of merging/not merging it
284 - what area it applies to (eg: http, stats, startup, config, doc, ...)
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200285
Willy Tarreau9a639a12011-09-10 22:48:36 +0200286It's important to make these 3 criteria easy to spot in the patch's subject,
287because it's the first (and sometimes the only) thing which is read when
288reviewing patches to find which ones need to be backported to older versions.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200289
Willy Tarreau9a639a12011-09-10 22:48:36 +0200290Specifically, bugs must be clearly easy to spot so that they're never missed.
291Any patch fixing a bug must have the "BUG" tag in its subject. Most common
292patch types include :
293
294 - BUG fix for a bug. The severity of the bug should also be indicated
295 when known. Similarly, if a backport is needed to older versions,
296 it should be indicated on the last line of the commit message. If
297 the bug has been identified as a regression brought by a specific
298 patch or version, this indication will be appreciated too. New
299 maintenance releases are generally emitted when a few of these
300 patches are merged.
301
302 - CLEANUP code cleanup, silence of warnings, etc... theorically no impact.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200303 These patches will rarely be seen in stable branches, though they
Willy Tarreau9a639a12011-09-10 22:48:36 +0200304 may appear when they remove some annoyance or when they make
305 backporting easier. By nature, a cleanup is always minor.
306
307 - REORG code reorganization. Some blocks may be moved to other places,
308 some important checks might be swapped, etc... These changes
309 always present a risk of regression. For this reason, they should
310 never be mixed with any bug fix nor functional change. Code is
311 only moved as-is. Indicating the risk of breakage is highly
312 recommended.
313
314 - BUILD updates or fixes for build issues. Changes to makefiles also fall
315 into this category. The risk of breakage should be indicated if
316 known. It is also appreciated to indicate what platforms and/or
317 configurations were tested after the change.
318
319 - OPTIM some code was optimised. Sometimes if the regression risk is very
320 low and the gains significant, such patches may be merged in the
321 stable branch. Depending on the amount of code changed or replaced
322 and the level of trust the author has in the change, the risk of
323 regression should be indicated.
324
325 - RELEASE release of a new version (development or stable).
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200326
Willy Tarreau9a639a12011-09-10 22:48:36 +0200327 - LICENSE licensing updates (may impact distro packagers).
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200328
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200329
Willy Tarreau9a639a12011-09-10 22:48:36 +0200330When the patch cannot be categorized, it's best not to put any tag. This is
331commonly the case for new features, which development versions are mostly made
332of.
333
334Additionally, the importance of the patch should be indicated when known. A
335single upper-case word is preferred, among :
336
337 - MINOR minor change, very low risk of impact. It is often the case for
338 code additions that don't touch live code. For a bug, it generally
339 indicates an annoyance, nothing more.
340
341 - MEDIUM medium risk, may cause unexpected regressions of low importance or
342 which may quickly be discovered. For a bug, it generally indicates
343 something odd which requires changing the configuration in an
344 undesired way to work around the issue.
345
346 - MAJOR major risk of hidden regression. This happens when I rearrange
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200347 large parts of code, when I play with timeouts, with variable
348 initializations, etc... We should only exceptionally find such
Willy Tarreau9a639a12011-09-10 22:48:36 +0200349 patches in stable branches. For a bug, it indicates severe
350 reliability issues for which workarounds are identified with or
351 without performance impacts.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200352
Willy Tarreau9a639a12011-09-10 22:48:36 +0200353 - CRITICAL medium-term reliability or security is at risk and workarounds,
354 if they exist, might not always be acceptable. An upgrade is
355 absolutely required. A maintenance release may be emitted even if
356 only one of these bugs are fixed. Note that this tag is only used
357 with bugs. Such patches must indicate what is the first version
358 affected, and if known, the commit ID which introduced the issue.
359
360If this criterion doesn't apply, it's best not to put it. For instance, most
361doc updates and most examples or test files are just added or updated without
362any need to qualify a level of importance.
363
364The area the patch applies to is quite important, because some areas are known
365to be similar in older versions, suggesting a backport might be desirable, and
366conversely, some areas are known to be specific to one version. When the tag is
367used alone, uppercase is preferred for readability, otherwise lowercase is fine
368too. The following tags are suggested but not limitative :
369
370 - doc documentation updates or fixes. No code is affected, no need to
371 upgrade. These patches can also be sent right after a new feature,
372 to document it.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200373
Willy Tarreau9a639a12011-09-10 22:48:36 +0200374 - examples example files. Be careful, sometimes these files are packaged.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200375
Willy Tarreau9a639a12011-09-10 22:48:36 +0200376 - tests regression test files. No code is affected, no need to upgrade.
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200377
Willy Tarreau9a639a12011-09-10 22:48:36 +0200378 - init initialization code, arguments parsing, etc...
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200379
Willy Tarreau9a639a12011-09-10 22:48:36 +0200380 - config configuration parser, mostly used when adding new config keywords
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200381
Willy Tarreau9a639a12011-09-10 22:48:36 +0200382 - http the HTTP engine
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200383
Willy Tarreau9a639a12011-09-10 22:48:36 +0200384 - stats the stats reporting engine as well as the stats socket CLI
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200385
Willy Tarreau9a639a12011-09-10 22:48:36 +0200386 - checks the health checks engine (eg: when adding new checks)
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200387
Willy Tarreau9a639a12011-09-10 22:48:36 +0200388 - acl the ACL processing core or some ACLs from other areas
389
390 - peers the peer synchronization engine
391
392 - listeners everything related to incoming connection settings
393
394 - frontend everything related to incoming connection processing
395
396 - backend everything related to LB algorithms and server farm
397
398 - session session processing and flags (very sensible, be careful)
399
400 - server server connection management, queueing
401
402 - proxy proxy maintenance (start/stop)
403
404 - log log management
405
406 - poll any of the pollers
407
408 - halog the halog sub-component in the contrib directory
409
410 - contrib any addition to the contrib directory
411
412Other names may be invented when more precise indications are meaningful, for
413instance : "cookie" which indicates cookie processing in the HTTP core. Last,
414indicating the name of the affected file is also a good way to quickly spot
415changes. Many commits were already tagged with "stream_sock" or "cfgparse" for
416instance.
417
418It is desired that AT LEAST one of the 3 criteria tags is reported in the patch
419subject. Ideally, we would have the 3 most often. The two first criteria should
420be present before a first colon (':'). If both are present, then they should be
421delimited with a slash ('/'). The 3rd criterion (area) should appear next, also
422followed by a colon. Thus, all of the following messages are valid :
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200423
424Examples of messages :
Willy Tarreau9a639a12011-09-10 22:48:36 +0200425 - DOC: document options forwardfor to logasap
426 - DOC/MAJOR: reorganize the whole document and change indenting
427 - BUG: stats: connection reset counters must be plain ascii, not HTML
428 - BUG/MINOR: stats: connection reset counters must be plain ascii, not HTML
429 - MEDIUM: checks: support multi-packet health check responses
430 - RELEASE: Released version 1.4.2
431 - BUILD: stats: stdint is not present on solaris
432 - OPTIM/MINOR: halog: make fgets parse more bytes by blocks
433 - REORG/MEDIUM: move syscall redefinition to specific places
434
435Please do not use square brackets anymore around the tags, because they give me
436more work when merging patches. By default I'm asking Git to keep them but this
437causes trouble when patches are prefixed with the [PATCH] tag because in order
438not to store it, I have to hand-edit the patches. So as of now, I will ask Git
439to remove whatever is located between square brackets, which implies that any
440subject formatted the old way will have its tag stripped out.
441
442In fact, one of the only square bracket tags that still makes sense is '[RFC]'
443at the beginning of the subject, when you're asking for someone to review your
444change before getting it merged. If the patch is OK to be merged, then I can
445merge it as-is and the '[RFC]' tag will automatically be removed. If you don't
446want it to be merged at all, you can simply state it in the message, or use an
447alternate '[WIP]' tag ("work in progress").
448
449The tags are not rigid, follow your intuition first, anyway I reserve the right
450to change them when merging the patch. It may happen that a same patch has a
451different tag in two distinct branches. The reason is that a bug in one branch
452may just be a cleanup in the other one because the code cannot be triggered.
453
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200454
455For a more efficient interaction between the mainline code and your code, I can
456only strongly encourage you to try the Git version control system :
457
458 http://git-scm.com/
459
460It's very fast, lightweight and lets you undo/redo your work as often as you
461want, without making your mistakes visible to the rest of the world. It will
462definitely help you contribute quality code and take other people's feedback
463in consideration. In order to clone the HAProxy Git repository :
464
465 $ git clone http://git.1wt.eu/git/haproxy-1.4.git (stable 1.4)
466 $ git clone http://git.1wt.eu/git/haproxy.git/ (development)
467
Willy Tarreau663148c2012-12-12 00:38:22 +0100468The site above is slow, a faster mirror is maintained up to date here :
469
470 $ git clone http://master.formilux.org/git/people/willy/haproxy.git/
471
Willy Tarreaub1a34b62010-05-09 22:37:12 +0200472If you decide to use Git for your developments, then your commit messages will
473have the subject line in the format described above, then the whole description
474of your work (mainly why you did it) will be in the body. You can directly send
475your commits to the mailing list, the format is convenient to read and process.
476
willy tarreau78345332005-12-18 01:33:16 +0100477-- end