From: Tomek Mrugalski <tomasz@isc.org>
Date: Tue, 2 Oct 2018 13:01:09 +0000 (+0200)
Subject: [#10,!3] generate-templates script updated
X-Git-Tag: 176-update-to-sysrepo-0-7-6-release_base~169
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=84a5a8af7d6523c18eb45f1da291a4c257700a07;p=thirdparty%2Fkea.git

[#10,!3] generate-templates script updated
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1237c598ca..98c3de0377 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -74,6 +74,12 @@ guide:
 clean:
 	rm -rf html
 
+templates:
+	docgen/generate-templates docgen/cmds-list
+
+api: templates
+	docgen/kea-docgen api/*.json
+
 # That's a bit of a hack, but we are making sure that devel target
 # is always valid. The alternative is to make devel depend on all
 # *.cc *.h files in the whole tree.
diff --git a/doc/docgen/generate-templates b/doc/docgen/generate-templates
index 7f5353f379..c38f69b8e1 100755
--- a/doc/docgen/generate-templates
+++ b/doc/docgen/generate-templates
@@ -1,18 +1,44 @@
 #!/bin/bash
-while read -r LINE; do
-    F=$LINE.json
+
+# This script generates API documentation templates.
+# Usage:
+#
+# ./generate-templates file
+#
+# File is expected to have a list of commands, one per line.
+# The templates will be created in api/ directory.
+
+if (( $# != 1 )); then
+    echo "Usage: ./generate-templates file"
+    echo
+    echo "File specifies a plain text file with each line having name of a command"
+    exit
+fi
+
+
+mkdir -p api/
+
+while read -r CMD; do
+    F=api/$CMD.json
+
+    if [ -e $F ]; then
+        echo "$F exists, skipping"
+        continue;
+    fi
     echo "{" > $F
-    echo "    \"name\": \"$LINE\",\n" >> $F
-    echo "    \"brief\": \"a sentence or two explaining what this command does\",\n" >> $F
-    echo "    \"support\": [ \"kea-dhcp4\", \"kea-dhcp6\" ],\n" >> $F
-    echo "    \"avail\": \"first version, possible a hook library name and (premium) if applicable\",\n" >> $F
+    echo "    \"name\": \"$CMD\"," >> $F
+    echo "    \"brief\": \"a sentence or two explaining what this command does\"," >> $F
+    echo "    \"description\": \"See <xref linkend=\\\"cmd-$LINE\\\"/>\"," >> $F
+    echo "    \"support\": [ \"undocumented\" ]," >> $F
+    echo "    \"avail\": \"first Kea version this command appeared in\"," >> $F
+    echo "    \"hook\": \"\"," >> $F
 
-    echo "    \"cmd-syntax\": \"Syntax of the command\",\n" >> $F
-    echo "    \"cmd-comment\": \"Possibly some extra comments after the syntax.\",\n" >> $F
+    echo "    \"cmd-syntax\": \"Syntax of the command\"," >> $F
+    echo "    \"cmd-comment\": \"Possibly some extra comments after the syntax.\"," >> $F
 
-    echo "    \"resp-syntax\": \"Syntax of the response\",\n" >> $F
-    echo "    \"resp-comment\": \"Optional extra comments after the respone syntax.\"\n" >> $F
+    echo "    \"resp-syntax\": \"Syntax of the response\"," >> $F
+    echo "    \"resp-comment\": \"Optional extra comments after the resposne syntax.\"" >> $F
     echo "}" >> $F
 
-    echo "$LINE generated."
-done < cmds-list
+    echo "$CMD generated."
+done < $1