]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2750] add makefile rule for ascii umls
authorAndrei Pavel <andrei@isc.org>
Mon, 25 Sep 2023 13:01:46 +0000 (16:01 +0300)
committerAndrei Pavel <andrei@isc.org>
Fri, 6 Oct 2023 07:07:14 +0000 (10:07 +0300)
* also adds tkey.atxt and update.atxt sequence diagrams in ASCII art,
  although not actively used anywhere yet
* also adds a uml rule to make all targets

doc/sphinx/Makefile.am
doc/sphinx/uml/tkey.atxt [new file with mode: 0644]
doc/sphinx/uml/update.atxt [new file with mode: 0644]

index 1eea0d551bbdc41d8d7ad8210e82f862a194324f..62cf7490d788480e3e8182df6eb1cec626367170 100644 (file)
@@ -145,14 +145,19 @@ svgs += uml/tkey.svg
 svgs += uml/update.svg
 
 if HAVE_PLANTUML
+uml: uml-to-png uml-to-svg format-svgs uml-to-txt
+
 uml-to-png: $(umls)
-       @PLANTUML@ $^
+       @PLANTUML@ -tpng $^
 
 uml-to-svg: $(umls)
-       @PLANTUML@ -svg $^
+       @PLANTUML@ -tsvg $^
 
 format-svgs: $(svgs)
        for svg in $(svgs); do xq -x . $$svg > tmp; mv tmp $$svg; done
+
+uml-to-txt: $(umls)
+       @PLANTUML@ -ttxt $^
 endif
 
 EXTRA_DIST += $(umls)
@@ -201,7 +206,7 @@ clean-local:
        rm -f $(srcdir)/kea-messages.rst $(srcdir)/api.rst
        rm -f $(srcdir)/arm/platforms.rst
 
-.PHONY: all pdf html mans update-python-dependencies uml-to-png uml-to-svg format-svgs
+.PHONY: all pdf html mans update-python-dependencies uml uml-to-png uml-to-svg format-svgs uml-to-txt
 
 endif
 
diff --git a/doc/sphinx/uml/tkey.atxt b/doc/sphinx/uml/tkey.atxt
new file mode 100644 (file)
index 0000000..f348aee
--- /dev/null
@@ -0,0 +1,13 @@
+         TKEY Exchange (GSS-TSIG hook)
+
+     ,-------------.          ,----------.
+     |Kea D2 server|          |DNS server|
+     `------+------'          `----+-----'
+            |     TKEY request     |
+            |---------------------->
+            |                      |
+            |TKEY response (signed)|
+            |<----------------------
+     ,------+------.          ,----+-----.
+     |Kea D2 server|          |DNS server|
+     `-------------'          `----------'
diff --git a/doc/sphinx/uml/update.atxt b/doc/sphinx/uml/update.atxt
new file mode 100644 (file)
index 0000000..f5d1b02
--- /dev/null
@@ -0,0 +1,13 @@
+         DNS Update Exchange (GSS-TSIG hook)
+
+     ,-------------.                ,----------.
+     |Kea D2 server|                |DNS server|
+     `------+------'                `----+-----'
+            |DNS update request (signed) |
+            |---------------------------->
+            |                            |
+            |DNS update response (signed)|
+            |<----------------------------
+     ,------+------.                ,----+-----.
+     |Kea D2 server|                |DNS server|
+     `-------------'                `----------'