From 8dbb794cfec7fa02de5de2d1ec799541ee6469c6 Mon Sep 17 00:00:00 2001 From: Shachar Snapiri Date: Thu, 30 Nov 2017 08:11:50 +0200 Subject: [PATCH] Added documentation to the db-model app Added app usage instructions to the testing and debugging document. Change-Id: Ice0dc6c29f6afe0a383606156610e3cdb5fe06a5 Closes-Bug: #1734146 --- doc/source/testing_and_debugging.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/source/testing_and_debugging.rst b/doc/source/testing_and_debugging.rst index a83e2c420..1f7f1adc4 100644 --- a/doc/source/testing_and_debugging.rst +++ b/doc/source/testing_and_debugging.rst @@ -73,4 +73,18 @@ dump db content, list db tables, list db table keys and print value of the specific key in the table. Use *df-db --help* to list and get details on supported sub-commands. +:: + + > df-model + + +This utility will allow to print a representation of the DragonFlow model in +different formats. Currently supported formats are: text, PlantUML and +JsonSchema (OpenApiSchema 3.0). The output may be sent to the stdout or to a +file. +* PlantUML output can be visualized using the PlantUML Server [#]_ + +Use the *df-model --help* command to get a detailed usage instructions. + .. [#] https://gist.github.com/omeranson/5c731955edcf0517bfb0ce0ce511cc9b +.. [#] http://www.plantuml.com/plantuml/uml/