SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Mark dynamic configuration format experimental

Browse Source 
As the note states, we still need to decide about the future of this
API.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Jan Kiszka
2017-07-07 12:48:39 +02:00
committed by Daniel Wagner
parent e637b2c725
commit eda4129b54
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/userguide.rst
View File

@@ -368,6 +368,10 @@ Static configuration reference
Dynamic project configuration Dynamic project configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**NOTE: Dynamic project configuration is experimental. The API may change or
even be obsoleted in future versions. Please provide feedback if you consider
it useful.**
The dynamic project configuration is plain Python with following The dynamic project configuration is plain Python with following
mandatory functions which need to be provided: mandatory functions which need to be provided:
@@ -430,5 +434,3 @@ the exection steps in kas core, e.g.
run_wic(config) run_wic(config)
TODO: Document the complete configuration API. TODO: Document the complete configuration API.