mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve docs

Browse source
This commit is contained in:
Joey Hess 2024-08-22 08:09:10 -04:00
parent abdd49d8c1
commit 8ade3fc5d6
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/git-annex-maxsize.mdwn
View file

@ -14,8 +14,8 @@ git annex maxsize
This configures the maximum combined size of annexed files that can be
stored in a repository. When run with a repository but without a size,
it displays the currently configured maxsize. When run without a
repository, it displays an overview of the size and maxsize of all
it displays the currently configured maxsize. When run without any
parameters, it displays an overview of the size and maxsize of all
repositories.
The repository can be specified by git remote name or
@ -25,13 +25,20 @@ The size can be specified using any units. For example "100 gigabytes" or
"0.8TB"
This is advisory only, it does not prevent git-annex from trying to store
more data than that in a repository. So use this to tell git-annex about
hard repository size limits that are enforced in some other way.
more data in a repository. When a repository has a preferred content
expression configured using "balanced" or "sizebalanced", it will take the
maxsize into account when checking preferred content. It is still possible
for the maxsize to be exceeded, eg when there are multiple writers to the
same repository.
A hard repository size limit has to be enforced in some other way,
eg by putting the repository on a partition of the desired size.
This command can then be used to tell git-annex about that size limit.
For example, if a git repository is on a 1 terabyte drive, and is the only
thing stored on that drive, and `annex.diskreserve` is configured to 1
gigabyte, then it would make sense to run
`git-annex maxsize here "999 gigabytes"`.
`git-annex maxsize here "999 gigabytes"`
# OPTIONS
@ -49,6 +56,8 @@ gigabyte, then it would make sense to run
[[git-annex]](1)
[[git-annex-preferred-content]](1)
# AUTHOR
Joey Hess <id@joeyh.name>