Skip to content
Snippets Groups Projects
Unverified Commit b08ac98f authored by Matthias Schiffer's avatar Matthias Schiffer
Browse files

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

parent d3811bb2
No related branches found
No related tags found
No related merge requests found
...@@ -52,6 +52,7 @@ Packages ...@@ -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
......
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
}, }
}, }
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment