diff options
author | Jan Srnicek <jsrnicek@cisco.com> | 2017-08-30 14:55:04 +0200 |
---|---|---|
committer | Marek Gradzki <mgradzki@cisco.com> | 2017-09-05 15:39:31 +0000 |
commit | bb9141c63012d0305ac65da763af3fb0c427076f (patch) | |
tree | 85b75f316f4c7705d34c6c4c4a7b324d0fe8fc02 /common/yang-whitelist/asciidoc | |
parent | 0d4a04e1452e19ce96c308cd45a430a3f5b72f04 (diff) |
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>
Diffstat (limited to 'common/yang-whitelist/asciidoc')
-rw-r--r-- | common/yang-whitelist/asciidoc/Readme.adoc | 33 |
1 files changed, 33 insertions, 0 deletions
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> +---- |