toxcore/other/astyle
Zetok Zalbavar 68dc14f80c
Add real instruction on how to use APIDSL and astyle
also add to "tox{,.in}.h" note that "tox.h" shouldn't be edited directly,
pointing to "tox.in.h"
2015-06-20 01:22:46 +01:00
..
README.md Add real instruction on how to use APIDSL and astyle 2015-06-20 01:22:46 +01:00
astylerc Switched tox.h to the dsl generated one. 2015-04-25 20:39:13 -04:00
pre-commit Switched tox.h to the dsl generated one. 2015-04-25 20:39:13 -04:00

README.md

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.