Commit Graph

262 Commits

Author SHA1 Message Date
Marek Roszko bdef682d4d Remove documentation now moved to http://dev-docs.kicad.org/
Repo at
2021-01-01 15:47:50 -05:00
Seth Hillbrand 6641168cbc Update KiCad website links 2020-12-22 17:38:56 -08:00
Jeff Young acfbcb4beb Make distinction between PCBNew-wide tools and Board-specific tools.
The old names were really hard to keep straight (even for me, who named
many of them).
2020-12-16 13:32:46 +00:00
Wayne Stambaugh dfec33711f Fix coding policy class definition layout rules sample indentation. 2020-12-11 14:20:35 -05:00
Wayne Stambaugh 236ab16ddb Add class definition layout rules to coding policy. 2020-12-10 07:55:28 -05:00
Marek Roszko cdd4c24a66 Document CLion configuration with msys2 2020-11-12 19:23:35 -05:00
Marek Roszko 2d940b8471 Remove the outdated boost 1.59 note 2020-11-12 19:23:34 -05:00
Ian McInerney beab46e965 Update build docs to have the correct set of CMake options
* The GitHub plugin was removed, so remove it from the docs and CI
* Add the new DPI manifest option to the build docs.
2020-11-11 00:41:03 +00:00
Ian McInerney 11e6cac42b Introduce EGL backend support for the OpenGL canvas
wxWidgets 3.1.5+ on Linux will compile with the Wayland EGL
canvas as the backend instead of the X11 backend. This requires a
version of GLEW compiled with the proper EGL defines and a different
header/code for certain parts that are X11 GLEW specific.

This introduces an in-tree version of GLEW that will be built with the
GLEW_EGL flag then statically linked into the KiCad executables when
EGL support is needed.
2020-11-11 00:41:02 +00:00
jean-pierre charras 9dc0310602 Doc: add info to compiling.md about OCC 2020-11-02 12:44:03 +01:00
Roberto Fernandez Bautista 0a55d64598 Change MSYS2 KiCad Build Instructions to show '-j N' switch for 'make -j N install' 2020-10-30 20:17:27 +00:00
Marek Roszko 1538d737e7 Split out FILL_T to its own header to avoid spreading eda_item everywhere 2020-10-14 21:51:23 -04:00
Marek Roszko 38f799314d Fix the heading on the new vs build steps 2020-10-11 19:56:19 -04:00
Marek Roszko 3603b07426 Add initial visual studio build instructions 2020-10-11 19:54:10 -04:00
Jon Evans b31ebae651 Add a first pass at documentation for the settings framework 2020-10-06 21:09:18 -04:00
Jeff Young 37906511f5 Class renaming.
DRAWSEGMENT  -> PCB_SHAPE
EDGE_MODULE  -> FP_SHAPE
TEXTE_PCB    -> PCB_TEXT
TEXTE_MODULE -> FP_TEXT
2020-10-05 11:55:33 +01:00
Wayne Stambaugh 467aa47bbb Update coding policy for control blocks.
All control blocks (if, for, while, etc.) should have a blank line
before the opening statement and after the closing curly brace or
statement so that it is clear where the control block begins and
ends.
2020-09-09 09:50:11 -04:00
Seth Hillbrand d4affa9985 Add missing zlib link to documentation
Also add the proper build package for mingw
2020-08-19 13:49:43 -07:00
Seth Hillbrand 835d4a268f Add zlib requirement to documentation 2020-08-19 12:01:56 -07:00
Wayne Stambaugh ede39780e2 Remove all debugging output that cannot be disabled.
The use of printf, wxLogDebug, and std::err/std::out causes excessive
debugging output which makes finding specific debugging messages more
difficult than it needs to be.

There is still some debugging output in test code that really needs to
be moved into a unit test.

