summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-12-02 14:26:49 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-12-02 14:26:49 -0400
commit31d4313d575a566a695d93e3e7ee34bddd41d705 (patch)
treeda0b7e62f1196f56c6b3ee71236935c658b675b5
parente2b8d0757b1ce447ffd3fba5691326a3365f02f5 (diff)
improve annex.largefiles documentation
-rw-r--r--doc/git-annex.mdwn15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index fca499a7e..8a624b507 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`