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

initial whining about absent way to get supported configuration options for a special remote

Browse source
This commit is contained in:
yarikoptic 2019-01-25 02:58:52 +00:00 • committed by admin
parent f21d692535
commit 55376d0a28
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/todo/some_way_to_get_a_list_of_options_for_a_special_remote_of_a_given_type.mdwn Normal file
View file

@ -0,0 +1,10 @@
ATM I do not see any obvious way to get a list of options supported by a special remote of a given type.
manpage says
The remote's configuration is specified by the parameters passed to this command. Different types of special remotes need different configura‐
tion values. The command will prompt for parameters as needed.
and indeed I get asked for e.g. encryption to be explicitly specified (why not to default to none). But it would not even complain if I specify some bogus (mistyped etc) option. I do not see any way (tried different --help's etc) to figure out what options any given special remote actually supports without going online to e.g. https://git-annex.branchable.com/special_remotes/rsync/ for `rsync` special remote. It makes configuration of special remotes not a trivial matter for new users. IMHO there should be some way (mentioned in man of initremote and enableremote) to get information about supported by the remote options, e.g. `git annex getremoteopts TYPE` or alike. I am not sure how it should/would work for custom special remotes since I think protocol ATM doesn't support querying for a list of configuration options. May be `GETCONFIG` interface command could be extended to return a list with of options with description? or some new command be added?
[[!meta author=yoh]]