From: Jason Ish <jason.ish@emulex.com>
Date: Thu, 28 Nov 2013 15:46:14 +0000 (-0600)
Subject: Better document ConfSet and ConfSetFinal.
X-Git-Tag: suricata-2.0beta2~80
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5f6705c4dc2cdd20451513b01e049f1565ea566f;p=thirdparty%2Fsuricata.git

Better document ConfSet and ConfSetFinal.
---

diff --git a/src/conf.c b/src/conf.c
index 9f3deb4a5a..f27bab7878 100644
--- a/src/conf.c
+++ b/src/conf.c
@@ -206,9 +206,12 @@ ConfGetRootNode(void)
 /**
  * \brief Set a configuration value.
  *
+ * Configuration values set with this function may be overridden by
+ * subsequent calls, or if the value appears multiple times in a
+ * configuration file.
+ *
  * \param name The name of the configuration parameter to set.
  * \param val The value of the configuration parameter.
- * \param allow_override Can a subsequent set override this value.
  *
  * \retval 1 if the value was set otherwise 0.
  */
@@ -225,6 +228,20 @@ ConfSet(char *name, char *val)
     return 1;
 }
 
+/**
+ * \brief Set a final configuration value.
+ *
+ * A final configuration value is a value that cannot be overridden by
+ * the configuration file.  Its mainly useful for setting values that
+ * are supplied on the command line prior to the configuration file
+ * being loaded.  However, a subsequent call to this function can
+ * override a previously set value.
+ *
+ * \param name The name of the configuration parameter to set.
+ * \param val The value of the configuration parameter.
+ *
+ * \retval 1 if the value was set otherwise 0.
+ */
 int
 ConfSetFinal(char *name, char *val)
 {