summaryrefslogtreecommitdiff
path: root/doc/special_remotes
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-07-26 20:21:49 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-07-26 20:21:49 -0400
commite16b1702f9de3fa2e7b4ba160fc8c9b6c318d035 (patch)
tree720cd1d1980afe74b679725dba587cbddf954cf4 /doc/special_remotes
parent246cf74542a6539abc2f0e32fab4a29b1b44625b (diff)
doc update for new chunking
Diffstat (limited to 'doc/special_remotes')
-rw-r--r--doc/special_remotes/directory.mdwn12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/special_remotes/directory.mdwn b/doc/special_remotes/directory.mdwn
index 96d593821..de7ab904e 100644
--- a/doc/special_remotes/directory.mdwn
+++ b/doc/special_remotes/directory.mdwn
@@ -25,13 +25,17 @@ remote:
* `keyid` - Specifies the gpg key to use for [[encryption]].
-* `chunksize` - Avoid storing files larger than the specified size in the
+* `chunk` - Avoid storing files larger than the specified size in the
directory. For use on directories on mount points that have file size
limitations. The default is to never chunk files.
The value can use specified using any commonly used units.
- Example: `chunksize=100 megabytes`
- Note that enabling chunking on an existing remote with non-chunked
- files is not recommended; nor is changing the chunksize.
+ Example: `chunk=100 megabytes`
+ Note that chunking can be disabled later by setting chunk=0,
+ and can also safely be changed to a different size as needed.
+
+* `chunksize` - Deprecated version of chunk parameter above.
+ Do not use for new remotes. It is not safe to change the chunksize
+ setting of an existing remote.
Setup example: