mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
Joey Hess 2023-10-23 13:55:53 -04:00
parent 70d11a209d
commit 12e751bbb6
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked.mdwn
View file

@ -51,3 +51,5 @@ annexed.txt
# End of transcript or log. # End of transcript or log.
"""]] """]]
> [[done]] --[[Joey]]

12
doc/bugs/__96__git_add__96___adds_files_unlocked_instead_of_locked/comment_1_58abf8693ed90fc8c6e3f750310c17e4._comment Normal file
View file

@ -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.
"""]]

5
doc/tips/unlocked_files.mdwn
View 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 looks like "/annex/objects/...". So if you open a file and see
that, you'll need to use `git annex get`. 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 and git-annex converts between the content of the big file and a pointer
file, which is what gets committed to git. 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, By default, git-annex commands will add files in locked mode,
unless used on a filesystem that does not support symlinks, when unlocked unless used on a filesystem that does not support symlinks, when unlocked
mode is used. To make them always use unlocked mode, run: 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 ## adjusted branches