diff options
Diffstat (limited to 'doc/chunking.mdwn')
| -rw-r--r-- | doc/chunking.mdwn | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/chunking.mdwn b/doc/chunking.mdwn new file mode 100644 index 000000000..1be1fbef6 --- /dev/null +++ b/doc/chunking.mdwn @@ -0,0 +1,22 @@ +Some [[special_remotes]] have support for breaking large files up into +chunks that are stored on the remote. + +This can be useful to work around limitations on the size of files +on the remote. + +Note that git-annex has to buffer chunks in memory before they are sent to +a remote. So, using a large chunk size will make it use more memory. + +To enable chunking, pass a `chunk=XXmb` parameter to `git annex +initremote`. + +To disable chunking of a remote that was using chunking, +pass `chunk=0` to `git annex enableremote`. Any content already stored on +the remote using chunks will continue to be accessed via chunks, this +just prevents using chunks when storing new content. + +To change the chunk size, pass a `chunk=XXmb` parameter to +`git annex enableremote`. This only affects the chunk sized used when +storing new content. + +See also: [[design document|design/assistant/chunks]] |