From 9a4dd44812c14895d3702b3a5ad38195927e9996 Mon Sep 17 00:00:00 2001 From: Patrick Steinhardt Date: Wed, 30 Aug 2023 13:57:17 +0200 Subject: docs: Stop mentioning libgit2 We don't use either Git2go nor libgit2 anymore, so let's stop mentioning it. --- README.md | 8 +++----- doc/beginners_guide.md | 1 - doc/serverside_git_usage.md | 3 +-- internal/testhelper/configure.go | 2 +- internal/testhelper/testcfg/binaries.go | 2 +- internal/testhelper/testdata/home/.config/git/config | 2 +- internal/testhelper/testdata/home/.gitconfig | 2 +- 7 files changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 80f0f72ff..6416eb825 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,6 @@ graph LR subgraph "Gitaly Service" Gitaly == git ==> Filesystem - Gitaly -- "libgit2" --> Filesystem[(Filesystem)] end subgraph "Clients" @@ -73,9 +72,8 @@ In [High Availability](#high-availability) mode, the current implementation look ```mermaid graph LR - subgraph "Gitaly Nodes" + subgraph "Gitaly Nodes" Gitaly == git ==> Filesystem - Gitaly -- "libgit2" --> Filesystem[(Filesystem)] end subgraph "Praefects" @@ -89,10 +87,10 @@ graph LR subgraph "Clients" Rails[gitlab-rails] - Workhorse + Workhorse Shell[gitlab-shell] end - + Clients --> Praefects --> Gitaly ``` diff --git a/doc/beginners_guide.md b/doc/beginners_guide.md index 0fbed62ca..4de508911 100644 --- a/doc/beginners_guide.md +++ b/doc/beginners_guide.md @@ -75,7 +75,6 @@ To enable linting in your code editor: 1. Run `make lint` at least once. That builds a version of `golangci-lint` for you. 1. Point your code editor or code editor's plugin to the binary at `_build/tools/golangci-lint`. -1. If necessary, add `_build/deps/libgit2/install/lib/pkgconfig` to your `PKG_CONFIG_PATH` environment variable. #### Experimenting with editing code diff --git a/doc/serverside_git_usage.md b/doc/serverside_git_usage.md index c6d0faa70..823191bc6 100644 --- a/doc/serverside_git_usage.md +++ b/doc/serverside_git_usage.md @@ -1,9 +1,8 @@ # Server side Git usage -Gitaly uses three implementations to read and write to Git repositories: +Gitaly uses two implementations to read and write to Git repositories: 1. `git(1)` - The same Git used by clients all over the world -1. [LibGit2](https://github.com/libgit2/libgit2) - a linkable library used through Rugged and Git2Go 1. On ad-hoc basis, part of Git is implemented in this repository if the implementation is easy and stable. For example the [pktline](../internal/git/pktline) package. diff --git a/internal/testhelper/configure.go b/internal/testhelper/configure.go index 7788788a3..6dc326057 100644 --- a/internal/testhelper/configure.go +++ b/internal/testhelper/configure.go @@ -111,7 +111,7 @@ func configure() (_ func(), returnedErr error) { } } - // We need to make sure that we're gitconfig-clean: neither Git nor libgit2 should pick up + // We need to make sure that we're gitconfig-clean: Git should not pick up // gitconfig files from anywhere but the repository itself in case they're configured to // ignore them. We set that configuration by default in our tests to have a known-good // environment. diff --git a/internal/testhelper/testcfg/binaries.go b/internal/testhelper/testcfg/binaries.go index 5da1a88ea..8d403e8b0 100644 --- a/internal/testhelper/testcfg/binaries.go +++ b/internal/testhelper/testcfg/binaries.go @@ -102,7 +102,7 @@ func BuildBinary(tb testing.TB, targetDir, sourcePath string) string { } buildTags := []string{ - "static", "system_libgit2", "gitaly_test", + "gitaly_test", } if os.Getenv("GITALY_TESTING_ENABLE_FIPS") != "" { buildTags = append(buildTags, "fips") diff --git a/internal/testhelper/testdata/home/.config/git/config b/internal/testhelper/testdata/home/.config/git/config index aef95e47e..e6dc1af91 100644 --- a/internal/testhelper/testdata/home/.config/git/config +++ b/internal/testhelper/testdata/home/.config/git/config @@ -1,4 +1,4 @@ -# We're trying to catch any instances of libgit2 or Git that pick up the +# We're trying to catch any instances of Git that pick up the # gitconfig even though they're told not to. If they do pick up this file # though, then they would fail to parse it and thus return an error, which we # can detect quite easily. diff --git a/internal/testhelper/testdata/home/.gitconfig b/internal/testhelper/testdata/home/.gitconfig index aef95e47e..e6dc1af91 100644 --- a/internal/testhelper/testdata/home/.gitconfig +++ b/internal/testhelper/testdata/home/.gitconfig @@ -1,4 +1,4 @@ -# We're trying to catch any instances of libgit2 or Git that pick up the +# We're trying to catch any instances of Git that pick up the # gitconfig even though they're told not to. If they do pick up this file # though, then they would fail to parse it and thus return an error, which we # can detect quite easily. -- cgit v1.2.3