From: Joey Hess <joeyh@joeyh.name>
Date: Wed, 2 Dec 2015 18:26:49 +0000 (-0400)
Subject: improve annex.largefiles documentation
X-Git-Tag: archive/raspbian/10.20250416-2+rpi1~1^2~322^2~28
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=5ec67335f459fcb38e0747ed3365ddba83ade157;p=git-annex.git

improve annex.largefiles documentation
---

diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index fca499a7eb..8a624b507d 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -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`