docs: fix gluon-config-mode-contact-info syntax errors and formatting

This commit is contained in:
Matthias Schiffer 2016-09-09 03:00:54 +02:00
parent d3811bb2bf
commit b08ac98f1c
No known key found for this signature in database
GPG Key ID: 16EF3F64CB201D9C
2 changed files with 9 additions and 15 deletions

View File

@ -52,6 +52,7 @@ Packages
:maxdepth: 1 :maxdepth: 1
package/gluon-client-bridge package/gluon-client-bridge
package/gluon-config-mode-contact-info
package/gluon-config-mode-geo-location package/gluon-config-mode-geo-location
package/gluon-ebtables-filter-multicast package/gluon-ebtables-filter-multicast
package/gluon-ebtables-filter-ra-dhcp package/gluon-ebtables-filter-ra-dhcp

View File

@ -1,28 +1,21 @@
gluon-config-mode-contact-info gluon-config-mode-contact-info
============================== ==============================
This package allows the user to provide contact information within config mode to be This package allows the user to provide contact information within config mode to be
distributed in the mesh. You can define whether the owner contact field is distributed in the mesh. You can define whether the owner contact field is
obligatory or not in your site.conf. obligatory or not in your site.conf.
site.conf site.conf
--------- ---------
config_mode.owner.obligatory : this whole section is optional config_mode.owner.obligatory \: optional (defaults to false)
- ``true`` field is obligatory: gluon-node-info.@owner[0].contact may not be empty If ``obligatory`` is set to ``true``, the contact info field must be supplied
- ``false`` field is optional: gluon-node-info.@owner[0].contact may be empty and may not be left empty.
- defaults to ``false``
# example: Example::
config_mode = { config_mode = {
geo_location = {
show_altitude = true,
},
owner = { owner = {
obligatory = true obligatory = true
}, }
}, }