document required flags

[umlaeute]

It's been a while since i used svn-all-fast-export, so I was slightly annoyed, that it doesn't work out-of-the-box as advertised in the help.

The help says:

$ svn-all-fast-export --help
Invoked as:' svn-all-fast-export --help'
Usage: svn-all-fast-export [OPTION] [Path to subversion repo]

Options:
       --identity-map        provide map between svn username and email
       --identity-domain     provide user domain if no map was given
       --revisions-file      provide a file with revision number that should be processed
       --rules               the rules file(s) that determines what goes where
       --msg-filter          External program / script to modify svn log message
[...]

The way I read this, I have to (obviously) provide a Path to subversion repo, and that's about it.

However, when trying to run as such, I get an error:

$ svn-all-fast-export /path/to/svnrepo/
Invoked as:' svn-all-fast-export /path/to/svnrepo/'
svn-all-fast-export failed: please specify the rules using the 'rules' argument

What's this 'rules' argument? the help speaks of options rather than arguments (and options have leading dashes). I guess this is some leftover from a previous invocation style ala svn-all-fast-export /path/to/svnrepo /path/to/rules.
Also, the help mentions "rules file(s)", but it might be nice to provide an example of such a rules file (without having to go and find the samples directory first (esp. when using a distro-packaged version of svn-all-fast-export)

E.g. I would imagine something like this:

$ svn-all-fast-export --help
Invoked as:' svn-all-fast-export --help'
Usage: svn-all-fast-export [OPTION] --rules </path/to/rules/file> </path/to/subversion/repo>

OPTIONS:
       --rules               the rules file(s) that determines what goes where (REQUIRED)

       --identity-map        provide map between svn username and email
       --identity-domain     provide user domain if no map was given
       --revisions-file      provide a file with revision number that should be processed
       --msg-filter          External program / script to modify svn log message
[...]
$

and

$ svn-all-fast-export /path/to/svnrepo/
Invoked as:' svn-all-fast-export /path/to/svnrepo/'
svn-all-fast-export failed: please specify the rules using the '--rules' option.

Example rules file:
~~~
create repository myproject
end repository
match /trunk/
  repository myproject
  branch main
end match
match /branches/([^/]+)/
  repository myproject
  branch \1
end match
match /tags/([^/]+)/
  repository myproject
  branch refs/tags/\1
end match
~~~

$

[hartwork]

@umlaeute how do you feel about pull request #169 for a fix?

[umlaeute]

better :-)

i still like the idea though, to provide an example rules-file if one is missing (the rules-file is not exactly something you encounter regularly, and having to search the accompanying examples for is tedious :-))

[hartwork]

better :-)

@umlaeute cool, thanks for the review!

i still like the idea though, to provide an example rules-file if one is missing (the rules-file is not exactly something you encounter regularly, and having to search the accompanying examples for is tedious :-))

I see pros and cons with this idea and consider it a separate issue. I'll consider it more but tending towards not adding it.