7183e9f97e
This is a very large and potentially disruptive change so this will be an unusually long and detailed commit message. The new file formats are now the default in both the schematic and symbol library editors. Existing symbol libraries will be saved in their current format until new features are added to library symbols. Once this happens, both the legacy schematic and symbol file formats will be no longer be savable and existing libraries will have to be converted. Saving to the legacy file formats is still available for round robin testing and should not be used for normal editing. When loading the legacy schematic file, it is imperative that the schematic library symbols are rescued and/or remapped to valid library identifiers. Otherwise, there will be no way to link to the original library symbol and the user will be required manually set the library identifier. The cached symbol will be saved in the schematic file so the last library symbol in the cache will still be used but there will be no way to update it from the original library. The next save after loading a legacy schematic file will be converted to the s-expression file format. Schematics with hierarchical sheets will automatically have all sheet file name extensions changed to .kicad_sym and saved to the new format as well. Appending schematics requires that the schematic to append has already been converted to the new file format. This is required to ensure that library symbols are guaranteed to be valid for the appended schematic. The schematic symbol library symbol link resolution has been moved out of the SCH_COMPONENT object and move into the SCH_SCREEN object that owns the symbol. This was done to ensure that there is a single place where the library symbol links get resolved rather than the dozen or so different code paths that previously existed. It also removes the necessity of the SCH_COMPONENT object of requiring any knowledge of the symbol library table and/or the cache library. When opening an s-expression schematic, the legacy cache library is not loaded so any library symbols not rescued cannot be loaded. Broken library symbol links will have to be manually resolved by adding the cache library to the symbol library table and changing the links in the schematic symbol. Now that the library symbols are embedded in the schematic file, the SCH_SCREEN object maintains the list of library symbols for the schematic automatically. No external manipulation of this library cache should ever occur. ADDED: S-expression schematic and symbol library file formats. |
||
|---|---|---|
| .githooks | ||
| 3d-viewer | ||
| CMakeModules | ||
| Documentation | ||
| bitmap2component | ||
| bitmaps_png | ||
| common | ||
| cvpcb | ||
| demos | ||
| eeschema | ||
| gerbview | ||
| helpers | ||
| include | ||
| kicad | ||
| libs | ||
| new | ||
| pagelayout_editor | ||
| patches | ||
| pcb_calculator | ||
| pcbnew | ||
| plugins | ||
| qa | ||
| resources | ||
| scripting | ||
| scripts | ||
| template | ||
| thirdparty | ||
| tools | ||
| utils | ||
| .clang-tidy | ||
| .gitattributes | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| 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.MIT | ||
| LICENSE.README | ||
| README.txt | ||
| _clang-format | ||
| code-of-conduct.md | ||
| 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