improve docs
authorJoey Hess <joeyh@joeyh.name>
Mon, 23 Oct 2023 17:55:53 +0000 (13:55 -0400)
committerJoey Hess <joeyh@joeyh.name>
Mon, 23 Oct 2023 17:55:53 +0000 (13:55 -0400)
doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked.mdwn
doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked/comment_1_58abf8693ed90fc8c6e3f750310c17e4._comment [new file with mode: 0644]
doc/tips/unlocked_files.mdwn

index 8d71015bf422002ab811635d10e95c8b9b3cc14b..f4b5d71f8de3607e2011fff729c36cba2ca166a8 100644 (file)
@@ -51,3 +51,5 @@ annexed.txt
 
 # End of transcript or log.
 """]]
+
+> [[done]] --[[Joey]]
diff --git a/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked/comment_1_58abf8693ed90fc8c6e3f750310c17e4._comment b/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked/comment_1_58abf8693ed90fc8c6e3f750310c17e4._comment
new file mode 100644 (file)
index 0000000..6877505
--- /dev/null
@@ -0,0 +1,12 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 1"""
+ date="2023-10-23T17:48:54Z"
+ content="""
+I wish it were possible to make `git add` add files in a locked state.
+However, the smudge/clean interface git-annex uses to hook into `git add`
+makes it impossible to do that.
+
+This is why the documentation refers to "git-annex commands", which does
+exclude `git add`. I've made that a little bit more explicit.
+"""]]
index e530f4edf3943f3d4a8f0a0513eb5041a173dbed..4f6d5901c6fc319d3642c82576eea1f0e2a0351e 100644 (file)
@@ -50,7 +50,7 @@ an unlocked file, it will be replaced by a pointer file, which
 looks like "/annex/objects/...". So if you open a file and see
 that, you'll need to use `git annex get`.
 
-Under the hood, unlocked files use git's [[todo/smudge]] filter interface,
+Under the hood, unlocked files use git's smudge/clean filter interface,
 and git-annex converts between the content of the big file and a pointer
 file, which is what gets committed to git.
 
@@ -58,7 +58,8 @@ file, which is what gets committed to git.
 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`
+`git config annex.addunlocked true`  
+`git add` always adds files in unlocked mode.
 """]]
 
 ## adjusted branches