TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2024-11-23 18:15:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Code formatting (markdown)

zxkmm 2023-05-28 23:17:34 +08:00
parent 08a1dfbe27
commit 4eb97027a1
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Code-formatting.md

@ -3,9 +3,6 @@ For this we are using clang format version 13. All the config for this is in the
## VS Code
Make sure you have C/C++ extension by Microsoft installed and it should automatically pick up your .clang-format file. If not, you can go to the extension settings and specify the location under the `Clang_format_style` setting
## CLion
CLion has built in clang-format, just press Ctrl + Shift + L (Windows and Linux) to format the code with ``.clang-format`` configure file within project directory.
## CLI
To format using CLI, make sure you have clang-format-13 installed
@ -25,4 +22,9 @@ or individually:
find firmware/common -iname '*.h' -o -iname '*.hpp' -o -iname '*.cpp' -o -iname '*.c' | xargs clang-format-13 -style=file -i
find firmware/baseband -iname '*.h' -o -iname '*.hpp' -o -iname '*.cpp' -o -iname '*.c' | xargs clang-format-13 -style=file -i
find firmware/application -iname '*.h' -o -iname '*.hpp' -o -iname '*.cpp' -o -iname '*.c' | xargs clang-format-13 -style=file -i
```
```
## CLion
CLion has built in clang-format, just press Ctrl + Shift + L (Windows and Linux) to format the code with ``.clang-format`` configure file within project directory. If you have clang-tidy or so enabled, you need to disable them.