Hi, Here's a patch for the advanced config dev-docs. Basically, it says "here be dragons, use at your peril". I realise after re-reading the docs I wrote before, that this is not clear.
Sending to the list as I don't want to introduce "policy" in this way without discussion. If anyone wishes to, feel free to modify as needed! Cheers, John
From 5668baa611bf952e402e5f104e9ba0b18aac84cd Mon Sep 17 00:00:00 2001 From: John Beard <john.j.be...@gmail.com> Date: Sun, 10 Feb 2019 21:54:31 +0000 Subject: [PATCH] Docs: Advanced config is explicity experimental Any advanced config option is not to be considered production-ready, so make this clear in the dev-docs. --- Documentation/development/testing.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/development/testing.md b/Documentation/development/testing.md index 4c4cf29e6..f58844b1c 100644 --- a/Documentation/development/testing.md +++ b/Documentation/development/testing.md @@ -294,6 +294,11 @@ To set these options, you can create the file `kicad_advanced` and set the keys as desired (the [advanced config documentation][] for a current list. You should never need to set these keys for normal usage - if you do, that's a bug. +Any features enabled though the advanced configuration system are +considered experimental and therefore unsuitable for production use. These +features are explicitly not supported or considered fully tested. +Issues are still welcome for defects discovered. + [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 -- 2.20.1
_______________________________________________ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
