summaryrefslogtreecommitdiffhomepage
path: root/tools/pyang_plugins/README.rst
diff options
context:
space:
mode:
authorFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2015-03-03 13:13:05 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2015-03-03 13:13:05 +0900
commit84a846719d75cad500ac83f34eda11035a332599 (patch)
tree3d380a607d962057b5ce5115e2ce079eb9b83a4c /tools/pyang_plugins/README.rst
parentf0ae221b894fdd02f697f4fb6994623082e2175e (diff)
tools: add README for yang plugin
also do some cleanups. Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'tools/pyang_plugins/README.rst')
-rw-r--r--tools/pyang_plugins/README.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/tools/pyang_plugins/README.rst b/tools/pyang_plugins/README.rst
new file mode 100644
index 00000000..04d25614
--- /dev/null
+++ b/tools/pyang_plugins/README.rst
@@ -0,0 +1,20 @@
+What's this ?
+=============
+This is a pyang plugin to generate config/bgp_configs.go from
+openconfig yang files.
+
+Currently, we made some modifications to the yang files:
+
+ https://github.com/osrg/yang/tree/gobgp
+
+
+How to use
+==========
+ $ git clone -b gobgp https://github.com/osrg/yang
+ $ YANG_DIR=`pwd`/yang/experimental/openconfig
+ $ cd $PYANG_INSTALL_DIR
+ $ source ./env.sh
+ $ PYTHONPATH=. ./bin/pyang --plugindir $GOBGP_PATH/tools/pyang_plugins \
+ -p $YANG_DIR/bgp \
+ -p $YANG_DIR/policy \
+ -f golang $YANG_DIR/bgp/bgp.yang |gofmt > $GOBGP_PATH/config/bgp_configs.go