Josh Soref
a880ca239b
* spelling: accidentally * spelling: across * spelling: additionally * spelling: addresses * spelling: appropriate * spelling: assumed * spelling: available * spelling: builder * spelling: capacity * spelling: compiler * spelling: compressibility * spelling: compressor * spelling: compression * spelling: contract * spelling: convenience * spelling: decompress * spelling: description * spelling: deflate * spelling: deterministically * spelling: dictionary * spelling: display * spelling: eliminate * spelling: preemptively * spelling: exclude * spelling: failure * spelling: independence * spelling: independent * spelling: intentionally * spelling: matching * spelling: maximum * spelling: meaning * spelling: mishandled * spelling: memory * spelling: occasionally * spelling: occurrence * spelling: official * spelling: offsets * spelling: original * spelling: output * spelling: overflow * spelling: overridden * spelling: parameter * spelling: performance * spelling: probability * spelling: receives * spelling: redundant * spelling: recompression * spelling: resources * spelling: sanity * spelling: segment * spelling: series * spelling: specified * spelling: specify * spelling: subtracted * spelling: successful * spelling: return * spelling: translation * spelling: update * spelling: unrelated * spelling: useless * spelling: variables * spelling: variety * spelling: verbatim * spelling: verification * spelling: visited * spelling: warming * spelling: workers * spelling: with
66 lines
1.3 KiB
Markdown
66 lines
1.3 KiB
Markdown
# Cmake contributions
|
|
|
|
Contributions to the cmake build configurations are welcome. Please
|
|
use case sensitivity that matches modern (ie. cmake version 2.6 and above)
|
|
conventions of using lower-case for commands, and upper-case for
|
|
variables.
|
|
|
|
# CMake Style Recommendations
|
|
|
|
## Indent all code correctly, i.e. the body of
|
|
|
|
* if/else/endif
|
|
* foreach/endforeach
|
|
* while/endwhile
|
|
* macro/endmacro
|
|
* function/endfunction
|
|
|
|
Use spaces for indenting, 2, 3 or 4 spaces preferably. Use the same amount of
|
|
spaces for indenting as is used in the rest of the file. Do not use tabs.
|
|
|
|
## Upper/lower casing
|
|
|
|
Most important: use consistent upper- or lowercasing within one file !
|
|
|
|
In general, the all-lowercase style is preferred.
|
|
|
|
So, this is recommended:
|
|
|
|
```
|
|
add_executable(foo foo.c)
|
|
```
|
|
|
|
These forms are discouraged
|
|
|
|
```
|
|
ADD_EXECUTABLE(bar bar.c)
|
|
Add_Executable(hello hello.c)
|
|
aDd_ExEcUtAbLe(blub blub.c)
|
|
```
|
|
|
|
## End commands
|
|
To make the code easier to read, use empty commands for endforeach(), endif(),
|
|
endfunction(), endmacro() and endwhile(). Also, use empty else() commands.
|
|
|
|
For example, do this:
|
|
|
|
```
|
|
if(FOOVAR)
|
|
some_command(...)
|
|
else()
|
|
another_command(...)
|
|
endif()
|
|
```
|
|
|
|
and not this:
|
|
|
|
```
|
|
if(BARVAR)
|
|
some_other_command(...)
|
|
endif(BARVAR)
|
|
```
|
|
|
|
## Other resources for best practices
|
|
|
|
`https://cmake.org/cmake/help/latest/manual/cmake-developer.7.html#modules`
|