mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-04-17 00:19:18 +00:00
a69cdf1793
Add a .gitattributes files to provide a place to store file
attributes. Add a custom attribute for files that should be under
KiCad style guidelines.
Exclude generated files from the style enforcement. So far:
* bitmap .cpp files
* wxFormBuilder base classes
* Lemon grammars
It's now trivial to add the 'generated' attribute to any such
file.
Putting this into .gitattributes also means it can be retreived
programmatically, by other scripts, git alaises or on the command
line.
Use the attributes to provide a utility script to show or apply
formatting to controlled files (plain git clang-format won't
pick up our custom git attributes). Add details for the script in
the dev docs.
Also modiify the check-format hook to follow the .gitattributes
and only apply to cached (staged for commit) changes. Then you
won't be stopped committing because of bad formatting in unstaged
changed, or uncontrolled files.
Concept and some aspects of the implementation inspired by
CMake commit d5f39a56 [1].
[1]: d5f39a56a4
tool
32 lines
940 B
Plaintext
32 lines
940 B
Plaintext
|
|
# Custom attribute to mark source files using KiCad C++ formatting
|
|
[attr]kicad-cpp-source whitepace=tab-in-indent format.clang-format-kicad
|
|
|
|
# Custom attribute to mark KiCad's own CMake files
|
|
[attr]kicad-cmake-source whitespace=tab-in-indent
|
|
|
|
# Custom attribute for auto-generated sources:
|
|
# * Do not perform whitespace checking
|
|
# * Do not format
|
|
[attr]generated whitespace=-tab-in-indent,-indent-with-non-tab -format.clang-format-kicad
|
|
|
|
# By default, all C and C++ files conform to KiCad formatting,
|
|
# unless overridden
|
|
*.c kicad-cpp-source
|
|
*.cpp kicad-cpp-source
|
|
*.h kicad-cpp-source
|
|
|
|
*.cmake kicad-cmake-source
|
|
*.txt kicad-cmake-source
|
|
|
|
# Compiled bitmap sources
|
|
bitmaps_png/cpp_*/*.cpp generated
|
|
|
|
# wxFormBuilder-generated files
|
|
**/dialog*/*_base.cpp generated
|
|
**/dialog*/*_base.h generated
|
|
|
|
# Lemon grammars
|
|
common/libeval/grammar.c generated
|
|
common/libeval/grammar.h generated
|