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

man page improvement

Browse source
This commit is contained in:
Joey Hess 2020-12-17 12:17:58 -04:00
parent 26aad24fd3
commit 00352ebe37
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/git-annex-config.mdwn
View file

@ -18,20 +18,22 @@ Unlike `git config` settings, these settings can be seen
in all clones of the repository, once they have gotten their in all clones of the repository, once they have gotten their
git-annex branches in sync. git-annex branches in sync.
# SUPPORTED SETTINGS
git-annex does not check the git-annex branch for all settings.
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:
These settings can be overridden on a per-repository basis using These settings can be overridden on a per-repository basis using
`git config`. `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` * `annex.largefiles`
Used to configure which files are large enough to be added to the annex. Used to configure which files are large enough to be added to the annex.
It is an expression that matches the large files, eg It is an expression that matches the large files, eg
"include=*.mp3 or largerthan(500kb)". "`include=*.mp3 or largerthan(500kb)`".
See [[git-annex-matching-expression]](1) for details on the syntax. See [[git-annex-matching-expression]](1) for details on the syntax.
This sets a default, which can be overridden by annex.largefiles This sets a default, which can be overridden by annex.largefiles

7
doc/git-annex.mdwn
View file

@ -837,6 +837,11 @@ may not be explicitly listed on their individual man pages.
# CONFIGURATION # CONFIGURATION
Like other git commands, git-annex is configured via `.git/config`. Like other git commands, git-annex is configured via `.git/config`.
These settings, as well as relevant git config settings, are
the ones git-annex uses.
(Some of these settings can also be set, across all clones of the
repository, using [[git-annex-config]]. See its man page for a list.)
* `annex.uuid` * `annex.uuid`
@ -914,7 +919,7 @@ Like other git commands, git-annex is configured via `.git/config`.
Used to configure which files are large enough to be added to the annex. Used to configure which files are large enough to be added to the annex.
It is an expression that matches the large files, eg It is an expression that matches the large files, eg
"include=*.mp3 or largerthan(500kb)" "`include=*.mp3 or largerthan(500kb)`"
See [[git-annex-matching-expression]](1) for details on the syntax. See [[git-annex-matching-expression]](1) for details on the syntax.
Overrides any annex.largefiles attributes in `.gitattributes` files. Overrides any annex.largefiles attributes in `.gitattributes` files.