[PATCH 1/2] git-svn: add some in-code documentation (options-related).

[Yann Dirson <ydirson@altern.org>]

Signed-off-by: Yann Dirson <ydirson@altern.org>
---
 git-svn.perl |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/git-svn.perl b/git-svn.perl
index 3301797..e2d5eff 100755
--- a/git-svn.perl
+++ b/git-svn.perl
@@ -71,6 +71,13 @@ my ($_stdin, $_help, $_edit,
 	$_git_format, $_commit_url, $_tag);
 $Git::SVN::_follow_parent = 1;
 $_q ||= 0;
+
+# Option structures here are used to define both command-line options
+# and git-config keys.  They are handled by read-repo-config().
+# Options in mixed case and with only a long form are only for the
+# config file.  All options available from command-line are available
+# as config-file options too, but without any dash in their names.
+
 my %remote_opts = ( 'username=s' => \$Git::SVN::Prompt::_username,
                     'config-dir=s' => \$Git::SVN::Ra::config_dir,
                     'no-auth-cache' => \$Git::SVN::Prompt::_no_auth_cache,
@@ -184,6 +191,7 @@ my %cmd = (
 			  'show-commit' => \$Git::SVN::Log::show_commit,
 			  'non-recursive' => \$Git::SVN::Log::non_recursive,
 			  'authors-file|A=s' => \$_authors,
+			  # FIXME: lacks authors-prog ?
 			  'color' => \$Git::SVN::Log::color,
 			  'pager=s' => \$Git::SVN::Log::pager
 			} ],
-- 
1.6.3.1