test: Added --test-with-git-config option

Sponsored-by: Dartmouth College's DANDI project
This commit is contained in:
Joey Hess 2022-09-22 15:58:45 -04:00
parent d049228fd3
commit f64eff9355
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
6 changed files with 47 additions and 8 deletions

View file

@ -30,6 +30,20 @@ framework. Pass --help for details about those.
When there are test failures, leave the `.t` directory populated with
repositories that demonstate the failures, for later analysis.
* `--test-git-config name=value`
The test suite prevents git from reading any git configuration files.
Usually it is a good idea to run the test suite with a standard
git configuration. However, this option can be useful to see what
effect a git configuration setting has on the test suite.
Some configuration settings will break the test suite, in ways that are
due to a bug in git-annex. But it is possible that changing a
configuration can find a legitimate bug in git-annex.
One valid use of this is to change a git configuration to a value that
is planned to be the new default in a future version of git.
# SEE ALSO
[[git-annex]](1)

View file

@ -1,5 +1,8 @@
`git-annex test` prevents ~/.gitconfig or /etc/gitconfig from being read.
The `-c` option also doesn't propagate into the test suite.
It would sometimes be useful to test git-annex with a given git config set.
Although some might break the test suite, others might expose actual bugs
in git-annex. --[[Joey]]
> Added "--test-git-config" option, [[done]] --[[Joey]]