From b08ac98f1c2572ffdbe617d48a62df0f812c1475 Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Fri, 9 Sep 2016 03:00:54 +0200
Subject: [PATCH] docs: fix gluon-config-mode-contact-info syntax errors and
formatting
---
docs/index.rst | 1 +
.../gluon-config-mode-contact-info.rst | 23 +++++++------------
2 files changed, 9 insertions(+), 15 deletions(-)
diff --git a/docs/index.rst b/docs/index.rst
index 0e5ceff14..6b197ec1b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -52,6 +52,7 @@ Packages
:maxdepth: 1
package/gluon-client-bridge
+ package/gluon-config-mode-contact-info
package/gluon-config-mode-geo-location
package/gluon-ebtables-filter-multicast
package/gluon-ebtables-filter-ra-dhcp
diff --git a/docs/package/gluon-config-mode-contact-info.rst b/docs/package/gluon-config-mode-contact-info.rst
index a38cc0a5a..6072aa5a3 100644
--- a/docs/package/gluon-config-mode-contact-info.rst
+++ b/docs/package/gluon-config-mode-contact-info.rst
@@ -1,28 +1,21 @@
gluon-config-mode-contact-info
==============================
-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
+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
obligatory or not in your site.conf.
site.conf
---------
-config_mode.owner.obligatory : this whole section is optional
- - ``true`` field is obligatory: gluon-node-info.@owner[0].contact may not be empty
- - ``false`` field is optional: gluon-node-info.@owner[0].contact may be empty
- - defaults to ``false``
+config_mode.owner.obligatory \: optional (defaults to false)
+ If ``obligatory`` is set to ``true``, the contact info field must be supplied
+ and may not be left empty.
-# example:
+Example::
config_mode = {
- geo_location = {
- show_altitude = true,
- },
owner = {
obligatory = true
- },
- },
-
-
-
\ No newline at end of file
+ }
+ }
--
GitLab