Skip to content

Commit 00a696c

Browse files
authored
Update broken links in readme
1 parent f5ba62a commit 00a696c

File tree

1 file changed

+10
-24
lines changed

1 file changed

+10
-24
lines changed

README.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,30 @@ To access git dependencies (for example, via tools.deps), one must download git
99
and working trees as indicated by git shas. This library provides this functionality and also
1010
keeps a cache of git dirs and working trees that can be reused.
1111

12-
## Usage
12+
## API
1313

1414
The following API is provided in `clojure.tools.gitlibs`:
1515

1616
* `(resolve git-url rev) ;; returns full sha of rev in git-url`
1717
* `(procure git-url lib rev) ;; returns working tree directory for git-url identified as lib at rev`
1818
* `(descendant git-url revs) ;; returns rev which is a descedant of all revs, or nil if none`
19+
* `(tags git-url) ;; returns a collection of tags in this git-url (fetches to refresh)`
20+
* `(cache-dir) ;; returns path to root of gitlibs cache dir`
1921

2022
### Git urls
2123

2224
The following git url types are supported:
2325

24-
* `https` - for public anonymous clone and fetch of public repos
25-
* `ssh` - for authenticated clone and fetch of private repos
26-
* `http` and `git` protocols are plain-text and not supported or recommended
27-
28-
### SSH authentication for private repositories
29-
30-
ssh authentication works by connecting to the local ssh agent (ssh-agent on \*nix or Pageant via PuTTY on Windows).
31-
The ssh-agent must have a registered identity for the key being used to access the Git repository.
32-
To check whether you have registered identities, use:
33-
34-
`ssh-add -l`
35-
36-
which should return one or more registered identities, typically the one at `~/.ssh/id_rsa`.
37-
38-
For more information on creating keys and using the ssh-agent to manage your ssh identities, GitHub provides excellent info:
39-
40-
* https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/
41-
* https://help.github.com/articles/working-with-ssh-key-passphrases/
26+
* `https` - for public anonymous clone and fetch of public or private repos with credentials via git credential sources
27+
* `ssh` - for authenticated clone and fetch of private repos (uses ssh)
28+
* `http` and `git` protocols are plain-text and NOT supported or recommended
4229

4330
### Revs
4431

4532
The API functions all take revs, which can be any git rev that resolves to a commit, such as:
4633

4734
* Full sha (40 chars)
48-
* Prefix sha (sufficiently unique in the repo)
35+
* Prefix sha (sufficiently unique in the repo, often 7 chars)
4936
* Tag name
5037
* Branch name
5138

@@ -54,7 +41,7 @@ repeatedly on a rev that does not resolve to a fixed sha may result in new check
5441

5542
### Configuration
5643

57-
Downloaded git dirs and working trees are stored in ~/.gitlibs - this directory is just a cache and can be safely removed if needed.
44+
Downloaded git dirs and working trees are stored in the gitlibs cache dir, ~/.gitlibs by default. This directory is just a cache and can be safely removed if needed.
5845

5946
tools.gitlibs can be configured by either environment variable or Java system property. If both are provided, the Java system property takes precedence.
6047

@@ -96,9 +83,8 @@ Latest release: 2.3.161
9683
# Developer Information
9784

9885
* [GitHub project](https://github.com/clojure/tools.gitlibs)
99-
* [API Docs](https://clojure.github.io/tools.gitlibs)
100-
* [How to contribute](https://dev.clojure.org/display/community/Contributing)
101-
* [Bug Tracker](https://dev.clojure.org/jira/browse/TDEPS)
86+
* [Bug Tracker](https://dev.clojure.org/jira/browse/TDEPS) - if you don't have an acct there, please ask at [Ask Clojure](https://ask.clojure.org)
87+
* [How to contribute](https://clojure.org/dev/dev)
10288
* [Continuous Integration](https://build.clojure.org/job/gitlibs/)
10389
* [Compatibility Test Matrix](https://build.clojure.org/job/tools.gitlibs-matrix/)
10490

0 commit comments

Comments
 (0)