From f1cb5cb908c35f53334b6e1bbf1340777302b550 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 9 Aug 2024 14:46:08 -0400 Subject: [PATCH] wrote git-annex maxsize man page --- doc/git-annex-maxsize.mdwn | 46 ++++++++++++++++++++++++++++ doc/git-annex-preferred-content.mdwn | 4 +-- doc/todo/git-annex_proxies.mdwn | 2 +- 3 files changed, 49 insertions(+), 3 deletions(-) create mode 100644 doc/git-annex-maxsize.mdwn diff --git a/doc/git-annex-maxsize.mdwn b/doc/git-annex-maxsize.mdwn new file mode 100644 index 0000000000..9c0909467c --- /dev/null +++ b/doc/git-annex-maxsize.mdwn @@ -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 + +Warning: Automatically converted into a man page by mdwn2man. Edit with care. diff --git a/doc/git-annex-preferred-content.mdwn b/doc/git-annex-preferred-content.mdwn index 70d2723524..8069cb201f 100644 --- a/doc/git-annex-preferred-content.mdwn +++ b/doc/git-annex-preferred-content.mdwn @@ -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) diff --git a/doc/todo/git-annex_proxies.mdwn b/doc/todo/git-annex_proxies.mdwn index c153ae585a..13a8f56c06 100644 --- a/doc/todo/git-annex_proxies.mdwn +++ b/doc/todo/git-annex_proxies.mdwn @@ -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]]