Skip to content

Commit 38bfa49

Browse files
authored
Merge pull request #45 from christian-monch/fix-export-doc
extend push to to describe export behavior
2 parents 1c51ef7 + 24ef19e commit 38bfa49

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

datalad_next/patches/push_to_export_remote.py

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,15 @@ def _transfer_data(repo: AnnexRepo,
245245
push.Push.__doc__ += """\
246246
247247
248-
Features added by the datalad-next extension
249-
250-
Transparently transfer data to git-annex special remotes in export-mode (`exporttree=yes`), whenever ...
248+
The following feature is added by the datalad-next extension:
249+
250+
If a target is a git-annex special remote that has "exporttree" set to
251+
"yes", push will call 'git-annex export' to export the current HEAD to the
252+
remote target. This will usually result in a copy of the file tree, to which
253+
HEAD refers, on the remote target. A git-annex special remote with
254+
"exporttree" set to "yes" can, for example, be created with the datalad
255+
command "create-sibling-webdav" with the option "--mode=filetree" or
256+
"--mode=filetree-only".
251257
"""
252258
push.Push._params_["force"] = Parameter(
253259
args=("-f", "--force",),

0 commit comments

Comments
 (0)