Versions Compared

Old Version 6

changes.mady.by.user Dylan Donahue

Saved on

compared with

New Version Current

changes.mady.by.user Jack Rubacha

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

We utilize (a slightly modified version of) the Linux Kernel Clang Formatter, which enforces Linux style syntax.

...

Fortunately, this formatter can be run by the user to automatically update their code to abide by these standards. The process for running this on a given file is as follows:

Info

This process only works for NER applications, not for Embedded Base itself. If/when we get this running for embedded base, the process for running it on a file within that directory will be included below

Note

This purposely will ignore and not format auto generated files like main.c and all HAL files. This is okay and intentional

To setup and run the clang format:

In VScode:

  1. Open VScode from any NER C project

  2. Open file-->preferences-->settings

  3. Type clang in the settings search bar

  4. Change C_Cpp: Clang_format_fallback Style to none

  5. Change C_Cpp: Clang_format_style to file:${workspaceRoot}/Drivers/Embedded-Base/clang-format

...

  1. Change editor.formatOnSave to false

Note that with these settings, the linter will run automatically every time you save while in VScode, the file will automatically be linted through the formattera file in VScode. If you prefer this not to happen, you can opt out of this by ignoring step 6 above. In doing so, the linter will not run on save, and will have to be done with Ctr + i.


In CLI:

Debian based Linux:

...