From 12e751bbb606867337aa82da982eebf8de57f6da Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 23 Oct 2023 13:55:53 -0400 Subject: [PATCH] improve docs --- ...__96___adds_files_unlocked_instead_of_locked.mdwn | 2 ++ ...mment_1_58abf8693ed90fc8c6e3f750310c17e4._comment | 12 ++++++++++++ doc/tips/unlocked_files.mdwn | 5 +++-- 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked/comment_1_58abf8693ed90fc8c6e3f750310c17e4._comment diff --git a/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked.mdwn b/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked.mdwn index 8d71015bf4..f4b5d71f8d 100644 --- a/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked.mdwn +++ b/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked.mdwn @@ -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 index 0000000000..6877505071 --- /dev/null +++ b/doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked/comment_1_58abf8693ed90fc8c6e3f750310c17e4._comment @@ -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. +"""]] diff --git a/doc/tips/unlocked_files.mdwn b/doc/tips/unlocked_files.mdwn index e530f4edf3..4f6d5901c6 100644 --- a/doc/tips/unlocked_files.mdwn +++ b/doc/tips/unlocked_files.mdwn @@ -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