haproxy

haproxy public development tree

Go to file

Willy Tarreau 64a18534e3 DOC: internal: document the init calls INITCALLs are used a lot in the code now and were not documented, resulting in each user having to grep for functions in other files. This doc is not perfect but aims at improving the situation. It documents what's been available since 1.9 and may be backported there if it helps though it's unlikely to be needed as it's mostly aimed at developers.		2019-11-20 16:52:56 +01:00
.github/ISSUE_TEMPLATE	…
contrib	…
doc	DOC: internal: document the init calls	2019-11-20 16:52:56 +01:00
ebtree	…
examples	…
include	…
reg-tests	…
scripts	…
src	…
tests	…
.cirrus.yml	…
.gitignore	…
.travis.yml	…
BRANCHES	…
CHANGELOG	…
CONTRIBUTING	…
INSTALL	…
LICENSE	…
MAINTAINERS	…
Makefile	…
README	…
ROADMAP	…
SUBVERS	…
VERDATE	…
VERSION	…

README

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)