diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-16 09:25:01 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-16 09:31:27 -0400 |
| commit | 4b00193d6ad8fcc99c5625ede8de07b72ae1c697 (patch) | |
| tree | 50834a826544ec43cacab94543b9e9d3411c46d5 /docs/configuration.rst | |
| parent | 7fe52deb89467c1bb0e7f2a43f4092903b1d0021 (diff) | |
Update toctree to current release notes template
Change-Id: I0864d9e3c46aae885473a18fa21eab205a352eff
Issue-ID: SDC-419
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/configuration.rst')
| -rw-r--r-- | docs/configuration.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 0000000000..085f9c667d --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +.. note:: + * This section is used to describe the options a software component offers for configuration. + + * Configuration is typically: provided for platform-component and sdk projects; + and referenced in developer and user guides. + + * This note must be removed after content has been added. + + + +Example ... + +You can provide the following in ``basic.conf`` + +``host=ADDRESS`` + The address of the host + +``port=PORT`` + The port used for signaling + + Optional. Default: ``8080`` |