From: Adam Spiers <mr@adamspiers.org>
Date: Thu, 10 Nov 2011 22:12:08 +0000 (+0000)
Subject: Add a comment explaining what selectrepos() returns.
X-Git-Url: https://git.madduck.net/code/myrepos.git/commitdiff_plain/269aa9ecd3cb6d6ef069c610ef7c4130f2271998?ds=sidebyside

Add a comment explaining what selectrepos() returns.

In particular this is useful for understanding what paths
it returns, and that they have a trailing slash.
(cherry picked from commit 3d6acc19e4d029657f72bbf7200a48b5438a643a)
---

diff --git a/mr b/mr
index 956dd7d..3a168d1 100755
--- a/mr
+++ b/mr
@@ -946,7 +946,10 @@ sub repodir {
 	return $ret;
 }
 
-# figure out which repos to act on
+# Figure out which repos to act on.  Returns a list of array refs
+# in the format:
+#
+#   [ "$full_repo_path/", "$mr_config_path/", $section_header ]
 sub selectrepos {
 	my @repos;
 	foreach my $repo (repolist()) {