kicad patches
Go to file
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
.githooks Formatting: exclude generated files from git formatting hook 2019-03-29 15:12:36 +00:00
3d-viewer Restore 3D canvas to full size on Retina displays. 2019-02-19 16:18:11 -07:00
CMakeModules Begin version 5.1.1 development. 2019-03-08 13:11:03 -05:00
Documentation Formatting: exclude generated files from git formatting hook 2019-03-29 15:12:36 +00:00
bitmap2component bitmap2component: Handle mask/alpha 2019-02-09 08:40:59 -08:00
bitmaps_png Use our own version of the folder icon. 2019-02-19 10:39:42 -07:00
common sim: Prevent stepping 2019-03-26 14:59:18 -07:00
cvpcb Cvpcb: cosmetic enhancement in toolbar: add a text. 2019-03-24 15:38:59 +01:00
demos Remove global library from pspice simulation 2019-03-17 20:56:24 +01:00
dxflib_qcad dxf and svg import: accept unicode filenames 2018-12-07 10:07:43 +01:00
eeschema Eeschema: do not merge graphical lines with different attributes. 2019-03-28 13:47:58 -04:00
gerbview Gerbview: fix crash when reading a .gbrjob, and when a file given by the .gbrjob is not found. A incorrect gerber image was created, creating crash on exit or when enable the layer view. 2019-03-24 17:40:16 +01:00
helpers Update tools_to_build_newstroke-font files to V5 2018-04-06 20:09:32 +02:00
include Eeschema: Force time stamp to 32 bits unsigned values, and make it 2019-03-27 13:17:54 +01:00
kicad Open drill file in gerbview from KiCad manager tree 2019-03-27 09:13:23 -04:00
new Fix quotes in UI messages 2017-12-15 07:33:07 -05:00
pagelayout_editor Page Layout: Do not double-move frames 2019-02-25 14:15:34 -08:00
patches Remove macos patches. 2018-01-31 10:18:41 -05:00
pcb_calculator Update/regenerate pcb_calculator_frame_base.fbp 2019-03-19 15:21:38 -04:00
pcbnew Pcbnew: Improve tab traversal in text properties dialog 2019-03-27 14:06:16 +00:00
plugins 3d: Fix double-clear in oce loadmodel 2018-10-09 05:37:48 -07:00
polygon Build: libpolygon provides its own includes 2019-02-04 19:29:31 -08:00
potrace Update potrace to version 1.15 (that fixes some bugs) 2017-11-27 12:54:18 +01:00
qa QA: nullptr_t -> std::nullptr_t 2019-03-29 12:49:16 +00:00
resources/linux appdata.xml: Remove additional license metadata 2019-03-27 14:50:23 -04:00
scripting Updating icon build paths 2019-02-14 14:58:04 -08:00
scripts Cleanup build script locations 2019-02-14 14:44:55 -08:00
template Remove worksheet templates. 2018-01-27 10:19:29 -05:00
tools Formatting: exclude generated files from git formatting hook 2019-03-29 15:12:36 +00:00
utils Bitmaps: move bitmap defs to bitmaps library 2019-02-04 19:29:31 -08:00
.gitattributes Formatting: exclude generated files from git formatting hook 2019-03-29 15:12:36 +00:00
.gitignore Remove inadvertent committed fp-info-cache 2018-12-13 14:55:30 -08:00
AUTHORS.txt Added Italian translator 2019-02-26 08:54:47 +01:00
CMakeLists.txt cmake: Remove invalid clang syntax 2019-03-07 13:59:18 -08:00
CTestConfig.cmake See CHANGELOG.txt 2010-02-14 14:59:43 +00:00
Doxyfile Doxyfiles: Remove local debug lines 2019-02-13 17:22:07 -08:00
INSTALL.txt Docs: Fix doxygen links 2019-01-02 09:53:29 -05:00
LICENSE.AGPLv3 Update license to AGPL due to TTL license. 2018-10-22 12:28:48 -04:00
LICENSE.BOOSTv1_0 Cleanup licensing 2019-02-11 08:35:23 -08:00
LICENSE.CC-BY-SA-4.0 Adding license text for CC-BY-SA-4.0 for completeness 2019-03-27 14:50:05 -04:00
LICENSE.GPLv3 Update license to AGPL due to TTL license. 2018-10-22 12:28:48 -04:00
LICENSE.ISC Cleanup licensing 2019-02-11 08:35:23 -08:00
LICENSE.README Adding license information for demo files 2019-03-27 14:49:44 -04:00
README.txt Cleanup build script locations 2019-02-14 14:44:55 -08:00
TODO.txt Modular KiCad Blueprint Milestone B), major portions: 2014-08-13 15:28:54 -05:00
_clang-format Clang-format: break after templates 2019-03-27 14:38:52 +00:00
copyright.h Update copyright.h 2018-01-08 16:53:05 +01:00
uncrustify.cfg Fix case statement indentation setting for uncrustify. 2015-01-08 09:02:27 -05:00

README.txt

KiCad README
============
For specific documentation like Compiling, GUI translation, old
changelogs see the Documentation subfolder.

Files
-----
AUTHORS.txt       - The authors, contributors, document writers and translators list
CMakeList.txt     - Main CMAKE build tool script
copyright.h       - A very short copy of the GNU General Public License to be included in new source files
CTestConfig.cmake - Support for CTest and CDash testing tools
Doxyfile          - Doxygen config file for KiCad
INSTALL.txt       - The release (binary) installation instructions
TODO.txt          - Todo list (looks outdated)
uncrustify.cfg    - Uncrustify config file for uncrustify sources formatting tool
_clang-format     - clang config file for clang-format sources formatting tool

Subdirectories
--------------
3d-viewer         - Sourcecode of the 3D viewer
bitmap2component  - Sourcecode of the bitmap to pcb artwork converter
bitmaps_png       - Menu and program icons
CMakeModules      - Modules for the CMAKE build tool
common            - Sourcecode of the common library
cvpcb             - Sourcecode of the CvPCB tool
demos             - Some demo examples
Documentation     - Developer documentation. Old changelogs etcetera.
eeschema          - Sourcecode of the schematic editor
gerbview          - Sourcecode of the gerber viewer
helpers           - Helper tools and utilities for development
include           - Interfaces to the common library
kicad             - Sourcecode of the project manager
lib_dxf           - Sourcecode of the dxf reader/writer library
new               - Staging area for the new schematic library format
pagelayout_editor - Sourcecode of the pagelayout editor
patches           - Collection of patches for external dependencies
pcbnew            - Sourcecode of the printed circuit board editor
plugins           - Sourcecode of the new plugin concept
polygon           - Sourcecode of the polygon library
potrace           - Sourcecode of the potrace library, used in bitmap2component
qa                - Testcases using the python interface
resources         - Resources for freedesktop mime-types for linux
scripting         - SWIG Python scripting definitions and build scripts
scripts           - Example scripts for distribution with KiCad
template          - Project and pagelayout templates
tools             - Other miscellaneous helpers for testing
utils             - Small utils for kicad, e.g. IDF tools