1git-annex-smudge(1)         General Commands Manual        git-annex-smudge(1)
2
3
4

NAME

6       git-annex-smudge - git filter driver for git-annex
7

SYNOPSIS

9       git annex smudge [--clean] file
10
11       git annex smudge --update
12

DESCRIPTION

14       This  command  lets git-annex be used as a git filter driver which lets
15       annexed files in the git repository to be unlocked,  instead  of  being
16       symlinks, and lets git add store files in the annex.
17
18       When  adding  a  file with git add, the annex.largefiles config is con‐
19       sulted to decide if a given file should be added to git  as-is,  or  if
20       its content are large enough to need to use git-annex.
21
22       The git configuration to use this command as a filter driver is as fol‐
23       lows.  This is normally set up for you by git-annex init, so you should
24       not need to configure it manually.
25
26        [filter "annex"]
27                smudge = git-annex smudge %f
28                clean = git-annex smudge --clean %f
29
30       To  make  git  use that filter driver, it needs to be configured in the
31       .gitattributes file or in .git/info/attributes. The latter is  normally
32       configured  when  a  repository is initialized, with the following con‐
33       tents:
34
35        * filter=annex
36        .* !filter
37
38       The smudge filter does not provide git  with  the  content  of  annexed
39       files,  because  that  would  be slow and triggers memory leaks in git.
40       Instead, it records which worktree files need to be  updated,  and  git
41       annex  smudge  --update later updates the work tree to contain the con‐
42       tent. That is run by several git  hooks,  including  post-checkout  and
43       post-merge.  However,  a  few  git  commands, notably git stash and git
44       cherry-pick, do not run any hooks, so after using  those  commands  you
45       can manually run git annex smudge --update to update the working tree.
46

SEE ALSO

48       git-annex(1)
49

AUTHOR

51       Joey Hess <id@joeyh.name>
52
53                                                           git-annex-smudge(1)