From 00352ebe37be4b7842c4b84f97cccec538f471bb Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 17 Dec 2020 12:17:58 -0400 Subject: [PATCH] man page improvement --- doc/git-annex-config.mdwn | 16 +++++++++------- doc/git-annex.mdwn | 7 ++++++- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/doc/git-annex-config.mdwn b/doc/git-annex-config.mdwn index 01c5341eff..ecea8c75d1 100644 --- a/doc/git-annex-config.mdwn +++ b/doc/git-annex-config.mdwn @@ -18,20 +18,22 @@ 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. -# 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 `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)". + "`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 diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 9fba53ecb3..6280bcb864 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -837,6 +837,11 @@ may not be explicitly listed on their individual man pages. # CONFIGURATION 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` @@ -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. 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. Overrides any annex.largefiles attributes in `.gitattributes` files. -- 2.30.2