diff --git a/Documentation/development/testing.md b/Documentation/development/testing.md index 7fddb20500..e0c3c04aed 100644 --- a/Documentation/development/testing.md +++ b/Documentation/development/testing.md @@ -224,11 +224,14 @@ a "mask", for example: This will not be printed by default. To show it, set the `WXTRACE` environment variable when you run KiCad to include the masks you wish to enable: - $ WXTRACE="TRACEKEY,OTHERKEY" kicad + $ WXTRACE="TRACEMASK,OTHERMASK" kicad When printed, the debug will be prefixed with a timestamp and the trace mask: - 11:22:33: Trace: (KICAD_FIND_ITEM) item Symbol GNDPWR, #PWR020 + 11:22:33: Trace: (TRACEMASK) My trace, value: 42 + +If you add a trace mask, define and document the mask as a variable in +`include/trace_helpers.h`. This will add it to the [trace mask documentation][]. Some available masks: @@ -260,4 +263,5 @@ Some available masks: [CTest]: https://cmake.org/cmake/help/latest/module/CTest.html [Boost Unit Test framework]: https://www.boost.org/doc/libs/1_68_0/libs/test/doc/html/index.html [boost-test-functions]: https://www.boost.org/doc/libs/1_68_0/libs/test/doc/html/boost_test/utf_reference/testing_tool_ref.html -[AFL fuzzing tool]: http://lcamtuf.coredump.cx/afl/ \ No newline at end of file +[AFL fuzzing tool]: http://lcamtuf.coredump.cx/afl/ +[trace mask documentation]: http://docs.kicad-pcb.org/doxygen/group__trace__env__vars.html \ No newline at end of file diff --git a/include/trace_helpers.h b/include/trace_helpers.h index 050ab1dafc..06c50f0866 100644 --- a/include/trace_helpers.h +++ b/include/trace_helpers.h @@ -49,72 +49,100 @@ /** * Flag to enable find debug tracing. + * + * Use "KICAD_FIND_ITEM" to enable. */ extern const wxChar* const traceFindItem; /** * Flag to enable find and replace debug tracing. + * + * Use "KICAD_FIND_REPLACE" to enable. */ extern const wxChar* const traceFindReplace; /** * Flag to enable draw panel coordinate debug tracing. + * + * Use "KICAD_COORDS" to enable. */ extern const wxChar* const kicadTraceCoords; /** * Flag to enable wxKeyEvent debug tracing. + * + * Use "KICAD_KEY_EVENTS" to enable. */ extern const wxChar* const kicadTraceKeyEvent; /** * Flag to enable auto save feature debug tracing. + * + * Use "KICAD_AUTOSAVE" to enable. */ extern const wxChar* const traceAutoSave; /** * Flag to enable schematic library memory deletion debug output. + * + * Use "KICAD_SCH_LIB_MEM" to enable. */ extern const wxChar* const traceSchLibMem; /** * Flag to enable legacy schematic plugin debug output. + * + * Use "KICAD_SCH_LEGACY_PLUGIN" to enable. */ extern const wxChar* const traceSchLegacyPlugin; /** * Flag to enable GEDA PCB plugin debug output. + * + * Use "KICAD_PCB_PLUGIN" to enable. */ extern const wxChar* const traceKicadPcbPlugin; /** * Flag to enable GEDA PCB plugin debug output. + * + * Use "KICAD_GEDA_PLUGIN" to enable. */ extern const wxChar* const traceGedaPcbPlugin; /** * Flag to enable print controller debug output. + * + * Use "KICAD_PRINT" to enable. */ extern const wxChar* const tracePrinting; /** * Flag to enable path and file name debug output. + * + * Use "KICAD_PATHS_AND_FILES" to enable. */ extern const wxChar* const tracePathsAndFiles; /** * Flag to enable locale debug output. + * + * Use "KICAD_LOCALE" to enable. */ extern const wxChar* const traceLocale; /** * Flag to enable debug output of #BASE_SCREEN and it's derivatives. + * + * Use "KICAD_SCREEN" to enable. */ extern const wxChar* const traceScreen; /** * Flag to enable debug output of zoom-scrolling calculations in - * #KIGFX::ZOOM_CONTROLER and derivatives. + * #KIGFX::ZOOM_CONTROLLER and derivatives. + * + * Use "KICAD_ZOOM_SCROLL" to enable. */ extern const wxChar* const traceZoomScroll;