toxcore/other/astyle/README.md
iphydf b8b9789a69
Rebuild apidsl'd headers in cmake.
- Moved apidsl headers next to their generated versions. In the future,
  perhaps all (or most) headers will be apidsl-generated, so the sources
  should stay together.
- Try to find apidsl/apigen binary and astyle binary and use it for the
  format test. Don't run the format test if these can't be found.
2016-10-02 23:54:03 +01:00

910 B

This directory can house various tools and utilities.

How to use astyle

Manually

For all files

Run from toxcore directory:

astyle --options=./other/astyle/astylerc ./toxcore/*.c ./toxcore/*.h ./toxdns/*.c ./toxdns/*.h ./testing/*.c ./toxav/*.c ./toxav/*.h ./other/*.c ./other/bootstrap_daemon/*.c ./toxencryptsave/*.c ./toxencryptsave/*.h ./auto_tests/*.c

For selected file

Run from toxcore directory, e.g. for tox.h file:

astyle --options=./other/astyle/astylerc ./toxcore/tox.h

Automatically, as pre-commit hook (*NIX only)

Copy astylerc to toxcore/.git/hooks

Why

astylerc - this file can be used in the pre-commit hook to try its best at making the code conform to the coding style of toxcore.

Furthermore, it is being used to format tox.h after using apidsl to generate it.