kicad

kicad patches

Go to file

John Beard a69cdf1793 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		2019-03-29 15:06:48 +00:00
.githooks	Formatting: exclude generated files from git formatting hook	2019-03-29 15:06:48 +00:00
3d-viewer	…
CMakeModules	…
Documentation	Formatting: exclude generated files from git formatting hook	2019-03-29 15:06:48 +00:00
bitmap2component	…
bitmaps_png	…
common	…
cvpcb	Remove superfluous build library dependencies.	2019-03-29 09:01:56 -04:00
demos	…
dxflib_qcad	…
eeschema	Remove superfluous build library dependencies.	2019-03-29 09:01:56 -04:00
gerbview	Remove superfluous build library dependencies.	2019-03-29 09:01:56 -04:00
helpers	…
include	…
kicad	…
new	…
pagelayout_editor	Remove superfluous build library dependencies.	2019-03-29 09:01:56 -04:00
patches	…
pcb_calculator	…
pcbnew	…
plugins	…
polygon	…
potrace	…
qa	Remove superfluous build library dependencies.	2019-03-29 09:01:56 -04:00
resources/linux	…
scripting	…
scripts	…
template	…
tools	Formatting: exclude generated files from git formatting hook	2019-03-29 15:06:48 +00:00
utils	…
.gitattributes	Formatting: exclude generated files from git formatting hook	2019-03-29 15:06:48 +00:00
.gitignore	…
AUTHORS.txt	…
CMakeLists.txt	…
CTestConfig.cmake	…
Doxyfile	…
INSTALL.txt	…
LICENSE.AGPLv3	…
LICENSE.BOOSTv1_0	…
LICENSE.CC-BY-SA-4.0	…
LICENSE.GPLv3	…
LICENSE.ISC	…
LICENSE.README	…
README.txt	…
TODO.txt	…
_clang-format	…
copyright.h	…
uncrustify.cfg	…

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