haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/.gitattributes

36 lines
1.0 KiB
Plaintext
Raw Permalink Normal View History

Formatting: exclude generated files from git formatting hook 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]: https://gitlab.kitware.com/cmake/cmake/commit/d5f39a56a44fe061018c6acc15e1c3aa7337ff54 tool
2019-03-29 11:11:03 +00:00
# Custom attribute to mark source files using KiCad C++ formatting
Renormalize line endings and enforce normalization for all contributors
2020-08-03 22:14:16 +00:00
[attr]kicad-cpp-source text=auto whitepace=tab-in-indent format.clang-format-kicad
Formatting: exclude generated files from git formatting hook 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]: https://gitlab.kitware.com/cmake/cmake/commit/d5f39a56a44fe061018c6acc15e1c3aa7337ff54 tool
2019-03-29 11:11:03 +00:00
# Custom attribute to mark KiCad's own CMake files
Renormalize line endings and enforce normalization for all contributors
2020-08-03 22:14:16 +00:00
[attr]kicad-cmake-source text=auto whitespace=tab-in-indent
Formatting: exclude generated files from git formatting hook 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]: https://gitlab.kitware.com/cmake/cmake/commit/d5f39a56a44fe061018c6acc15e1c3aa7337ff54 tool
2019-03-29 11:11:03 +00:00
# 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
Renormalize line endings and enforce normalization for all contributors
2020-08-03 22:14:16 +00:00
*.md text=auto
Formatting: exclude generated files from git formatting hook 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]: https://gitlab.kitware.com/cmake/cmake/commit/d5f39a56a44fe061018c6acc15e1c3aa7337ff54 tool
2019-03-29 11:11:03 +00:00
# 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
Force script line endings
2024-01-16 21:03:43 +00:00
# Scripts
*.sh text eol=lf
*.bat text eol=crlf