Add debugging output section to the coding policy regarding debugging
output.
2020-08-18 10:17:36 -04:00
Ian McInerney ab83c86210 Remove the platform-specific GetBackendScalingFactor from HIDPI_GL_CANVAS
The scaling factor stored inside the canvas is created by a DPI_SCALING
helper, which will call the platform-specific functions if no user scaling
is specified. This change only affects OSX and Retina displays, so this
now also allows custom scaling to be used on OSX if desired (although it
shouldn't be needed, since wx has detection for it in 3.0.4).
2020-06-05 00:15:54 +00:00
Wayne Stambaugh 9817b63f66 Minor coding policy document fixes.
Ironically make the document formatting more consistent and remove
some trailing whitespace.

Changed "When it Rome.." title since may not have the same meaning in
other languages as it does in English.  Also add table of contents to
this section for linking purposes.
2020-05-27 09:05:54 -04:00
Ian McInerney d72a778f19 Move Doxygen test to main CMake scope
Fixes https://gitlab.com/kicad/code/kicad/issues/4468
2020-05-17 18:29:50 +01:00
Ian McInerney 0658d297e5 Cleanup cmake for documentation creation 2020-05-17 01:00:37 +01:00
Jeff Young f679be4101 Update lambda examples in coding style doc. 2020-05-12 18:21:18 +01:00
Jeff Young e93684015c Add a "when in Rome..." clause to the formatting doc. 2020-04-13 21:28:19 +01:00
Jeff Young 35b647d134 Document coding standard changes agreed on Zulip. 2020-04-13 20:56:30 +01:00
Ian McInerney 2c86b3d8cf Fix documentation link in the scripting docs
Fixes https://gitlab.com/kicad/code/kicad/issues/3735
2020-03-28 22:01:09 +00:00
Jon Evans b56998925b Deprecate V6 roadmap and move to Wiki 2020-02-03 11:26:44 +00:00
Ian McInerney 0d017e262c Update documentation and comment 2020-01-22 08:47:14 +00:00
Ian McInerney 752bc5b7ba Update technical todo
Add a section mentioning C++20 and the new constexpr
std::string and std::vector that we can use.
2020-01-21 11:03:55 +00:00
Ian McInerney 1d050e9b9d Update macOS build documentation with moved wxWidgets repo
Also remove --enable-utf8 from the configure flags since
the custom build doesn't work with UTF8 enabled.
Add rich text support to wxWidgets for the multi-line editor.
2019-12-22 01:32:42 +00:00
Ian McInerney 2e5b8d0a8f Update commit message policy
Giving both the issue number and URL is redundent in the message.
GitLab can automatically close the issue using the URL, so only
give the URL so it can be viewed in the log.
2019-12-20 15:32:38 +00:00
Ian McInerney 3370e89967 Update Linux appdata file and CMake version strings
CHANGED: Update the Linux appdata file to include new tags

* Include version tags (and others) in the appdata file
* Refactor the version string generation to clean it up
2019-12-18 17:24:07 +00:00
John Beard 4dc82ff76f Technical TODO: make_unique is no longer polyfilled
Since we use C++14, std::make_unique required no "polyfill".

The KiCad polyfill was removed in
5151cd0bfe,
so remove the TODO item.
2019-12-05 18:25:15 +01:00
Jon Evans 95f703aac0 Update compiling.md for GitLab 2019-12-02 20:20:05 +00:00
Maciej Suminski 2a3d4ffe88 Update 'git fixes' alias and the documentation to point to Gitlab 2019-12-01 11:01:56 +01:00
Seth Hillbrand a643bdff4b Remove ergonomic statement 2019-11-26 09:44:47 -08:00
Wayne Stambaugh e00b78adc9 Minor commit message policy updates.
Remove the NEW tag and only support the ADD tag for new features.  ADD
is compatible with the other tags because the past tense (ED) makes
sense for ADD not NEW.
2019-11-11 08:25:58 -05:00
jean-pierre charras 187cd5aa09 Add missing info in compil_options_symbols.txt 2019-10-08 08:07:29 +02:00
jean-pierre charras 34b26a0ac7 Add KICAD_USE_FONT_REDUCED_SET (default OFF) to build options.
It allow using the previous font set without CJK.
The new font (with CJK) is very large (10x), and can create (on Opengl) out of memory issues
with some graphic cards.
2019-10-07 09:50:24 +02:00
Ian McInerney bdf7fb9e95 Update building documentation with new debugging options 2019-10-07 08:54:55 +02:00
Seth Hillbrand 044b4a6d4c Bump C++ version to c++14
This is a provisional bump.  If supported platforms
(http://kicad-pcb.org/help/system-requirements/#_specific_system_requirements)
experience issues with this version we will revert back to c++11.

No code that requires c++14 will be committed yet.
2019-07-10 20:03:48 -07:00
Ian McInerney 42e14b5a4e Cleanup cmake python dependency handling to catch errors
* Changed the KICAD_SCRIPTING flag to be a global disable, so it
  will disable all other scripting flags when set to OFF
* Added version testing with the wxPython flags to ensure the
  proper version is found for the flags provided
2019-06-27 13:31:20 -04:00
Seth Hillbrand e52afd93a3 Remove Legacy options for overlay/context
These options were used to support the legacy canvas when drawing on
MacOS and GTK3.  With the move to 100% GAL, they are extraneous.  This
moves all DC over to "COPY" as we only use this for printing support in
Eeschema at the moment, so there is a single draw command (no erasing)
for the canvas.
2019-06-12 06:01:03 -07:00
Wayne Stambaugh c711ad5c7c Update compiling document Python scripting options.
Change the default option setting for the Python scripting action menu
support.

Add notes that the KiCad scripting support is forcefully enable when the
Python scripting module support or the Python scripting action menu
support are enabled.
2019-06-05 14:02:27 -04:00
John Beard 241127788e Format: add some formatting aliases, improve dev docs
The aliases are easier than calling check_coding.sh manually,
and we already provide an alias file for the fixes alias, so
do the same for these.
2019-05-23 21:28:42 +01:00
John Beard 840e08fa78 QA eeschema: add some tests
This adds a few tests on:

* LIB_PART
* SCH_PIN
* SCH_SHEET
* SCH_SHEET_PATH

These tests exercise some of the basic code paths in these classes
and show some of the expected behaviours.

None of these tests are particularly ground-breaking, but they
provide a starting point to build out further tests, and to ensure
the already-covered behaviour is stable.

It does expose some places where SCH_SHEET could probably use const.
2019-05-23 11:29:28 +01:00
Jeff Young fbb807f3bb Move some more menu & toolbar items to modern toolset. 2019-05-16 19:57:06 +01:00
Jeff Young 0c2ba94b16 More sharing between SchEdit and LibEdit. 2019-05-10 20:22:26 +01:00