search

PX4 / PX4-Autopilot

PX4 Autopilot Software
https://px4.io
BSD 3-Clause "New" or "Revised" License
8.13k stars 13.34k forks source link

Code formatting with `clang-format` #20249

Open howjmay opened 1 year ago

howjmay commented 1 year ago

Describe problem solved by the proposed feature

clang-format is a more generally used formatting tool. Its installation is easier than astyle

Describe your preferred solution

A clear and concise description of what you want to happen.

Describe possible alternatives

using clang-format!

tstastny commented 1 year ago

@howjmay, @MaEtUgR has started this process in this PR https://github.com/PX4/PX4-Autopilot/pull/19855

Maybe you could help support with testing the PR / working on the "missing items" bullets that are left?

isidroas commented 2 months ago

We could take inspiration from https://github.com/git/git/blob/d63586cb314731c851f28e14fc8012988467e2da/Makefile#L3288

They use https://clang.llvm.org/docs/ClangFormat.html#git-integration

  To format staged changes, i.e everything that's been `git add`ed:
    git clang-format

  To also format everything touched in the most recent commit:
    git clang-format HEAD~1

  If you're on a branch off main, to format everything touched on your branch:
    git clang-format main

This is shiped in the clang-format Ubuntu/debian package.

It formats regions of changed code, not the entire file, so the migration is more progressive.