git-annex/doc/git-annex-numcopies.mdwn

# NAME

git-annex numcopies - configure desired number of copies

# SYNOPSIS

git annex numcopies `N`

# DESCRIPTION

Tells git-annex how many copies it should preserve of files, over all
repositories. The default is 1. 

Run without a number to get the current value.

This configuration is stored in the git-annex branch, so it will be seen
by all clones of the repository. It can be overridden on a per-file basis
by the annex.numcopies setting in .gitattributes files, or can be
overridden temporarily with the --numcopies option.

When git-annex is asked to drop a file, it first verifies that the
number of copies can be satisfied among all the other
repositories that have a copy of the file.

In unusual situations, involving special remotes that do not support
locking, and concurrent drops of the same content from multiple
repositories, git-annex may violate the numcopies setting. It still
guarantees at least 1 copy is preserved. This can be configured by
using [[git-annex-mincopies]](1)

# OPTIONS

* The [[git-annex-common-options]](1) can be used.

# SEE ALSO

[[git-annex]](1)
[[git-annex-mincopies]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00			`# NAME`

			`git-annex numcopies - configure desired number of copies`

			`# SYNOPSIS`

			git annex numcopies `N`

			`# DESCRIPTION`

			`Tells git-annex how many copies it should preserve of files, over all`
vicfg: Include the numcopies configuation. Docs say vicfg can configure everything from git-annex branch, so it ought to configure numcopies. Note that commenting out existing numcopies does not unset it. This commit was sponsored by Thom May on Patreon. 2017-01-30 19:11:26 +00:00			`repositories. The default is 1.`
separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00
			`Run without a number to get the current value.`

vicfg: Include the numcopies configuation. Docs say vicfg can configure everything from git-annex branch, so it ought to configure numcopies. Note that commenting out existing numcopies does not unset it. This commit was sponsored by Thom May on Patreon. 2017-01-30 19:11:26 +00:00			`This configuration is stored in the git-annex branch, so it will be seen`
docs for requirednumcopies Not implemented yet. 2021-01-05 18:22:27 +00:00			`by all clones of the repository. It can be overridden on a per-file basis`
			`by the annex.numcopies setting in .gitattributes files, or can be`
			`overridden temporarily with the --numcopies option.`
vicfg: Include the numcopies configuation. Docs say vicfg can configure everything from git-annex branch, so it ought to configure numcopies. Note that commenting out existing numcopies does not unset it. This commit was sponsored by Thom May on Patreon. 2017-01-30 19:11:26 +00:00
separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00			`When git-annex is asked to drop a file, it first verifies that the`
docs for requirednumcopies Not implemented yet. 2021-01-05 18:22:27 +00:00			`number of copies can be satisfied among all the other`
separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00			`repositories that have a copy of the file.`
docs for requirednumcopies Not implemented yet. 2021-01-05 18:22:27 +00:00
mincopies This is conceptually very simple, just making a 1 that was hard coded be exposed as a config option. The hard part was plumbing all that, and dealing with complexities like reading it from git attributes at the same time that numcopies is read. Behavior change: When numcopies is set to 0, git-annex used to drop content without requiring any copies. Now to get that (highly unsafe) behavior, mincopies also needs to be set to 0. It seemed better to remove that edge case, than complicate mincopies by ignoring it when numcopies is 0. This commit was sponsored by Denis Dzyubenko on Patreon. 2021-01-06 18:11:08 +00:00			`In unusual situations, involving special remotes that do not support`
			`locking, and concurrent drops of the same content from multiple`
			`repositories, git-annex may violate the numcopies setting. It still`
			`guarantees at least 1 copy is preserved. This can be configured by`
			`using [[git-annex-mincopies]](1)`
separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00
split out common options to its own page and mention it on each subcommand page Sometimes users would get confused because an option they were looking for was not mentioned on a subcommand's man page, and they had not noticed that the main git-annex man page had a list of common options. This change lets each subcommand mention the common options, similarly to how the matching options are handled. This commit was sponsored by Svenne Krap on Patreon. 2021-05-10 19:00:13 +00:00			`# OPTIONS`

			`* The [[git-annex-common-options]](1) can be used.`

separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00			`# SEE ALSO`

			`[[git-annex]](1)`
mincopies This is conceptually very simple, just making a 1 that was hard coded be exposed as a config option. The hard part was plumbing all that, and dealing with complexities like reading it from git attributes at the same time that numcopies is read. Behavior change: When numcopies is set to 0, git-annex used to drop content without requiring any copies. Now to get that (highly unsafe) behavior, mincopies also needs to be set to 0. It seemed better to remove that edge case, than complicate mincopies by ignoring it when numcopies is 0. This commit was sponsored by Denis Dzyubenko on Patreon. 2021-01-06 18:11:08 +00:00			`[[git-annex-mincopies]](1)`
separated man pages for all the setup commands while at the gate in ATL 2015-03-23 22:20:42 +00:00
			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

			`Warning: Automatically converted into a man page by mdwn2man. Edit with care.`