summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorlhchavez <[email protected]>2021-09-03 06:40:31 -0700
committerlhchavez <[email protected]>2021-09-05 18:52:01 -0700
commit018647fd481a7eb4af97d5f61afc0fddfe76fc24 (patch)
tree06f4af28f0298ffe4bd93d2061f7eb8c52518bc2 /README.md
parentb78bde3d74b1617d5b635723552aaec0583eb054 (diff)
libgit2 v1.2.0 #major
This commit introduces libgit2 v1.2.0 to git2go, which brings a large number of [bugfixes and features](https://github.com/libgit2/libgit2/releases/tag/v1.2.0). This also marks the start of the v32 release.
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index d05c4c1..7cc36eb 100644
--- a/README.md
+++ b/README.md
@@ -10,20 +10,21 @@ Due to the fact that Go 1.11 module versions have semantic meaning and don't nec
| libgit2 | git2go |
|---------|---------------|
-| main | (will be v32) |
+| main | (will be v33) |
+| 1.2 | v32 |
| 1.1 | v31 |
| 1.0 | v30 |
| 0.99 | v29 |
| 0.28 | v28 |
| 0.27 | v27 |
-You can import them in your project with the version's major number as a suffix. For example, if you have libgit2 v1.1 installed, you'd import git2go v31 with:
+You can import them in your project with the version's major number as a suffix. For example, if you have libgit2 v1.2 installed, you'd import git2go v32 with:
```sh
-go get github.com/libgit2/git2go/v31
+go get github.com/libgit2/git2go/v32
```
```go
-import "github.com/libgit2/git2go/v31"
+import "github.com/libgit2/git2go/v32"
```
which will ensure there are no sudden changes to the API.
@@ -44,10 +45,10 @@ This project wraps the functionality provided by libgit2. If you're using a vers
### Versioned branch, dynamic linking
-When linking dynamically against a released version of libgit2, install it via your system's package manager. CGo will take care of finding its pkg-config file and set up the linking. Import via Go modules, e.g. to work against libgit2 v1.1
+When linking dynamically against a released version of libgit2, install it via your system's package manager. CGo will take care of finding its pkg-config file and set up the linking. Import via Go modules, e.g. to work against libgit2 v1.2
```go
-import "github.com/libgit2/git2go/v31"
+import "github.com/libgit2/git2go/v32"
```
### Versioned branch, static linking
@@ -77,7 +78,7 @@ In order to let Go pass the correct flags to `pkg-config`, `-tags static` needs
One thing to take into account is that since Go expects the `pkg-config` file to be within the same directory where `make install-static` was called, so the `go.mod` file may need to have a [`replace` directive](https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive) so that the correct setup is achieved. So if `git2go` is checked out at `$GOPATH/src/github.com/libgit2/git2go` and your project at `$GOPATH/src/github.com/my/project`, the `go.mod` file of `github.com/my/project` might need to have a line like
- replace github.com/libgit2/git2go/v31 ../../libgit2/git2go
+ replace github.com/libgit2/git2go/v32 ../../libgit2/git2go
Parallelism and network operations
----------------------------------