tomato-testing/other/astyle/README.md
Green Sky 227425b90e Squashed 'external/toxcore/c-toxcore/' content from commit 67badf69
git-subtree-dir: external/toxcore/c-toxcore
git-subtree-split: 67badf69416a74e74f6d7eb51dd96f37282b8455
2023-07-25 11:53:09 +02:00

884 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 ./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.