Skip to content

Commit dda70d5

Browse files
Add clang-format to build requirements
1 parent c09664b commit dda70d5

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

BUILD.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Instructions for building this repository on Linux, Windows, and MacOS.
1010
- [Repository Content](#repository-content)
1111
- [Installed Files](#installed-files)
1212
- [Build Requirements](#build-requirements)
13+
- [Building with Code Generation Requirements](#building-with-code-generation-requirements)
1314
- [Test Requirements](#test-requirements)
1415
- [Repository Set-Up](#repository-set-up)
1516
- [Display Drivers](#display-drivers)
@@ -84,6 +85,12 @@ indicated by *install_dir*:
8485
2. `CMake` version 3.22.1 or greater
8586
3. `Git`
8687

88+
### Building with Code Generation Requirements
89+
90+
1. `Python 3.11`
91+
2. `clang-format` version 14 or higher
92+
* Only required when submitting changes
93+
8794
### Test Requirements
8895

8996
1. `C++17` capable compiler
@@ -225,6 +232,11 @@ cmake -S . -B build -D LOADER_CODEGEN=ON
225232
cmake --build . --target loader_codegen
226233
```
227234

235+
`clang-format` is run on generated code files so that the generator scripts do
236+
not need format their output manually.
237+
If `clang-format` is not available when running code generation, a warning will
238+
be issued but does not stop code generation from occuring.
239+
228240
### Build Options
229241

230242
When generating build files through CMake, several options can be specified to

0 commit comments

Comments
 (0)