Comment about config option modification dependencies

When we add/remove/modify a configuration option in ConfigIni.java, some
external modifications are required in the odlparent and docs projects.
Make this clear in a comment.

Change-Id: Id5ceb334cdf1075a1090b229672b1a3c5c575e24
Signed-off-by: Lorand Jakab <lojakab@cisco.com>

diff --git a/mappingservice/config/src/main/java/org/opendaylight/lispflowmapping/config/ConfigIni.java b/mappingservice/config/src/main/java/org/opendaylight/lispflowmapping/config/ConfigIni.java
index 6c28d7059b3b43f1fd894106a4ddf503b37911a9..943990b612fed22bbab4d188e13cb95b230780d4 100644 (file)
--- a/mappingservice/config/src/main/java/org/opendaylight/lispflowmapping/config/ConfigIni.java
+++ b/mappingservice/config/src/main/java/org/opendaylight/lispflowmapping/config/ConfigIni.java
@@ -25,6 +25,16 @@ public final class ConfigIni {
     private long smrTimeout;
     private int smrRetryCount;
 
+    /*
+     * XXX  When configuration options are added or removed, they should also be added/removed in the karaf
+     * `etc/custom.properties file`, hosted in the odlparent repository [0]. The "Configuring LISP Flow Mapping"
+     * section in the LISP Flow Mapping User Guide [1] has to be updated too, including when a configuration option's
+     * semantics or behavior is changed, in addition to having added/removed and option. Since we don't document
+     * options extensively in this file, the User Guide is the canonical documentation for them.
+     *
+     * [0] https://git.opendaylight.org/gerrit/gitweb?p=odlparent.git;a=blob;f=karaf/opendaylight-karaf-resources/src/main/resources/etc/custom.properties
+     * [1] https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=blob;f=docs/user-guide/lisp-flow-mapping-user-guide.rst
+     */
     private static final String LISP_LOOKUP_POLICY = "lisp.lookupPolicy";
     private static final String LISP_MAPPING_MERGE = "lisp.mappingMerge";
     private static final String LISP_SMR = "lisp.smr";