mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-09-23 06:41:32 +02:00
7ab7031e34
This file includes everything that must be guaranteed to be available to any buildable file in the project (including the contrib/ subdirs). For now it includes <haproxy/api-t.h> so that standard integer types and compiler macros are known, <common/initcall.h> to ease dynamic registration of init functions, and <common/tools.h> for a few MIN/MAX macros. version.h should probably also be added, though at the moment it doesn't bring a great value. All files which currently include the ones above should now switch to haproxy/api.h or haproxy/api-t.h instead. This should also reduce build time by having a single guard for several files at once.
The HAProxy documentation has been split into a number of different files for ease of use. Please refer to the following files depending on what you're looking for : - INSTALL for instructions on how to build and install HAProxy - BRANCHES to understand the project's life cycle and what version to use - LICENSE for the project's license - CONTRIBUTING for the process to follow to submit contributions The more detailed documentation is located into the doc/ directory : - doc/intro.txt for a quick introduction on HAProxy - doc/configuration.txt for the configuration's reference manual - doc/lua.txt for the Lua's reference manual - doc/SPOE.txt for how to use the SPOE engine - doc/network-namespaces.txt for how to use network namespaces under Linux - doc/management.txt for the management guide - doc/regression-testing.txt for how to use the regression testing suite - doc/peers.txt for the peers protocol reference - doc/coding-style.txt for how to adopt HAProxy's coding style - doc/internals for developer-specific documentation (not all up to date)