Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format code with clang-format #35

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

lucarin91
Copy link
Contributor

I think that can be useful to have a format style for the code base, in order to be more readable and maintainable.
I propose to use clang-format because it is largely used and customizable.

I add the .clang-format that defines the used style. The style is based on the LLVM one but without the sorting of the includes to avoid compilation errors and the reflow of the comments to avoid breaking some ASCII figures in the comments. I also add some other options to inline short if and loops.

In order to run the code formatting, install clang-format (e.g., apt install clang-format) and run the script with ./scripts/format.sh to apply the style to all files.

Note: By default, the LLVM style sets the indentation width to 2 spaces, it is possible to change it to 4 spaces but I think that it makes the code more difficult to read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant