Merge pull request #1973 from aneeshusa/clarify-config-discovery-order

Clarify the plugin discovery search & priority orders.

config.go

@@ -49,11 +49,13 @@ func decodeConfig(r io.Reader, c *config) error {
 
 // Discover discovers plugins.
 //
-// This looks in the directory of the executable and the CWD, in that
-// order for priority.
+// Search the directory of the executable, then the plugins directory, and
+// finally the CWD, in that order. Any conflicts will overwrite previously
+// found plugins, in that order.
+// Hence, the priority order is the reverse of the search order - i.e., the
+// CWD has the highest priority.
 func (c *config) Discover() error {
-	// Next, look in the same directory as the executable. Any conflicts
-	// will overwrite those found in our current directory.
+	// First, look in the same directory as the executable.
 	exePath, err := osext.Executable()
 	if err != nil {
 		log.Printf("[ERR] Error loading exe directory: %s", err)
@@ -63,7 +65,7 @@ func (c *config) Discover() error {
 		}
 	}
 
-	// Look in the plugins directory
+	// Next, look in the plugins directory.
 	dir, err := ConfigDir()
 	if err != nil {
 		log.Printf("[ERR] Error loading config directory: %s", err)
@@ -73,7 +75,7 @@ func (c *config) Discover() error {
 		}
 	}
 
-	// Look in the cwd.
+	// Last, look in the CWD.
 	if err := c.discover("."); err != nil {
 		return err
 	}