diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/git-annex-clean.mdwn | 36 | ||||
-rw-r--r-- | doc/git-annex-smudge.mdwn | 31 | ||||
-rw-r--r-- | doc/git-annex.mdwn | 6 | ||||
-rw-r--r-- | doc/todo/smudge.mdwn | 4 |
4 files changed, 75 insertions, 2 deletions
diff --git a/doc/git-annex-clean.mdwn b/doc/git-annex-clean.mdwn new file mode 100644 index 000000000..13099a544 --- /dev/null +++ b/doc/git-annex-clean.mdwn @@ -0,0 +1,36 @@ +# NAME + +git-annex clean - git filter driver for git-annex + +# SYNOPSIS + +git annex clean + +# DESCRIPTION + +When git-annex is used as a git filter driver, this command is run +by git commands such as `git add`. It generates a file that +is added to the git repository and points to the git-annex object +containing the content of a large file. + +To configure git to use git-annex as a git filter driver, place the +following in the .gitattributes file: + + * filter=annex + .* !filter + +The annex.largefiles config is consulted to decide if a given file should +be added to git as-is, or if its content are large enough to need to use +git-annex. + +# SEE ALSO + +[[git-annex]](1) + +[[git-annex-smudge]](1) + +# AUTHOR + +Joey Hess <id@joeyh.name> + +Warning: Automatically converted into a man page by mdwn2man. Edit with care. diff --git a/doc/git-annex-smudge.mdwn b/doc/git-annex-smudge.mdwn new file mode 100644 index 000000000..ae28be2c7 --- /dev/null +++ b/doc/git-annex-smudge.mdwn @@ -0,0 +1,31 @@ +# NAME + +git-annex smudge - git filter driver for git-annex + +# SYNOPSIS + +git annex smudge + +# DESCRIPTION + +When git-annex is used as a git filter driver, this command is run +by git commands such as `git checkout` and outputs the content of annexed +objects that pointer files point to. + +To configure git to use git-annex as a git filter driver, place the +following in the .gitattributes file: + + * filter=annex + .* !filter + +# SEE ALSO + +[[git-annex]](1) + +[[git-annex-clean]](1) + +# AUTHOR + +Joey Hess <id@joeyh.name> + +Warning: Automatically converted into a man page by mdwn2man. Edit with care. diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 2020ccf3f..a8cb73b1b 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -626,6 +626,12 @@ subdirectories). See [[git-annex-diffdriver]](1) for details. +* `smudge`, `clean` + + These let git-annex be used as a git filter driver. + + See [[git-annex-smudge]](1) and [[git-annex-clean]](1) for details. + * `remotedaemon` Detects when network remotes have received git pushes and fetches from them. diff --git a/doc/todo/smudge.mdwn b/doc/todo/smudge.mdwn index aea0c9b98..094b5f880 100644 --- a/doc/todo/smudge.mdwn +++ b/doc/todo/smudge.mdwn @@ -177,8 +177,8 @@ Configuration: the annex. Other files are passed through the smudge/clean as-is and have their contents stored in git. -* annex.direct is repurposed to configure how the assistant adds files. - When set to true, they're added unlocked. +* annex.direct is repurposed to configure how git-annex adds files. + When set to false, it adds symlinks and when true it adds pointer files. git-annex clean: |