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

clarify LISTCONFIGS

Browse source 
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.
This commit is contained in:
Joey Hess 2020-03-09 12:34:13 -04:00
parent b2c4ca6da1
commit d9bd645bf8
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/design/external_special_remote_protocol.mdwn
View file

@ -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 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 a list of settings with descriptions. Note that the user is not required
to provided all the settings listed here. A block of responses 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` * `CONFIG Name Description`
Indicates the name and description of a config setting. The description Indicates the name and description of a config setting. The description
should be reasonably short. Example: should be reasonably short. Example:
@ -298,7 +300,7 @@ handling a request.
been passed by the user when running `git annex initremote`, or 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. can have been set by a previous SETCONFIG. Can be run at any time.
It's recommended that special remotes that use this implement 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 (git-annex replies with VALUE followed by the value. If the setting is
not set, the value will be empty.) not set, the value will be empty.)
* `SETCREDS Setting User Password` * `SETCREDS Setting User Password`