summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2016-02-16 14:43:43 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2016-02-16 14:43:43 -0400
commitc11633a52dbdcc187f5afcef50776fa41c7327ce (patch)
tree1de24f154cb953f9ce78c68315bc046d48f838c7 /doc
parent3776dee0a33fe3fe0cd1aceb14b5c2d0511d6c05 (diff)
annex.addunlocked
* add, addurl, import, importfeed: When in a v6 repository on a crippled filesystem, add files unlocked. * annex.addunlocked: New configuration setting, makes files always be added unlocked. (v6 only)
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-add.mdwn3
-rw-r--r--doc/git-annex.mdwn9
-rw-r--r--doc/tips/unlocked_files.mdwn7
3 files changed, 18 insertions, 1 deletions
diff --git a/doc/git-annex-add.mdwn b/doc/git-annex-add.mdwn
index 5f1ab33b0..b65ed5132 100644
--- a/doc/git-annex-add.mdwn
+++ b/doc/git-annex-add.mdwn
@@ -21,7 +21,8 @@ to the git repository, instead of to the annex.
Large files are added to the annex in locked form, which prevents further
modification of their content unless unlocked by [[git-annex-unlock]](1).
-(This is not the case however when a repository is in direct mode.)
+(This is not the case however when a repository is in a filesystem not
+supporting symlinks, or is in direct mode.)
To add a file to the annex in unlocked form, `git add` can be used instead
(that only works when the repository has annex.version 6 or higher).
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index cb27ec11a..6830f741f 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -823,6 +823,15 @@ Here are all the supported configuration settings.
should be checked into git by `git annex add`. Defaults to true;
set to false to instead make small files be skipped.
+* `annex.addunlocked`
+
+ Set to true to make commands like `git-annex add` that add files to the
+ repository add them in unlocked form. The default is to add files in
+ locked form. This only has effect in version 6 repositories.
+
+ When a repository has core.symlinks set to false, it implicitly
+ sets annex.addunlocked to true.
+
* `annex.numcopies`
This is a deprecated setting. You should instead use the
diff --git a/doc/tips/unlocked_files.mdwn b/doc/tips/unlocked_files.mdwn
index 31f9e9756..fd103940e 100644
--- a/doc/tips/unlocked_files.mdwn
+++ b/doc/tips/unlocked_files.mdwn
@@ -88,6 +88,13 @@ git-annex converts between the content of the big file and a pointer file,
which is what gets committed to git. All the regular git-annex commands
(get, drop, etc) can be used on unlocked files too.
+[[!template id=note text="""
+By default, git-annex commands will add files in locked mode,
+unless used on a filesystem that does not support symlinks, when unlocked
+mode is used. To make them always use unlocked mode, run:
+`git config annex.addunlocked true`
+"""]]
+
A v6 repository can contain both locked and unlocked files. You can switch
a file back and forth using the `git annex lock` and `git annex unlock`
commands. This changes what's stored in git between a git-annex symlink