git-annex/doc/git-annex-smudge.mdwn

# NAME

git-annex smudge - git filter driver for git-annex

# SYNOPSIS

git annex smudge [--clean] file

# DESCRIPTION

This command lets git-annex be used as a git filter driver which lets
annexed files in the git repository to be unlocked at all times, instead
of being symlinks.

When adding a file with `git add`, 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.

The git configuration to use this command as a filter driver is as follows.
This is normally set up for you by git-annex init, so you should
not need to configure it manually.

	[filter "annex"]
	        smudge = git-annex smudge %f
	        clean = git-annex smudge --clean %f

To make git use that filter driver, it needs to be configured in
the `.gitattributes` file or in `.git/info/attributes`. The latter
is normally configured when a repository is initialized, with the following
contents:

	* filter=annex
	.* !filter

# SEE ALSO

[[git-annex]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
skeleton smudge/clean filters 2015-12-04 17:02:56 +00:00			`# NAME`

			`git-annex smudge - git filter driver for git-annex`

			`# SYNOPSIS`

merge clean into smudge command The git filter config can be used to map the single git-annex command to the 2 actions, and this avoids "git annex clean" being used for this thing, it might have a better use for that name later. 2015-12-04 19:30:06 +00:00			`git annex smudge [--clean] file`
skeleton smudge/clean filters 2015-12-04 17:02:56 +00:00
			`# DESCRIPTION`

merge clean into smudge command The git filter config can be used to map the single git-annex command to the 2 actions, and this avoids "git annex clean" being used for this thing, it might have a better use for that name later. 2015-12-04 19:30:06 +00:00			`This command lets git-annex be used as a git filter driver which lets`
			`annexed files in the git repository to be unlocked at all times, instead`
			`of being symlinks.`
skeleton smudge/clean filters 2015-12-04 17:02:56 +00:00
init: Configure .git/info/attributes to use git-annex as a smudge filter. Note that this changes the default behavior of git add in a newly initialized repository; it will add files to the annex. Don't like that this could break workflows, but it's necessary in order for any pointer files in the repo to be handled by git-annex. 2015-12-04 21:57:15 +00:00			When adding a file with `git add`, the annex.largefiles config is
			`consulted to decide if a given file should be added to git as-is,`
fix docs "git -a annex.largefiles=* add" cannot be used.. git does not pass the config along to the smudge filter, sadly. 2015-12-16 20:00:41 +00:00			`or if its content are large enough to need to use git-annex.`
init: Configure .git/info/attributes to use git-annex as a smudge filter. Note that this changes the default behavior of git add in a newly initialized repository; it will add files to the annex. Don't like that this could break workflows, but it's necessary in order for any pointer files in the repo to be handled by git-annex. 2015-12-04 21:57:15 +00:00
			`The git configuration to use this command as a filter driver is as follows.`
			`This is normally set up for you by git-annex init, so you should`
			`not need to configure it manually.`
merge clean into smudge command The git filter config can be used to map the single git-annex command to the 2 actions, and this avoids "git annex clean" being used for this thing, it might have a better use for that name later. 2015-12-04 19:30:06 +00:00
			`[filter "annex"]`
			`smudge = git-annex smudge %f`
add v6; keep v5 working for now and manual upgrade Since all places where a repo is used in direct mode need to have git-annex upgraded before the repo can safely be converted to v6, the upgrade needs to be manual for now. I suppose that at some point I'll want to drop all the direct mode support code. At that point, will stop supporting v5, and will need to auto-upgrade any remaining v5 repos. If possible, I'd like to carry the direct mode support for say, a year or so, to give people plenty of time to upgrade and avoid disruption. 2015-12-04 20:14:48 +00:00			`clean = git-annex smudge --clean %f`
merge clean into smudge command The git filter config can be used to map the single git-annex command to the 2 actions, and this avoids "git annex clean" being used for this thing, it might have a better use for that name later. 2015-12-04 19:30:06 +00:00
init: Configure .git/info/attributes to use git-annex as a smudge filter. Note that this changes the default behavior of git add in a newly initialized repository; it will add files to the annex. Don't like that this could break workflows, but it's necessary in order for any pointer files in the repo to be handled by git-annex. 2015-12-04 21:57:15 +00:00			`To make git use that filter driver, it needs to be configured in`
Fix path in git-annex-smudge(1) 2016-08-16 15:50:19 +00:00			the `.gitattributes` file or in `.git/info/attributes`. The latter
init: Configure .git/info/attributes to use git-annex as a smudge filter. Note that this changes the default behavior of git add in a newly initialized repository; it will add files to the annex. Don't like that this could break workflows, but it's necessary in order for any pointer files in the repo to be handled by git-annex. 2015-12-04 21:57:15 +00:00			`is normally configured when a repository is initialized, with the following`
			`contents:`
skeleton smudge/clean filters 2015-12-04 17:02:56 +00:00
			`* filter=annex`
			`.* !filter`

			`# SEE ALSO`

			`[[git-annex]](1)`

			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

			`Warning: Automatically converted into a man page by mdwn2man. Edit with care.`