improve annex.largefiles documentation
authorJoey Hess <joeyh@joeyh.name>
Wed, 2 Dec 2015 18:26:49 +0000 (14:26 -0400)
committerJoey Hess <joeyh@joeyh.name>
Wed, 2 Dec 2015 18:26:49 +0000 (14:26 -0400)
doc/git-annex.mdwn

index fca499a7eb1db849c3b4baf34118e05cf2f2d005..8a624b507de01a89cb88401268d860dc35df136c 100644 (file)
@@ -789,16 +789,23 @@ Here are all the supported configuration settings.
 
 * `annex.largefiles`
 
-  Allows configuring which files `git annex add` and the assistant consider
-  to be large enough to need to be added to the annex. By default,
-  all files are added to the annex.
+  Allows configuring which files are considered to be large enough to
+  need to be added to the annex. By default, all specified files are added
+  to the annex, but configuring this can cause the small files to be
+  checked into git, without using the annex.
 
   The value is a preferred content expression. See [[git-annex-preferred-content]](1)
   for details.
 
   Example:
 
-               annex.largefiles = largerthan=100kb and not (include=*.c or include=*.h)
+       annex.largefiles = largerthan=100kb and not (include=*.c or include=*.h)
+
+  This setting is used by `git annex add` and the assistant.
+  It can be useful to temporarily override it via -c at the command line.
+  For example:
+
+       git annex add -c annex.largefiles='include=*' 99kbfile
 
 * `annex.numcopies`