diff options
author | Joey Hess <joeyh@joeyh.name> | 2016-02-02 16:50:58 -0400 |
---|---|---|
committer | Joey Hess <joeyh@joeyh.name> | 2016-02-02 16:50:58 -0400 |
commit | 98475acf860d33e0482c37a68eca9e65aaadf986 (patch) | |
tree | c0e5c74ae8b331ca18c63c925b1d4b7b314b0f25 /doc/tips | |
parent | 7809358e05c702d1a790ed652c017a60a3897389 (diff) |
rework largefiles documentation
Diffstat (limited to 'doc/tips')
-rw-r--r-- | doc/tips/largefiles.mdwn | 67 | ||||
-rw-r--r-- | doc/tips/replacing_Sparkleshare_or_dvcs-autosync_with_the_assistant.mdwn | 20 | ||||
-rw-r--r-- | doc/tips/unlocked_files.mdwn | 4 |
3 files changed, 73 insertions, 18 deletions
diff --git a/doc/tips/largefiles.mdwn b/doc/tips/largefiles.mdwn new file mode 100644 index 000000000..46e153399 --- /dev/null +++ b/doc/tips/largefiles.mdwn @@ -0,0 +1,67 @@ +[[!meta title="annex.largefiles: configuring mixed content repositories"]] + +Normally commands like `git annex add` always add files to the annex. +And when using the v6 repository mode, even `git add` and `git commit -a` +will add files to the annex. + +Let's suppose you're developing a video game, written in C. You have +source code, and some large game assets. You want to ensure the source +code is stored in git -- that's what git's for! And you want to store +the game assets in the git annex -- to avod bloating your git repos with +possibly enormous files, but still version control them. + +The annex.largefiles configuration is useful for such mixed content +repositories. It's checked by `git annex add`, by `git add` and `git commit -a` +(in v6 repositories), by `git annex import` and the assistant. It's +also used by `git annex addurl` and `git annex importfeed` when downloading +files. When a file does not match annex.largefiles, these commands will +add its content to git instead of to the annex. + +## examples + +For example, let's make only files larger than 100 kb be added to the annex, +and never *.c and *.h source files. + +Write this to the `.gitattributes` file: + + * annex.largefiles=(largerthan=100kb) + *.c annex.largefiles=nothing + *.h annex.largefiles=nothing + +Or, set the git configuration instead: + + git config annex.largefiles 'largerthan=100kb and not (include=*.c or include=*.h)' + +Both of these settings do the same thing. Setting it in the `.gitattributes` +file makes any checkout of the repository share that configuration, so is often +a good choice. Setting the annex.largefiles git configuration lets different +checkouts behave differently. The git configuration overrides the +`.gitattributes` configuration. + +## syntax + +The way the `.gitattributes` example above works is, *.c and *.h files +have the annex.largefiles attribute set to "nothing", which matches nothing, +and so those files are never treated as large files. All other files use +the other value, which checks the file size. + +The value of annex.largefiles is a +[[preferred content expression|git-annex-preferred-content]] that is +used to match the large files. + +Note that, since git attribute values cannot contain whitespace, +it's useful to instead parenthesize the terms of the +[[preferred content expression|git-annex-preferred-content]]. This trick +allows setting the annex.largefiles attribute to more complicated expressions. +For example, this is the same as the git config shown earlier, shoehorned +into a git attribute: + + * annex.largefiles=(largerthan=100kb)and(not((include=*.c)or(include=*.h))) + +## temporarily override + +If you've set up an annex.largefiles configuration but want to force a file to +be stored in the annex, you can temporarily override the configuration like +this: + + git annex add -c annex.largefiles=anything smallfile diff --git a/doc/tips/replacing_Sparkleshare_or_dvcs-autosync_with_the_assistant.mdwn b/doc/tips/replacing_Sparkleshare_or_dvcs-autosync_with_the_assistant.mdwn index 893408c2f..cfe422edb 100644 --- a/doc/tips/replacing_Sparkleshare_or_dvcs-autosync_with_the_assistant.mdwn +++ b/doc/tips/replacing_Sparkleshare_or_dvcs-autosync_with_the_assistant.mdwn @@ -8,11 +8,7 @@ thing, but even better! ---- -First, get git-annex version 4.20130329 or newer. - ----- - -Let's suppose you're delveloping a video game, written in C. You have +Let's suppose you're developing a video game, written in C. You have source code, and some large game assets. You want to ensure the source code is stored in git -- that's what git's for! And you want to store the game assets in the git annex -- to avod bloating your git repos with @@ -24,20 +20,14 @@ file that is stored in the annex. git config annex.largefiles "largerthan=100kb and not (include=*.c or include=*.h)" +For more details about this configuration, see [[largefiles]]. + ---- Now if you run `git annex add`, it will only add the large files to the -annex. You can `git add` the small files directly to git. - -Note that in order to use `git add` on the small files, your repository -needs to be in indirect mode, rather than [[direct mode]]. If it's in -direct mode, `git add` will fail. You can fix that: - - git annex indirect - ----- +annex; small files will be stored in git. -A less manual option is to run `git annex assistant`. It will *automatically* +Or, run `git annex assistant`. It will *automatically* add the large files to the annex, and store the small files in git. It'll notice every time you modify a file, and immediately commit it, too. And sync it out to other repositories you configure using `git annex diff --git a/doc/tips/unlocked_files.mdwn b/doc/tips/unlocked_files.mdwn index 038294c69..31f9e9756 100644 --- a/doc/tips/unlocked_files.mdwn +++ b/doc/tips/unlocked_files.mdwn @@ -60,9 +60,7 @@ to store the file contents, and the files will be left unlocked. [[!template id=note text=""" Want `git add` to add some file contents to the annex, but store the contents of smaller files in git itself? Configure annex.largefiles to match the former. - - git config annex.largefiles \ - "largerthan=100kb and not include=*.c" +See [[largefiles]]. """]] # cp ~/my_cool_big_file . |