Do not use -C. Fix up --canonicalRoot and -N,--symlink verbiage.

Author: idodeclare

opengrok-indexer/src/main/java/org/opengrok/indexer/index/Indexer.java

@@ -477,28 +477,27 @@ public static String[] parseOptions(String[] argv) throws ParseException {
                 }
             );
 
-            parser.on("-C", "--canonicalRoot", "=/path/",
-                    "Allow symlinks to canonical targets starting with the specified",
-                    "root without otherwise needing to specify -N,--symlink for such",
-                    "symlinks. A canonical root must end with a file separator. For",
-                    "security a canonical root cannot be the root directory.",
-                    "Option may be repeated.").Do(v -> {
-                            String root = (String) v;
-                            if (!root.endsWith("/") && !root.endsWith("\\")) {
-                                die("--canonicalRoot must end with a separator");
-                            }
-                            if (root.equals("/") || root.equals("\\")) {
-                                die("--canonicalRoot cannot be the root directory");
-                            }
-                            canonicalRoots.add(root);
-                    });
-
             parser.on("-c", "--ctags", "=/path/to/ctags",
                 "Path to Universal Ctags",
                 "By default takes the Universal Ctags in PATH.").
                 Do(ctagsPath -> cfg.setCtags((String) ctagsPath)
             );
 
+            parser.on("--canonicalRoot", "=/path/",
+                    "Allow symlinks to canonical targets starting with the specified root",
+                    "without otherwise needing to specify -N,--symlink for such symlinks. A",
+                    "canonical root must end with a file separator. For security, a canonical",
+                    "root cannot be the root directory. Option may be repeated.").Do(v -> {
+                String root = (String) v;
+                if (!root.endsWith("/") && !root.endsWith("\\")) {
+                    die("--canonicalRoot must end with a separator");
+                }
+                if (root.equals("/") || root.equals("\\")) {
+                    die("--canonicalRoot cannot be the root directory");
+                }
+                canonicalRoots.add(root);
+            });
+
             parser.on("--checkIndexVersion",
                     "Check if current Lucene version matches index version").Do(v -> {
                 checkIndexVersion = true;
@@ -598,9 +597,10 @@ public static String[] parseOptions(String[] argv) throws ParseException {
                     .Do(mandocPath -> cfg.setMandoc((String) mandocPath));
 
             parser.on("-N", "--symlink", "=/path/to/symlink",
-                    "Allow this symlink to be followed. Option may be repeated.",
-                    "By default only symlinks directly under source root directory",
-                    "are allowed. See also -C,--canonicalRoot").Do(v ->
+                    "Allow the symlink to be followed. Other symlinks targeting the same",
+                    "canonical target or canonical children will be allowed too. Option may",
+                    "be repeated. (By default only symlinks directly under source root",
+                    "directory are allowed. See also --canonicalRoot)").Do(v ->
                     allowedSymlinks.add((String) v));
 
             parser.on("-n", "--noIndex",

opengrok-indexer/src/test/java/org/opengrok/indexer/index/IndexDatabaseSymlinksTest.java

@@ -138,8 +138,8 @@ public void testSymlinksWithFullCanonicalRoot() throws IOException, IndexerExcep
 
         /*
          * For this test, don't even bother to include default-accepted links
-         * immediately under sourceRoot, as -C,--canonicalRoot as specified
-         * here encompasses all of external/.
+         * immediately under sourceRoot, as --canonicalRoot as specified here
+         * encompasses all of external/.
          */
         env.setCanonicalRoots(new HashSet<>(Collections.singletonList(
                 externalRoot.getCanonicalPath())));