git-annex/doc
Joey Hess 99cb3e75f1
add LISTCONFIGS to external special remote protocol
Special remote programs that use GETCONFIG/SETCONFIG are recommended
to implement it.

The description is not yet used, but will be useful later when adding a way
to make initremote list all accepted configs.

configParser now takes a RemoteConfig parameter. Normally, that's not
needed, because configParser returns a parter, it does not parse it
itself. But, it's needed to look at externaltype and work out what
external remote program to run for LISTCONFIGS.

Note that, while externalUUID is changed to a Maybe UUID, checkExportSupported
used to use NoUUID. The code that now checks for Nothing used to behave
in some undefined way if the external program made requests that
triggered it.

Also, note that in externalSetup, once it generates external,
it parses the RemoteConfig strictly. That generates a
ParsedRemoteConfig, which is thrown away. The reason it's ok to throw
that away, is that, if the strict parse succeeded, the result must be
the same as the earlier, lenient parse.

initremote of an external special remote now runs the program three
times. First for LISTCONFIGS, then EXPORTSUPPORTED, and again
LISTCONFIGS+INITREMOTE. It would not be hard to eliminate at least
one of those, and it should be possible to only run the program once.
2020-01-17 16:07:17 -04:00
..
Android
android
assistant response 2019-09-16 13:52:36 -04:00
automatic_conflict_resolution
backends
bare_repositories
bugs 2020-01-06 15:47:14 +00:00
chunking Added a comment: buffering chunks in memory when uploading to remote 2019-09-04 19:50:42 +00:00
coding_style
contribute
copies
design add LISTCONFIGS to external special remote protocol 2020-01-17 16:07:17 -04:00
devblog devblog 2020-01-15 14:14:46 -04:00
direct_mode
download
encryption
footer
forum Added a comment 2020-01-16 14:22:07 +00:00
future_proofing
git-annex-addurl
git-annex-adjust
git-annex-checkpresentkey
git-annex-config
git-annex-copy
git-annex-direct
git-annex-drop
git-annex-enableremote
git-annex-find
git-annex-importfeed
git-annex-lookupkey
git-annex-metadata Added a comment 2019-09-24 14:49:21 +00:00
git-annex-move
git-annex-p2p Added a comment: --link accepts itself 2019-10-10 05:28:53 +00:00
git-annex-preferred-content
git-annex-reinject
git-annex-rmurl
git-annex-setpresentkey
git-annex-sync
git-annex-test
git-annex-unannex
git-annex-undo
git-annex-uninit
git-annex-unlock update comments to point to conversion docs 2020-01-01 14:38:40 -04:00
git-annex-unused comments 2020-01-01 15:03:01 -04:00
git-annex-whereis
how_it_works
install comment 2020-01-01 15:04:37 -04:00
internals Added a comment: Key character set 2019-12-10 10:27:58 +00:00
license
links Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
metadata
news add news item for git-annex 7.20191230 2019-12-30 14:50:15 -04:00
not
polls
preferred_content
profiling wrap up 2019-12-18 15:19:19 -04:00
projects added <details> to fold done/fixed things 2019-11-04 17:56:46 +00:00
required_content
scalability
security Added a comment: Another use case -- http_proxy 2019-11-12 17:51:25 +00:00
special_remotes add LISTCONFIGS to external special remote protocol 2020-01-17 16:07:17 -04:00
stickers
sync Merge branch 'master' of ssh://git-annex.branchable.com 2019-07-19 14:49:37 -04:00
templates
testimonials
thanks update 2019-12-05 12:28:42 -04:00
tips Added a comment: preferred way to automate population of the cache upon get 2020-01-13 19:01:11 +00:00
todo Merge branch 'master' of ssh://git-annex.branchable.com 2020-01-15 14:16:27 -04:00
trust
tuning
upgrades
use_case
users Added a listing statement for pages which should be tagged 2019-09-22 00:32:41 +00:00
videos
walkthrough Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
workflow Added a comment: why not git-annex-sync 2019-09-26 17:47:55 +00:00
Android.mdwn
assistant.mdwn
automatic_conflict_resolution.mdwn
backends.mdwn added a hyperlink to key_format 2019-11-30 17:00:58 +00:00
bare_repositories.mdwn
bugs.mdwn
builds.mdwn
chunking.mdwn
coding_style.mdwn
comments.mdwn
contact.mdwn
contribute.mdwn
copies.mdwn
design.mdwn
devblog.mdwn
direct_mode.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
distributed_version_control.mdwn
download.mdwn fix git:// url for repo 2019-08-25 19:12:58 +00:00
encryption.mdwn
favicon.ico
forum.mdwn
future_proofing.mdwn
git-annex-add.mdwn add --force-annex/--force-git 2020-01-01 14:03:06 -04:00
git-annex-addunused.mdwn
git-annex-addurl.mdwn mention special remotes 2019-11-11 13:15:01 -04:00
git-annex-adjust.mdwn adjust --lock: This enters an adjusted branch where files are locked. 2019-09-27 14:23:25 -04:00
git-annex-assistant.mdwn
git-annex-benchmark.mdwn improve hints about squelching output 2019-11-22 17:26:13 -04:00
git-annex-calckey.mdwn
git-annex-checkpresentkey.mdwn
git-annex-config.mdwn annex.addunlocked expressions 2019-12-20 15:56:25 -04:00
git-annex-contentlocation.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
git-annex-copy.mdwn fix typo 2019-09-18 13:11:53 -04:00
git-annex-dead.mdwn
git-annex-describe.mdwn
git-annex-diffdriver.mdwn
git-annex-direct.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
git-annex-drop.mdwn improve git-annex-drop man page required content docs 2019-06-26 12:22:59 -04:00
git-annex-dropkey.mdwn
git-annex-dropunused.mdwn
git-annex-edit.mdwn
git-annex-enable-tor.mdwn
git-annex-enableremote.mdwn
git-annex-examinekey.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
git-annex-expire.mdwn
git-annex-export.mdwn
git-annex-find.mdwn
git-annex-findref.mdwn
git-annex-fix.mdwn
git-annex-forget.mdwn
git-annex-fromkey.mdwn
git-annex-fsck.mdwn
git-annex-fuzztest.mdwn
git-annex-get.mdwn
git-annex-group.mdwn
git-annex-groupwanted.mdwn
git-annex-import.mdwn encourage use of import from directory special remote rather than legacy interface 2019-11-19 13:30:27 -04:00
git-annex-importfeed.mdwn
git-annex-indirect.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
git-annex-info.mdwn
git-annex-init.mdwn
git-annex-initremote.mdwn fix sameas inherited key removal 2019-10-11 13:18:27 -04:00
git-annex-inprogress.mdwn inprogress: Support --key 2019-12-18 14:14:16 -04:00
git-annex-list.mdwn
git-annex-lock.mdwn
git-annex-log.mdwn
git-annex-lookupkey.mdwn
git-annex-map.mdwn
git-annex-matchexpression.mdwn annex.addunlocked expressions 2019-12-20 15:56:25 -04:00
git-annex-matching-expression.mdwn annex.addunlocked expressions 2019-12-20 15:56:25 -04:00
git-annex-matching-options.mdwn added --unlocked and --locked 2019-09-19 12:33:13 -04:00
git-annex-merge.mdwn git-annex merge branch 2019-08-09 13:21:15 -04:00
git-annex-metadata.mdwn
git-annex-migrate.mdwn
git-annex-mirror.mdwn
git-annex-move.mdwn
git-annex-multicast.mdwn
git-annex-numcopies.mdwn
git-annex-p2p.mdwn
git-annex-post-receive.mdwn post-receive hook updateInstead emulation cleanup 2019-09-11 14:41:51 -04:00
git-annex-pre-commit.mdwn v7 for all repositories 2019-08-30 14:09:14 -04:00
git-annex-preferred-content.mdwn clarify 2019-07-19 13:24:50 -04:00
git-annex-proxy.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
git-annex-readpresentkey.mdwn
git-annex-registerurl.mdwn
git-annex-reinit.mdwn
git-annex-reinject.mdwn
git-annex-rekey.mdwn
git-annex-remotedaemon.mdwn remotedaemon: Don't list --stop in help since it's not supported. 2019-09-30 14:40:46 -04:00
git-annex-renameremote.mdwn get rid of hardcoded "name" lookups 2019-10-10 13:25:10 -04:00
git-annex-repair.mdwn
git-annex-required.mdwn
git-annex-resolvemerge.mdwn
git-annex-rmurl.mdwn
git-annex-schedule.mdwn
git-annex-semitrust.mdwn
git-annex-setkey.mdwn
git-annex-setpresentkey.mdwn
git-annex-shell.mdwn
git-annex-smudge.mdwn documentation for making git add only annex when configured by annex.largefiles 2019-10-24 14:01:54 -04:00
git-annex-status.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
git-annex-sync.mdwn
git-annex-test.mdwn
git-annex-testremote.mdwn
git-annex-transferkey.mdwn
git-annex-transferkeys.mdwn
git-annex-trust.mdwn
git-annex-unannex.mdwn
git-annex-undo.mdwn
git-annex-ungroup.mdwn
git-annex-uninit.mdwn
git-annex-unlock.mdwn improve docs for v7 unlock 2019-09-12 13:58:12 -04:00
git-annex-untrust.mdwn
git-annex-unused.mdwn
git-annex-upgrade.mdwn Added annex.autoupgraderepository configuration 2019-09-01 13:42:26 -04:00
git-annex-vadd.mdwn
git-annex-vcycle.mdwn
git-annex-version.mdwn
git-annex-vfilter.mdwn
git-annex-vicfg.mdwn
git-annex-view.mdwn
git-annex-vpop.mdwn
git-annex-wanted.mdwn
git-annex-watch.mdwn
git-annex-webapp.mdwn
git-annex-whereis.mdwn
git-annex.mdwn annex.addunlocked expressions 2019-12-20 15:56:25 -04:00
git-remote-tor-annex.mdwn
git-union-merge.mdwn
how_it_works.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
index.mdwn Revert malicious removal of index page 2019-11-19 12:36:48 -04:00
install.mdwn docs for git-annex-standalone rpm 2019-09-13 12:18:36 -04:00
internals.mdwn generalize docs so they will also work when git uses SHA256 2020-01-07 16:10:57 -04:00
license.mdwn
location_tracking.mdwn
logo-old-bw.svg
logo-old.png
logo-old.svg
logo-old_small.png
logo.mdwn
logo.svg
logo_16x16.png
logo_32x32.png
logo_small.png
meta.mdwn
metadata.mdwn
news.mdwn
not.mdwn
polls.mdwn
preferred_content.mdwn
privacy.mdwn
profiling.mdwn
projects.mdwn add projects page, move datalad there 2019-09-19 10:47:12 -04:00
publicrepos.mdwn
related_software.mdwn
repomap.png
required_content.mdwn
scalability.mdwn
security.mdwn link to contact 2019-07-31 16:37:21 -04:00
shortcuts.mdwn
sidebar.mdwn
sitemap.mdwn
special_remotes.mdwn finally document initremote type=git 2019-10-04 11:22:46 -04:00
stickers.mdwn
submodules.mdwn Automatically convert direct mode repositories to v7 with adjusted unlocked branches 2019-08-26 15:05:25 -04:00
summary.mdwn
sync.mdwn
testimonials.mdwn
thanks.mdwn
tips.mdwn
todo.mdwn
transferring_data.mdwn
trust.mdwn
tuning.mdwn
upgrades.mdwn documentation for making git add only annex when configured by annex.largefiles 2019-10-24 14:01:54 -04:00
users.mdwn
videos.mdwn
Void.mdwn
walkthrough.mdwn
workflow.mdwn