summaryrefslogtreecommitdiffstats
path: root/release-notes/src
diff options
context:
space:
mode:
authorJan Srnicek <jsrnicek@cisco.com>2017-07-21 15:10:46 +0200
committerMarek Gradzki <mgradzki@cisco.com>2017-07-25 12:28:32 +0200
commitaa44951faf04e2cddfc537bbc9f6a18d76c76ec1 (patch)
tree5d12ef3105e49495db20dcb052a76d23c953cc03 /release-notes/src
parent4f15c1ba2bec17a5e62e3bb2656454abb86ca6e5 (diff)
HC2VPP-180 - Doc coverage generator
TODO - links to specific vpp api section(now points just to section with apis) TODO - links to specific java binding code(now points to class thats doing binding) TODO - operational coverage(ASM does not support lambda processing) TODO - generate coverage adoc links Change-Id: I44c85012da3bd2e7cdd41930753e5aae6955cd7b Signed-off-by: Jan Srnicek <jsrnicek@cisco.com> Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
Diffstat (limited to 'release-notes/src')
-rw-r--r--release-notes/src/main/asciidoc/api_docs/api_docs.adoc3
-rw-r--r--release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc19
-rw-r--r--release-notes/src/main/asciidoc/release_notes.adoc4
3 files changed, 25 insertions, 1 deletions
diff --git a/release-notes/src/main/asciidoc/api_docs/api_docs.adoc b/release-notes/src/main/asciidoc/api_docs/api_docs.adoc
new file mode 100644
index 000000000..5d519c68d
--- /dev/null
+++ b/release-notes/src/main/asciidoc/api_docs/api_docs.adoc
@@ -0,0 +1,3 @@
+== API documentation
+
+link:api_docs_index.html[VPP API to Yang index]
diff --git a/release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc b/release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc
new file mode 100644
index 000000000..08dfeb28f
--- /dev/null
+++ b/release-notes/src/main/asciidoc/api_docs/api_docs_index.adoc
@@ -0,0 +1,19 @@
+== VPP api to Yang index
+
+// TODO - generate this file based on list of JVPP plugins used
+
+Mapping between VPP binary apis and JVpp binding in hc2vpp
+
+include::api_docs/futurejvppcore-yang-config-index.adoc[JVpp Core plugin docs]
+
+include::api_docs/futurejvppacl-yang-config-index.adoc[JVpp Acl plugin docs]
+
+include::api_docs/futurejvppsnat-yang-config-index.adoc[JVpp Snat plugin docs]
+
+include::api_docs/futurejvppnsh-yang-config-index.adoc[JVpp Nsh plugin docs]
+
+include::api_docs/futurejvppioamtrace-yang-config-index.adoc[JVpp Ioam Trace plugin docs]
+
+include::api_docs/futurejvppioampot-yang-config-index.adoc[JVpp Ioam Pot plugin docs]
+
+include::api_docs/futurejvppioamexport-yang-config-index.adoc[JVpp Ioam Export plugin docs]
diff --git a/release-notes/src/main/asciidoc/release_notes.adoc b/release-notes/src/main/asciidoc/release_notes.adoc
index 7471cda9d..7f9c84a82 100644
--- a/release-notes/src/main/asciidoc/release_notes.adoc
+++ b/release-notes/src/main/asciidoc/release_notes.adoc
@@ -26,4 +26,6 @@ include::install_guide/install_guide.adoc[]
include::user_guide/user_guide.adoc[]
-include::devel_guide/devel_guide.adoc[] \ No newline at end of file
+include::devel_guide/devel_guide.adoc[]
+
+include::api_docs/api_docs.adoc[] \ No newline at end of file