acd103631b
QA: PCB file input parse test program (fuzzable)
...
This adds a test program which can be used to test the
parsing of a given KiCad PCB file. This interface is
useful for both manual or automated debugging of given
files, as well as providing an interface suitable for
fuzz-testing tools.
Also adds to the testing docs to detail how fuzzing can
be used.
Also moves some useful re-usable code from io-benchmark
to a new library qa_utils, which can contain code that
isn't need in the actual KiCad libs.
2018-10-22 12:32:24 -04:00
7548a3b1bf
Add KICAD_SCRIPTING_PYTHON3 flag to about dialog and doc
2018-10-19 09:59:05 +02:00
86999a2a4d
Update testing documentation
2018-10-06 08:46:36 -04:00
d19b152655
Update pcbnew-plugins.md with info about icons
2018-08-27 11:08:39 -04:00
6db71cd734
Add documentation for KICAD_USE_OCC
2018-08-20 13:26:40 -07:00
6165a735ae
Docs: update doxygen docs logo
...
The logo used was subtly different to the official KiCad
logo - different font weight and corner rounds.
2018-08-06 11:06:24 -04:00
e3cf2705de
Aim macOS users at kicad-mac-builder, and make building for macOS sound less scary.
2018-07-23 13:04:34 -04:00
930f3dd74f
Documentation: add logo to Doxygen pages
...
This adds a small KiCad logo in the top left of the Doxygen pages.
54px used as 55px is maximum recommended height for Doxygen logos.
For the main docs and the dev docs, this is easily done in the Doxyfile,
for the Python docs, as that is run from the binary dir, the source dir
is passed as an Environment variable.
2018-06-25 08:23:17 -04:00
a11714b1a4
fix misspelled 'an other' -> 'another'
2018-04-08 13:24:37 -04:00
747e14f9e1
Fix broken link in compiling.md.
2018-04-02 18:27:37 -04:00
8cdb82df42
Update Windows MSYS2 build instructions; remove "easy way" for now
2018-03-21 14:33:44 -04:00
8f0c798dc8
Update MSYS2 links
2018-03-07 21:06:30 -05:00
38d211b5e1
Document workaround for Windows compilation issues with OCE
2018-03-07 21:03:04 -05:00
944a0b195e
Update KiCad compiling document.
...
Add missing build dependencies ngspice and oce.
Fix missing dependencies for MSYS2 builds on windows.
Remove enabling scripting now that is enabled by default.
2018-03-06 18:54:51 -05:00
b300e8cce5
Update macOS compiling instructions to use KiCad wxWidgets fork.
2018-02-21 13:37:54 -05:00
93683d0021
Enable all build configuration options ready for stable 5 release.
...
Enable Python scripting, OCE, and spice build configuration options.
Update compiling.md to reflect new option settings.
2017-12-29 17:38:42 -05:00
4e8e6d4823
Add explaining notes on when to use changelog tags
2017-11-29 17:36:03 +01:00
c5254bfec2
Documentation: changed git alias sections name to match the contents
2017-11-29 17:36:03 +01:00
f3ea34e3c6
Documentation: described 'git changelog' alias
...
Added 'git changelog' alias description and moved both descriptions to a
single paragraph.
2017-11-29 11:33:07 +01:00
f9fd60350f
Documentation: added a note about changelog tags
2017-11-29 10:44:47 +01:00
3b0855d204
Eagle Project Import: Code cleanup and documentation.
...
- Also makes the project and file import functions filetype dependent.
- The change from IO_MGR::KICAD to IO_MGR::KICAD_SEXP removes a conflict from a compile definition for KICAD when compiling kicad/import_project.cpp
2017-10-20 08:58:40 +02:00
81fcc852b1
Fix Pcbnew plugin developer's document table of contents.
2017-06-28 11:38:44 -04:00
0f20dc747f
Minor Pcbnew plugin developer's document fixes.
...
Reformat line width to prevent line wrapping.
Add table of contents and header links.
2017-06-28 11:08:23 -04:00
bbef4fee17
Added documentation about pcbnew plugin development
2017-06-28 10:48:41 -04:00
dab73e172b
Doxygen warning fixes and coding policy comment changes.
2017-06-16 10:08:28 -04:00
19d5cc7548
Removed all exception specifiers since deprecated.
...
Exception specifiers are deprecated in cpp11, so went through them all
and removed them from the code.
2017-06-12 13:54:55 -04:00
8590a22995
Cpp11 compability steps.
...
-Changed coding style to not have exception specifications.
-Changed autogenerated Lexer code to not have exception specifications.
2017-06-12 11:47:20 -04:00
0a29ab9031
Update macOS portion of compiling.md.
...
In general, replace OSX with macOS. Moved the minimum OS version from 10.7 to 10.9. Moved the maximum version from 10.10 to the current 10.12.
2017-03-14 19:08:18 -04:00
6f3ec438cb
Add missing install package to the compiling document.
...
The base-devel package install was missing from the "MSYS2 The Easy Way"
section of the compiling developers document.
Fixes lp:1670067
https://bugs.launchpad.net/kicad/+bug/1670067
2017-03-05 14:08:12 -05:00
9dff85f0dc
Add developer docs about testing
2017-03-01 14:05:51 +01:00
1077b679c5
Minor updates to the Tool Framework documentation
2017-02-23 09:45:43 +01:00
6b39e9ea81
Update GAL tool documentation
...
Update to reference new PCB_ACTIONs (used to be COMMON_ACTION)
Also expand on use of BOARD_COMMIT.
Add doxygen TOC markup
2017-02-23 09:00:55 +01:00
899fe08f20
Remove KICAD_USE_SCH_IO_MANAGER build option from docs and build info.
2017-02-10 11:58:15 -05:00
0f7785760f
Add missing MSYS2 package on windows to developer's compiling document.
2017-01-31 15:25:30 -05:00
4b9243e0bf
Allow registering TOOLs in any order.
2017-01-30 13:21:43 +01:00
0881bf77bd
Add commit message format doc with Fixes: links
2017-01-26 16:03:54 -05:00
0b6147ed05
Minor developer's documentation fixes.
...
Fix duplicate table of content links.
Fix heading level issues in version 6 road map.
Add new Python action menu options to compiling document.
2017-01-24 10:14:27 -05:00
5a2be26934
Tool Framework documentation
2017-01-18 16:30:33 +01:00
c676553f19
Fix OCE link in dev-docs
...
* Remove duplicate ngspice link
* Add OCE link
2017-01-14 12:24:40 -05:00
9c758c4010
Road map updates.
...
Update version 5 road map to reflect the actual tasks that will be
completed during the current development cycle.
Add version 6 road map and add tasks not completed from the version
5 road map and the general road map.
2016-12-10 13:20:24 -05:00
fd54d394bd
Version string improvements.
...
Define empty string variable KICAD_BRANCH_NAME that can be used as an
optional version string element. When git is used to build the version
string, this variable is set to the git branch name. It can also be
defined at configuration time as an optional string appended to the
$KICAD_VERSION variable.
Define empty string variable KICAD_VERSION_EXTRA that can be set by
the user at configuration.
The variables KICAD_BRANCH_NAME and KICAD_VERSION_EXTRA are only
appended to KICAD_VERSION if they are set. Otherwise, only KICAD_VERSION
is uses as the version string.
Update the developer building from source document to reflect the changes.
2016-11-25 09:09:10 -05:00
c483574658
Add stitching via support to the version 5 road map.
2016-10-17 11:11:35 -04:00
225f0d8917
Update build KiCad from source documentation.
...
Add note about KICAD_BUILD_VERSION and KICAD_REPO_NAME CMake configuration
variables.
Fix incorrect path for OSX patch command.
Add new OSX patches to OSX build instructions.
Fix missing ngspice url.
2016-09-17 15:49:20 -04:00
6767ea7bbf
Update the REAMDE.txt to reflect the current structure
...
The old changelog was archived together with the others in
Documentation/changelogs.
2016-09-16 16:43:19 -04:00
83ed3c933e
Add KICAD_INSTALL_DEMOS CMake option
...
It is ON by default, determines wether to install the bundled demos
and examples.
2016-09-14 19:57:35 -04:00
e25630b7ac
UI policy update
...
Added a note about Mark's wxFormBuilder repository and
'internationalize' checkbox in wxFB.
2016-09-09 09:38:56 -04:00
caafcde585
Add KICAD_ prefix to build switches
...
KICAD_ prefix was added to the USE_OCE and USE_SCH_IO_MANAGER build
switches together with a small description to the devdocs from
compiling.md.
2016-09-05 08:46:01 -04:00
049e9909ac
Updated the compiling instructions to remove bzr and talk about the OCE flag.
2016-09-04 18:42:11 -04:00
3204b14254
Updated the r5 road map (integrated simulator)
2016-08-12 16:58:39 +02:00
a6cdf536b9
Added KICAD_SPICE option description in compiling.md
2016-08-12 16:00:35 +02:00
John Beard
Thomas Pointhuber
qu1ck
Nick Østergaard
Adam Wolf
Carsten Schoenert
Wayne Stambaugh
Jon Evans
Bernhard Stegmaier
Maciej Suminski
Russell Oliver
Simon Kueppers
Kristoffer Ödmark
Chris Pavlina
José Ignacio Romero
Jon Neal