kicad/Documentation/development
John Beard a21b336138 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]: d5f39a56a4

tool

(cherry picked from commit a69cdf1793)
2019-03-29 15:12:36 +00:00
..
Doxyfile Doxyfiles: Remove local debug lines 2019-02-13 17:22:07 -08:00
coding-style-policy.md Formatting: exclude generated files from git formatting hook 2019-03-29 15:12:36 +00:00
commit-message-format.md Add explaining notes on when to use changelog tags 2017-11-29 17:36:03 +01:00
compiling.md Docs: Fix doxygen links 2019-01-02 09:53:29 -05:00
config-strings.md Remove MaxUndoItems, make devel option DevelMaxUndoItems 2016-05-12 12:51:32 -04:00
pcbnew-plugins.md Fixup documentation for macOS Python script plugins. Fixes #1789960. 2018-11-28 09:40:22 -05:00
road-map-r5.md Docs: Fix doxygen links 2019-01-02 09:53:29 -05:00
road-map-r6.md Minor developer's documentation fixes. 2017-01-24 10:14:27 -05:00
road-map.md Update stable release 5 road map. 2016-07-05 10:06:23 -04:00
stable-release-policy.md Add stable release policy to developers documentation. 2014-10-18 11:37:08 -04:00
testing.md Docs: Advanced config is explicity experimental 2019-02-11 09:47:13 +00:00
tool-framework.md Explained AF_ACTIVATE flag in the documentation 2018-11-13 09:36:26 +01:00
ui-policy.md Documentation: UI policy update about dialogs 2018-12-03 12:22:14 -05:00