mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

--whatelse is a better name than --describe-other-params

Browse source 
The use case is basically the user having forgotten, so --help would be
best, but it would be quite hard to include this in --help, since it may
even have to spin up an external special remote program.

I also considered --umm but typoed it the first time I tried it as
--uum, and while memorable, it's too cutesy. --whatelse is good because
it explicitly asks, what other params, besides the ones I've given?
This commit is contained in:
Joey Hess 2020-01-20 17:04:45 -04:00
parent 55f596e9b4
commit 5c6bf1be97
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
4 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/git-annex-initremote.mdwn
View file

@ -21,7 +21,7 @@ The remote's configuration is specified by the parameters passed
to this command. Different types of special remotes need different
configuration values, so consult the documentation of a special remote for
details. The command will prompt for any required parameters you leave out;
you can also pass --describe-other-params to see additional parameters.
you can also pass --whatelse to see additional parameters.
A few parameters that are supported by all special remotes are documented in
the next section below.
@ -38,14 +38,14 @@ want to use `git annex renameremote`.
# OPTIONS
* `--describe-other-params` / `-p`
* `--whatelse` / `-w`
Describe additional configuration parameters that you could specify.
For example, if you know you want a S3 remote, but forget how to
configure it:
git annex initremote mys3 type=S3 --describe-other-params
git annex initremote mys3 type=S3 --whatelse
* `--fast`
@ -88,7 +88,7 @@ want to use `git annex renameremote`.
For details about this and other encrpytion settings, see
<https://git-annex.branchable.com/encryption/>
or --describe-other-params
or --whatelse
* `autoenable`

4
doc/todo/some_way_to_get_a_list_of_options_for_a_special_remote_of_a_given_type.mdwn
View file

@ -10,8 +10,8 @@ and indeed I get asked for e.g. encryption to be explicitly specified (why not t
[[!meta author=yoh]]
[[!tag projects/datalad]]
> [[done]] as eg `git annex initremote type=rsync --describe-other-params`.
> [[done]] as eg `git annex initremote type=rsync --whatelse`.
>
> External special remotes that implement LISTCONFIGS can also be queried:
>
> git annex inittype type=external externaltype=foo --describe-other-params
> git annex inittype type=external externaltype=foo --whatelse