diff options
| author | Eanna O Cathain <eanna.ocathain@arm.com> | 2022-05-04 13:34:31 +0100 |
|---|---|---|
| committer | Kshitij Sisodia <kshitij.sisodia@arm.com> | 2022-05-10 09:41:32 +0000 |
| commit | b29e08a5566307f0ecc59db058e3b65c75f71e35 (patch) | |
| tree | 5abe2c3534f544890532878794d22fe36256cc31 /docs | |
| parent | eb9dfa723bedf239e551b6369b65c7151860618b (diff) | |
| download | ml-embedded-evaluation-kit-b29e08a5566307f0ecc59db058e3b65c75f71e35.tar.gz | |
MLECO-3160 Adding .clang-format
Change-Id: If5cf20e189273a887917aefcc745c4992be93e1d
Reviewed-on: https://eu-gerrit-2.euhpc.arm.com/c/ml/ecosystem/ml-embedded-evaluation-kit/+/543186
Tested-by: mlecosys <mlecosys@arm.com>
Reviewed-by: Nina Drozd <nina.drozd@arm.com>
Reviewed-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sections/coding_guidelines.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/sections/coding_guidelines.md b/docs/sections/coding_guidelines.md index ae479f7..57c45e0 100644 --- a/docs/sections/coding_guidelines.md +++ b/docs/sections/coding_guidelines.md @@ -25,6 +25,24 @@ Layer (HAL). Both of these languages follow different naming conventions within However, because we also issue function calls to third-party APIs, and they are not guaranteed to follow these conventions, the intended outcome could be different for every case. +## Pre-commit formatting +To help with the adherence of the coding guidelines, we have provided a clang-format file. When commiting, please run +the following command, post-staging but pre-commit. + + + ```Git + git-clang-format + ``` + +This will modify the staged changes, to adhere to the guidelines as described in the +.clang-format file in the root of the repo. Please note that the clang-format tool must be installed to run this +step and can be installed using the following command on Ubuntu: + + ``` + sudo apt install clang-format + ``` + + ## Language version For this project, code written in C++ uses a subset of the `C++14` feature set and software may be written using the |