Skip to content

Commit bf17056

Browse files
author
Paulo Gomes
committed
Update development docs on libgit2
Since the move to using statically built versions of the dependency libraries it is no longer required for users to install libgit2 into their development environments. Signed-off-by: Paulo Gomes <[email protected]>
1 parent 62b5007 commit bf17056

File tree

1 file changed

+7
-25
lines changed

1 file changed

+7
-25
lines changed

DEVELOPMENT.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,44 +13,26 @@ There are a number of dependencies required to be able to run the controller and
1313
- [Install Docker](https://docs.docker.com/engine/install/)
1414
- (Optional) [Install Kubebuilder](https://book.kubebuilder.io/quick-start.html#installation)
1515

16-
The dependency [libgit2](https://libgit2.org/) also needs to be installed to be able
17-
to run `source-controller` or its test-suite locally (not in a container).
18-
19-
In case this dependency is not present on your system (at the expected
20-
version), the first invocation of a `make` target that requires the
21-
dependency will attempt to compile it locally to `hack/libgit2`. For this build
22-
to succeed ensure the following dependencies are present on your system:
23-
- [CMake](https://cmake.org/download/)
24-
- [OpenSSL 1.1](https://www.openssl.org/source/)
25-
- [LibSSH2](https://www.libssh2.org/)
26-
- [pkg-config](https://freedesktop.org/wiki/Software/pkg-config/)
27-
28-
Triggering a manual build of the dependency is possible as well by running
29-
`make libgit2`. To enforce the build, for example if your system dependencies
30-
match but are not linked in a compatible way, append `LIBGIT2_FORCE=1` to the
31-
`make` command.
32-
33-
Follow the instructions below to install these dependencies to your system.
16+
The [libgit2](https://libgit2.org/) dependency is now automatically managed by the Makefile logic.
17+
However, it depends on [pkg-config](https://freedesktop.org/wiki/Software/pkg-config/) being installed:
3418

3519
### macOS
3620

3721
```console
38-
$ # Ensure libgit2 dependencies are available
39-
$ brew install cmake [email protected] libssh2 pkg-config
40-
$ LIBGIT2_FORCE=1 make libgit2
22+
$ # Ensure pkg-config is installed
23+
$ brew install pkg-config
4124
```
4225

4326
### Linux
4427

4528
```console
46-
$ # Ensure libgit2 dependencies are available
47-
$ pacman -S cmake openssl libssh2
48-
$ LIBGIT2_FORCE=1 make libgit2
29+
$ # Ensure pkg-config is installed
30+
$ pacman -S pkgconf
4931
```
5032

5133
**Note:** Example shown is for Arch Linux, but likewise procedure can be
5234
followed using any other package manager. Some distributions may have slight
53-
variation of package names (e.g. `apt install -y cmake openssl libssh2-1-dev`).
35+
variation of package names (e.g. `apt install -y pkg-config`).
5436

5537
In addition to the above, the following dependencies are also used by some of the `make` targets:
5638

0 commit comments

Comments
 (0)