Skip to content

Commit 6330020

Browse files
committed
docs(pytest plugin) Note set_hgconfig and set_gitconfig
1 parent 22beed0 commit 6330020

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/pytest-plugin.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,22 @@ These fixtures are automatically used when the plugin is enabled and `pytest` is
4747
- `/home/${user}` ({func}`user_path`)
4848
- Setting your home directory
4949
- Patch `$HOME` to point to {func}`user_path` ({func}`set_home`)
50-
- Set default configuration
50+
- Create configuration files:
5151

52-
- `.gitconfig`, via {func}`gitconfig`:
53-
- `.hgrc`, via {func}`hgconfig`:
52+
- `.gitconfig`, via {func}`gitconfig`
53+
- `.hgrc`, via {func}`hgconfig`
54+
55+
- Set default configuration for VCS:
56+
57+
- Set {func}`hgconfig` to [`HGRCPATH`] via {func}`set_hgconfig`
58+
- Set {func}`gitconfig` to [`GIT_CONFIG`] via {func}`set_gitconfig`
5459

5560
These are set to ensure you can correctly clone and create repositories without without extra
5661
warnings.
5762

63+
[`HGRCPATH`]: https://www.mercurial-scm.org/doc/hg.1.html#:~:text=UNIX%2Dlike%20environments.-,HGRCPATH,-If%20not%20set
64+
[`GIT_CONFIG`]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-GITCONFIG
65+
5866
## Bootstrapping pytest in your `conftest.py`
5967

6068
The most common scenario is you will want to configure the above fixtures with `autouse`.

0 commit comments

Comments
 (0)