5df89d58c7
Split out two new commands, git-annex pull and git-annex push. Those plus a git commit are equivilant to git-annex sync. In a sense, git-annex sync conflates 3 things, and it would have been better to have push and pull from the beginning and not sync. Although note that git-annex sync --content is faster than a pull followed by a push, because it only has to walk the tree once, look at preferred content once, etc. So there is some value in git-annex sync in speed, as well as user convenience. And it would be hard to split out pull and push from sync, as far as the implementaton goes. The implementation inside sync was easy, just adjust SyncOptions so it does the right thing. Note that the new commands default to syncing content, unless annex.synccontent is explicitly set to false. I'd like sync to also do that, but that's a hard transition to make. As a start to that transition, I added a note to git-annex-sync.mdwn that it may start to do so in a future version of git-annex. But a real transition would necessarily involve displaying warnings when sync is used without --content, and time. Sponsored-by: Kevin Mueller on Patreon
164 lines
4.6 KiB
Markdown
164 lines
4.6 KiB
Markdown
# NAME
|
|
|
|
git-annex config - configuration stored in git-annex branch
|
|
|
|
# SYNOPSIS
|
|
|
|
git annex config --set name value
|
|
|
|
git annex config --get name
|
|
|
|
git annex config --unset name
|
|
|
|
# DESCRIPTION
|
|
|
|
Set or get configuration settings stored in the git-annex branch.
|
|
|
|
Unlike `git config` settings, these settings can be seen
|
|
in all clones of the repository, once they have gotten their
|
|
git-annex branches in sync.
|
|
|
|
These settings can be overridden on a per-repository basis using
|
|
`git config`.
|
|
|
|
git-annex does not check the git-annex branch for all the `git config`
|
|
settings that affect it (which are listed on the git-annex man page
|
|
CONFIGURATION section). Only a few make sense to be able to set such
|
|
that all clones of a repository see the setting, and so git-annex only
|
|
looks for these.
|
|
|
|
# SUPPORTED SETTINGS
|
|
|
|
* `annex.largefiles`
|
|
|
|
Used to configure which files are large enough to be added to the annex.
|
|
It is an expression that matches the large files, eg
|
|
"`include=*.mp3 or largerthan(500kb)`".
|
|
See [[git-annex-matching-expression]](1) for details on the syntax.
|
|
|
|
This sets a default, which can be overridden by annex.largefiles
|
|
attributes in `.gitattributes` files, or by `git config`.
|
|
|
|
* `annex.dotfiles`
|
|
|
|
Normally, dotfiles are assumed to be files like .gitignore,
|
|
whose content should always be part of the git repository, so
|
|
they will not be added to the annex. Setting annex.dotfiles to true
|
|
makes dotfiles be added to the annex the same as any other file.
|
|
|
|
This sets a default, which can be overridden by annex.dotfiles
|
|
in `git config`.
|
|
|
|
* `annex.addunlocked`
|
|
|
|
Commands like `git-annex add` default to adding files to the repository
|
|
in locked form. This can make them add the files in unlocked form,
|
|
the same as if [[git-annex-unlock]](1) were run on the files.
|
|
|
|
This can be set to "true" to add everything unlocked, or it can be a more
|
|
complicated expression that matches files by name, size, or content. See
|
|
[[git-annex-matching-expression]](1) for details.
|
|
|
|
This sets a default, which can be overridden by annex.addunlocked
|
|
in `git config`.
|
|
|
|
* `annex.autocommit`
|
|
|
|
Set to false to prevent the `git-annex assistant` and `git-annex sync`
|
|
from automatically committing changes to files in the repository.
|
|
|
|
This sets a default, which can be overridden by annex.autocommit
|
|
in `git config`.
|
|
|
|
* `annex.resolvemerge`
|
|
|
|
Set to false to prevent merge conflicts in the checked out branch
|
|
being automatically resolved by the `git-annex assitant`,
|
|
`git-annex sync`, `git-annex pull`, ``git-annex merge`,
|
|
and the `git-annex post-receive` hook.
|
|
|
|
This sets a default, which can be overridden by annex.resolvemerge
|
|
in `git config`.
|
|
|
|
* `annex.synccontent`
|
|
|
|
Set to true to make `git-annex sync` default to transferring
|
|
annexed content.
|
|
|
|
Set to false to prevent `git-annex pull` and `git-annex` push from
|
|
transferring annexed content.
|
|
|
|
This sets a default, which can be overridden by annex.synccontent
|
|
in `git config`.
|
|
|
|
* `annex.synconlyannex`
|
|
|
|
Set to true to make `git-annex sync`, `git-annex pull` and `git-annex
|
|
push` default to only operate on the git-annex branch and annexed content.
|
|
|
|
This sets a default, which can be overridden by annex.synconlyannex
|
|
in `git config`.
|
|
|
|
* `annex.securehashesonly`
|
|
|
|
Set to true to indicate that the repository should only use
|
|
cryptographically secure hashes (SHA2, SHA3) and not insecure
|
|
hashes (MD5, SHA1) for content.
|
|
|
|
When this is set, the contents of files using cryptographically
|
|
insecure hashes will not be allowed to be added to the repository.
|
|
|
|
Also, `git-annex fsck` will complain about any files present in
|
|
the repository that use insecure hashes.
|
|
|
|
Note that this is only read from the git-annex branch by
|
|
`git annex init`, and is copied to the corresponding git config setting.
|
|
So, changes to the value in the git-annex branch won't affect a
|
|
repository once it has been initialized.
|
|
|
|
# OPTIONS
|
|
|
|
* `--set name value`
|
|
|
|
Set a value.
|
|
|
|
* `--get name`
|
|
|
|
Get a value.
|
|
|
|
* `--unset`
|
|
|
|
Unset a value.
|
|
|
|
* Also the [[git-annex-common-options]](1) can be used.
|
|
|
|
# EXAMPLE
|
|
|
|
Suppose you want to prevent git annex sync from committing changes
|
|
to files, so a manual git commit workflow is used in all clones of the
|
|
repository. Then run:
|
|
|
|
git annex config --set annex.autocommit false
|
|
|
|
If you want to override that in a partiticular clone, just use git config
|
|
in the clone:
|
|
|
|
git config annex.autocommit true
|
|
|
|
And to get back to the default behavior:
|
|
|
|
git annex config --unset annex.autocommit
|
|
|
|
# SEE ALSO
|
|
|
|
[[git-annex]](1)
|
|
|
|
git-config(1)
|
|
|
|
[[git-annex-vicfg]](1)
|
|
|
|
# AUTHOR
|
|
|
|
Joey Hess <id@joeyh.name>
|
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
|