mirror of
https://git.haproxy.org/git/haproxy.git/
synced 2025-09-22 22:31:28 +02:00
469fa2c9d9
We do have some code paths testing for impossible errors that tend to be quite confusing, first for maintenance (what to do on such errors, and how far to guess the bug), second for developers as it tends to hide the main purpose and expectations of these call places. Also most of the time impossible errors are ignored by the callers so the tests are not even usable during debugging. Let's instead implement a BUG_ON macro which takes a condition, which if true, will cause a message to be emitted and optionally to crash the process. Additionally, these calls inserted at various places server as hints and documentation for developers to know that such conditions must absolutely not happen. This is only enabled when DEBUG_STRICT or DEBUG_STRICT_NOCRASH are set. As its name implies, DEBUG_STRICT_NOCRASH only performs the test but does not crash, which can be useful to track some checkpoints. At the moment nothing uses this code.
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 - 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)