From bb9141c63012d0305ac65da763af3fb0c427076f Mon Sep 17 00:00:00 2001
From: Jan Srnicek <jsrnicek@cisco.com>
Date: Wed, 30 Aug 2017 14:55:04 +0200
Subject: HONEYCOMB-389 - Static yang binding api and impl

Also provides ignore option for default module list generation

Change-Id: I9e10215491c964e6e88f90d6a3ad4335c94ec7d2
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
---
 common/yang-whitelist/asciidoc/Readme.adoc | 33 ++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 common/yang-whitelist/asciidoc/Readme.adoc

(limited to 'common/yang-whitelist/asciidoc/Readme.adoc')

diff --git a/common/yang-whitelist/asciidoc/Readme.adoc b/common/yang-whitelist/asciidoc/Readme.adoc
new file mode 100644
index 000000000..a3d752884
--- /dev/null
+++ b/common/yang-whitelist/asciidoc/Readme.adoc
@@ -0,0 +1,33 @@
+= whitelist-aggregator
+
+Yang whitelist's are used to restrict list of modules that will be loaded to SchemaContext
+per maven module.
+
+== Usage
+
+Two steps are required to use this feature.
+
+ * Define ***.xml file that defines whitelist itself like so:
+
+[source,xml]
+----
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<yangModuleWhitelist>
+     <modules>
+         <module>
+             <package>Package name of YangModuleProvider class generated for respective yang model</package>
+             <description>General description for model</description>
+         </module>
+     ...
+     </modules>
+</yangModuleWhitelist>
+----
+
+ * Define *yang.modules.whitelist* property in you project pom
+
+[source,xml]
+----
+<yang.modules.whitelist>
+  ${project.basedir}/src/main/resources/honeycomb-minimal-resources/config/restconf-whitelist.xml
+</yang.modules.whitelist>
+----
-- 
cgit 1.2.3-korg

