From 55376d0a280e073f4be69f423a744e7bd19a96a8 Mon Sep 17 00:00:00 2001 From: yarikoptic Date: Fri, 25 Jan 2019 02:58:52 +0000 Subject: [PATCH] initial whining about absent way to get supported configuration options for a special remote --- ...f_options_for_a_special_remote_of_a_given_type.mdwn | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 doc/todo/some_way_to_get_a_list_of_options_for_a_special_remote_of_a_given_type.mdwn diff --git a/doc/todo/some_way_to_get_a_list_of_options_for_a_special_remote_of_a_given_type.mdwn b/doc/todo/some_way_to_get_a_list_of_options_for_a_special_remote_of_a_given_type.mdwn new file mode 100644 index 0000000000..8c0c3aed2b --- /dev/null +++ b/doc/todo/some_way_to_get_a_list_of_options_for_a_special_remote_of_a_given_type.mdwn @@ -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]]