diff mbox

[API-NEXT,PATCHv2,1/3] doc: images: add gv file for pktio state machine

Message ID 1456914944-15985-1-git-send-email-bill.fischofer@linaro.org
State Superseded
Headers show

Commit Message

Bill Fischofer March 2, 2016, 10:35 a.m. UTC 
The PktIO FSM state diagram is built using GraphVis. Add the files and
associated Makefile and .gitignore changes needed to support this new
file.

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 doc/Makefile.inc            |  3 +++
 doc/images/.gitignore       |  1 +
 doc/images/pktio_fsm.gv     | 17 +++++++++++++++++
 doc/users-guide/Makefile.am |  2 ++
 4 files changed, 23 insertions(+)
 create mode 100644 doc/images/pktio_fsm.gv
diff mbox

Patch

diff --git a/doc/Makefile.inc b/doc/Makefile.inc
index cab5286..86b2427 100644
--- a/doc/Makefile.inc
+++ b/doc/Makefile.inc
@@ -3,4 +3,7 @@  VPATH=$(top_builddir)/doc/images
 .msc.svg:
 	mscgen -T svg -i $^ -o $@
 
+.gv.svg:
+	dot -T svg $^ -o $@
+
 ASCIIDOC_FLAGS =-a data-uri -b html5  -a icons -a toc2  -a max-width=55em
diff --git a/doc/images/.gitignore b/doc/images/.gitignore
index 1647e41..a19aa75 100644
--- a/doc/images/.gitignore
+++ b/doc/images/.gitignore
@@ -1 +1,2 @@ 
 resource_management.svg
+pktio_fsm.svg
diff --git a/doc/images/pktio_fsm.gv b/doc/images/pktio_fsm.gv
new file mode 100644
index 0000000..09199c6
--- /dev/null
+++ b/doc/images/pktio_fsm.gv
@@ -0,0 +1,17 @@ 
+digraph pktio_state_machine {
+	rankdir=LR;
+	size="9,12";
+	node [fontsize=28];
+	edge [fontsize=28];
+	node [shape=doublecircle]; Unallocated Ready;
+	node [shape=circle];
+	Unallocated -> Unconfigured [label="odp_pktio_open()"];
+	Unconfigured -> Unallocated [label="odp_pktio_close()"];
+	Unconfigured -> Configured [label="odp_pktin_queue_config()"];
+	Unconfigured -> Configured [label="odp_pktout_queue_config()"];
+	Configured -> Configured [label="odp_pktin_queue_config()"];
+	Configured -> Configured [label="odp_pktout_queue_config()"];
+	Configured -> Ready [label="odp_pktio_start()"];
+	Ready -> Configured [label="odp_pktio_stop()"];
+	Configured -> Unallocated [label="odp_pktio_close()"];
+}
\ No newline at end of file
diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am
index 4f5b1fe..3f8ce3d 100644
--- a/doc/users-guide/Makefile.am
+++ b/doc/users-guide/Makefile.am
@@ -11,6 +11,8 @@  IMAGES = $(top_srcdir)/doc/images/overview.svg \
 	 $(top_srcdir)/doc/images/atomic_queue.svg \
 	 $(top_srcdir)/doc/images/ordered_queue.svg
 
+IMAGES += $(top_srcdir)/doc/images/pktio_fsm.svg
+
 if HAVE_MSCGEN
 IMAGES += $(top_srcdir)/doc/images/resource_management.svg
 endif