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

wrote git-annex maxsize man page

Browse source
This commit is contained in:
Joey Hess 2024-08-09 14:46:08 -04:00
parent 5a6afff3d6
commit f1cb5cb908
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 49 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

46
doc/git-annex-maxsize.mdwn Normal file
View file

@ -0,0 +1,46 @@
# NAME
git-annex maxsize - configure maximum size of a repository
# SYNOPSIS
git annex maxsize repository size
git annex maxsize here --auto
git annex maxsize repository
# DESCRIPTION
This configures the maximum combined size of annexed files that can be
stored in a repository. When run without a size or the --auto option,
it displays the currently configured maxsize.
The repository can be specified by git remote name or
by uuid. For the current repository, use "here".
The size can be specified using any units. For example "100 gigabytes" or
"0.8 TB"
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.
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"`.
# OPTIONS
* The [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.

4
doc/git-annex-preferred-content.mdwn
View file

@ -282,7 +282,7 @@ elsewhere to allow removing it).
have enough free space to hold them. So once a repository is full,
the remaining repositories will have any additional files balanced
amoung them. In order for this to work, you must use
[[git-annex-size]](1) to specify the size of each repository in the
[[git-annex-maxsize]](1) to specify the size of each repository in the
group.
This usually avoids moving files between repositories of the group, even
@ -350,7 +350,7 @@ for example `"exclude=* and copies=1"` will be displayed as
[[git-annex-wanted]](1)
[[git-annex-size]](1)
[[git-annex-maxsize]](1)
<https://git-annex.branchable.com/preferred_content/>

2
doc/todo/git-annex_proxies.mdwn
View file

@ -33,7 +33,7 @@ Planned schedule of work:
* balanced= and fullybalanced= need to limit the set of repositories to
ones with enough free space to contain a key.
* Add `git-annex size` command.
* Add `git-annex maxsize` command.
* Implement [[track_free_space_in_repos_via_git-annex_branch]]