Skip to content

Commit 5682bb8

Browse files
committed
add config info
1 parent 6b2cb41 commit 5682bb8

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,18 @@ The API functions all take revs, which can be any git rev that resolves to a com
5454
Procured working trees are always cached on the basis of the rev's full sha, so using `procure`
5555
repeatedly on a rev that does not resolve to a fixed sha may result in new checkouts in the cache.
5656

57-
### Cache directory
57+
### Configuration
5858

5959
Downloaded git dirs and working trees are stored in ~/.gitlibs - this directory is just a cache and can be safely removed if needed.
6060

61-
The cache location can also be set with the environment variable GITLIBS.
61+
tools.gitlibs can be configured by either environment variable or Java system property. If both are provided, the Java system property takes precedence.
62+
63+
| Env var | Java system property | default | description
64+
| ------- | -------------------- | ------- | -----------
65+
| GITLIBS | clojure.gitlibs.dir | ~/.gitlibs | Local directory cache for git repos and working trees |
66+
| GITLIBS_COMMAND | clojure.gitlibs.command | git | git command to run when shelling out (supply full path if needed) |
67+
| GITLIBS_DEBUG | clojure.gitlibs.debug | false | If true, print git commands and output to stderr |
68+
| GITLIBS_TERMINAL | clojure.gitlibs.terminal | false | If true, interactively prompt if needed |
6269

6370
## Example Usage
6471

0 commit comments

Comments
 (0)