aboutsummaryrefslogtreecommitdiffstats
path: root/test/mocks/netconf-pnp-simulator/docs
diff options
context:
space:
mode:
authorebo <eliezio.oliveira@est.tech>2020-04-11 01:34:47 +0100
committerBartek Grzybowski <b.grzybowski@partner.samsung.com>2020-04-15 10:46:07 +0000
commit398c9b251dc910c4cffc4fc5a3c2b8b221980c91 (patch)
treefa7df466e1a0f4a028445f58992686005e5c80f9 /test/mocks/netconf-pnp-simulator/docs
parent09e87eeadf879bbaa5237a34db1583861097925c (diff)
netconf-pnp-simulator: enable NETCONF send/recv message logging
to aid troubleshooting integration with OpenDaylight - Add more integration tests - Defaults to generic subscriber Issue-ID: INT-1516 Change-Id: Ib5bbf4cdbba6cdfee901f6c07dfa195a21cd8bbb Signed-off-by: ebo <eliezio.oliveira@est.tech>
Diffstat (limited to 'test/mocks/netconf-pnp-simulator/docs')
-rw-r--r--test/mocks/netconf-pnp-simulator/docs/README.rst9
1 files changed, 3 insertions, 6 deletions
diff --git a/test/mocks/netconf-pnp-simulator/docs/README.rst b/test/mocks/netconf-pnp-simulator/docs/README.rst
index 452827970..ec2a15834 100644
--- a/test/mocks/netconf-pnp-simulator/docs/README.rst
+++ b/test/mocks/netconf-pnp-simulator/docs/README.rst
@@ -3,9 +3,6 @@ NETCONF Plug-and-Play Simulator
.. sectnum::
-.. _py-requirements: https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format
-.. _yang-rfc: https://tools.ietf.org/html/rfc6020
-
|ci-badge| |release-badge| |docker-badge|
.. |ci-badge| image:: https://github.com/blue-onap/netconf-pnp-simulator/workflows/CI/badge.svg
@@ -42,13 +39,13 @@ A YANG module contains the following files:
* - Filename
- Purpose
* - ``model.yang``
- - The YANG model specified according to `RFC-6020 <yang-rfc_>`_ and named after the module's name, e.g., *mynetconf.yang*.
+ - The YANG model specified according to `RFC-6020 <https://tools.ietf.org/html/rfc6020>`_ and named after the module's name, e.g., *mynetconf.yang*.
* - ``startup.json`` or ``startup.xml``
- An optional data file with the initial values of the model. Both JSON and XML formats are supported.
* - ``subscriber.py``
- - The Python 3 application that implements the behavioral aspects of the YANG model.
+ - The Python 3 application that implements the behavioral aspects of the YANG model. If you don't supply one, a generic subscriber that logs all received events will be used.
* - ``requirements.txt``
- - [Optional] Lists the additional Python packages required by the application, specified in the `Requirements File Format <py-requirements_>`_.
+ - [Optional] Lists the additional Python packages required by the application, specified in the `Requirements File Format <https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format>`_.
Application
-----------