From d9bd645bf80628eddf1767f72fac2bfb7d666646 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 9 Mar 2020 12:34:13 -0400 Subject: [PATCH] clarify LISTCONFIGS Apparently some externals use GETCONFIG name, and the documentation as written can be read to allow it, although IIRC it was not really my intent to. If someone does do this, they should not include it in LISTCONFIGS, since git-annex already tracks its own config settings. --- doc/design/external_special_remote_protocol.mdwn | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn index 9b69300d8f..2885a24694 100644 --- a/doc/design/external_special_remote_protocol.mdwn +++ b/doc/design/external_special_remote_protocol.mdwn @@ -180,7 +180,9 @@ the special remote can reply with `UNSUPPORTED-REQUEST`. work better, because it can check the user's input, and can also display a list of settings with descriptions. Note that the user is not required to provided all the settings listed here. A block of responses - can be made to this, which must always end with `CONFIGSEND`. + can be made to this, which must always end with `CONFIGSEND`. + (Do not include settings like "name" that are common to all external + special remotes.) * `CONFIG Name Description` Indicates the name and description of a config setting. The description should be reasonably short. Example: @@ -298,7 +300,7 @@ handling a request. been passed by the user when running `git annex initremote`, or can have been set by a previous SETCONFIG. Can be run at any time. It's recommended that special remotes that use this implement - LISTCONFIGS. + LISTCONFIGS. (git-annex replies with VALUE followed by the value. If the setting is not set, the value will be empty.) * `SETCREDS Setting User Password` -- 2.30.2