Skip to content

camke: include libssh2 in Requires.private in the PC file#7215

Merged
ethomson merged 1 commit into
libgit2:mainfrom
carlosmn:cmn/ssh2-pc-requires
Mar 14, 2026
Merged

camke: include libssh2 in Requires.private in the PC file#7215
ethomson merged 1 commit into
libgit2:mainfrom
carlosmn:cmn/ssh2-pc-requires

Conversation

@carlosmn
Copy link
Copy Markdown
Member

We need this in order for pkg-config to be able to tell what you should link against when building libgit2 statically. We do include libssh2 in Libs.private but not in Requires.private. The difference is a bit subtle but has become important.

You can call pkg-config --libs --static ${build}/libgit2.pc and it will give you what is in the Libs line, and also what the packages from the Requires field have in theirs. This is what e.g. rugged does and it has been working until recently. An update to openssl to require zstd now means that using --libs --static returns -lzstd as well as many others. This means that those who want to link using that command now need to have the development packages for zstd installed, which should not be necessary as libgit2 itself doesn't want to use anything from it.

A better command to use here seems to be pkg-config --libs --static --pure ${build}/libgit2.pc. The manpage and help output are not very precise but what this does is limit the list of dependencies to a single layer, which is what we want as we would only want to link statically against libgit2 and not the rest of the libraries.

But trying to do so breaks building with libssh2 as it's included in the Libs field rather than the Requires, so that command excludes any linking to libssh2.

Put libssh2 in the Requires.private field so we correctly express we need to link to it when linking statically.

This is unfortunately an imperfect fix as now, if we did not find libssh2 via pkg-config but rather via CMake's find_package, the combination of --static --pure does not take Libs.private into account. However we only support this as an edge case and we expect pkg-config to be available for the rest of our dependencies.


I found this via libgit2/rugged#986 and libgit2/rugged#990 but I can't fix it via --static --pure until libgit2 is more accurate about this.

I'm not sure about the -lrt we have there wrt to this (or in general). The resulting libgit2.so and libgit2_tests don't end up linked against them and removing that line seems to make no difference to the build so maybe it's all part of libc now and a GNU userland doesn't need it?

We need this in order for `pkg-config` to be able to tell what you should link
against when building libgit2 statically. We do include libssh2 in
`Libs.private` but not in `Requires.private`. The difference is a bit subtle but
has become important.

You can call `pkg-config --libs --static ${build}/libgit2.pc` and it will give
you what is in the Libs line, and also what the packages from the Requires field
have in theirs. This is what e.g. `rugged` does and it has been working until
recently. An update to openssl to require zstd now means that using `--libs
--static` returns `-lzstd` as well as many others. This means that those who
want to link using that command now need to have the development packages for
zstd installed, which should not be necessary as libgit2 itself doesn't want to
use anything from it.

A better command to use here seems to be `pkg-config --libs --static --pure
${build}/libgit2.pc`. The manpage and help output are not very precise but what
this does is limit the list of dependencies to a single layer, which is what we
want as we would only want to link statically against libgit2 and not the rest
of the libraries.

But trying to do so breaks building with libssh2 as it's included in the Libs
field rather than the Requires, so that command excludes any linking to libssh2.

Put libssh2 in the `Requires.private` field so we correctly express we need to
link to it when linking statically.

This is unfortunately an imperfect fix as now, if we did not find libssh2 via
pkg-config but rather via CMake's `find_package`, the combination of `--static
--pure` does not take `Libs.private` into account. However we only support this
as an edge case and we expect `pkg-config` to be available for the rest of our
dependencies.
@ethomson ethomson merged commit d78c1eb into libgit2:main Mar 14, 2026
19 checks passed
@ethomson
Copy link
Copy Markdown
Member

Cool, thanks

@carlosmn carlosmn deleted the cmn/ssh2-pc-requires branch March 23, 2026 21:38
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request May 5, 2026
v1.9.3

This release includes a number of bugfixes and compatibility
improvements, particularly around SHA256 support.

* cmake: fix linker error when using ninja build generator by
  @kcsaul in libgit2/libgit2#7249
* Handle redirects with Content-Length: 0 correctly by
  @ethomson in libgit2/libgit2#7246
* ci: use poxygit v0.8.1 in the tests by @ethomson in
  libgit2/libgit2#7248
* Zero indexer stats in pack objects by @ethomson in
  libgit2/libgit2#7243
* submodule: git_index_add_bypath does not move conflict entries
  to REUC by @lrm29 in libgit2/libgit2#7003
* fix: prevent SSH timeout infinite loop and enable TCP keepalive
  by @ambv in libgit2/libgit2#7165
* merge_files: avoid UB in xdiff by @ethomson in
  libgit2/libgit2#7239
* git_merge_file_from_index: handle cases when a child (ours or
  theirs) is null by @eantoranz in
  libgit2/libgit2#7092
* cmake: write git.h.tmp to current binary directory by @kcsaul in
  libgit2/libgit2#7241
* fix(pack): ensure pack_backend__read returns null terminated buffer
  by @kanru in libgit2/libgit2#7238
* Check object lengths against headers in read_loose by @howtonotwin
  in libgit2/libgit2#7178
* cmake: don't recreate git2.h unnecessarily by @ethomson in
  libgit2/libgit2#7234
* Memory Backend Corruption Fix by @kcsaul in
  libgit2/libgit2#7232
* Fixed a heap-buffer-overflow in the smart_pkt.c:set_data function
  by @oliverchang in libgit2/libgit2#7118
* fix(transport): get oid_type on local transport by @weihanglo in
  libgit2/libgit2#7229
* `GIT_REMOTE_DOWNLOAD_TAGS_ALL`: remove stray "the" in docs by
  @DanielEScherzer in libgit2/libgit2#7228
* fix(clone): propagate object format in local clone by @weihanglo in
  libgit2/libgit2#7226
* repo: Fix possible null pointer dereference by @csware in
  libgit2/libgit2#7225
* revparse: Allow `HEAD` abbreviation `@` by @KoviRobi in
  libgit2/libgit2#7218
* camke: include libssh2 in `Requires.private` in the PC file
  by @carlosmn in libgit2/libgit2#7215
* futils: fix undefined behavior in O_FSYNC fallback definition
  by @cehoffman in libgit2/libgit2#7211
* pcre: actually fix dangling-pointer warning by @ethomson in
  libgit2/libgit2#7206
* pcre: update cmake warnings for non-gcc by @ethomson in
  libgit2/libgit2#7205
* Fix some warnings with gcc by @ethomson in
  libgit2/libgit2#7203
* fix: apply insteadOf from global config for detached remotes by
  @weihanglo in libgit2/libgit2#7195
* Fix `git_index_entry` documentation by @bakersdozen123 in
  libgit2/libgit2#7192
* config: Fix potential null value passed to %s by @ethomson in
  libgit2/libgit2#7190
* index: support USE_NSEC=OFF by @ethomson in
  libgit2/libgit2#7187
* feat(remote): expose `git_remote_oid_type` by @weihanglo in
  libgit2/libgit2#7185
* fix(smart): keep caps across RPC stream resets by @weihanglo in
  libgit2/libgit2#7183
* fix wrong comment by @Murmele in
  libgit2/libgit2#7181
* fix(sha256): pass correct oid type by @weihanglo in
  libgit2/libgit2#7179
* examples: correct `git_commit_time` comment by @qaqland in
  libgit2/libgit2#7175
* tests: update to latest clar by @ethomson in
  libgit2/libgit2#7173
* delta: fix undefined behavior in hdr_sz varint parsing
  by @Oblivionsage in libgit2/libgit2#7172
* ci: Update macos-13 to macos-14 images on GitHub Actions by @ambv
  in libgit2/libgit2#7167
* ci: Fix cases of -Werror=discarded-qualifiers raised by @gcc 15.2
  by @ambv in libgit2/libgit2#7164
* Use CMAKE_INSTALL_INCLUDEDIR for libgit2package INSTALL_INTERFACE
  by @aware70 in libgit2/libgit2#7155
* Fix C4703 uninitialized pointer variable warnings by
  @ShiningMassXAcc in libgit2/libgit2#7154
* test: check the correct filesystem for case-sensitivity by @ambv
  in libgit2/libgit2#7153
* ci: update ci/docker/fedora to work with Rawhide 44 by @ambv
  in libgit2/libgit2#7152
* refs: honor REFSPEC_SHORTHAND for multi-segment refs by @roberth
  in libgit2/libgit2#7148
* config: Fix potential null value passed to %s by @orgads in
  libgit2/libgit2#7131
* Fix potential access to uninitialized variables by @orgads
  in libgit2/libgit2#7130
* refspec: Detect DEL character in is_valid_name by @xokdvium
  in libgit2/libgit2#7120
* Update documentation to clarify that cert cb is always called
  by @ehuss in libgit2/libgit2#7119
* Update `racy.c` reference by @emmanuel-ferdman in
  libgit2/libgit2#7091
* Avoid duplicate definition of git_http_auth_dummy. by
  @JohannesWilde in libgit2/libgit2#7077
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request May 13, 2026
v1.9.3

This release includes a number of bugfixes and compatibility
improvements, particularly around SHA256 support.

* cmake: fix linker error when using ninja build generator by
  @kcsaul in libgit2/libgit2#7249
* Handle redirects with Content-Length: 0 correctly by
  @ethomson in libgit2/libgit2#7246
* ci: use poxygit v0.8.1 in the tests by @ethomson in
  libgit2/libgit2#7248
* Zero indexer stats in pack objects by @ethomson in
  libgit2/libgit2#7243
* submodule: git_index_add_bypath does not move conflict entries
  to REUC by @lrm29 in libgit2/libgit2#7003
* fix: prevent SSH timeout infinite loop and enable TCP keepalive
  by @ambv in libgit2/libgit2#7165
* merge_files: avoid UB in xdiff by @ethomson in
  libgit2/libgit2#7239
* git_merge_file_from_index: handle cases when a child (ours or
  theirs) is null by @eantoranz in
  libgit2/libgit2#7092
* cmake: write git.h.tmp to current binary directory by @kcsaul in
  libgit2/libgit2#7241
* fix(pack): ensure pack_backend__read returns null terminated buffer
  by @kanru in libgit2/libgit2#7238
* Check object lengths against headers in read_loose by @howtonotwin
  in libgit2/libgit2#7178
* cmake: don't recreate git2.h unnecessarily by @ethomson in
  libgit2/libgit2#7234
* Memory Backend Corruption Fix by @kcsaul in
  libgit2/libgit2#7232
* Fixed a heap-buffer-overflow in the smart_pkt.c:set_data function
  by @oliverchang in libgit2/libgit2#7118
* fix(transport): get oid_type on local transport by @weihanglo in
  libgit2/libgit2#7229
* `GIT_REMOTE_DOWNLOAD_TAGS_ALL`: remove stray "the" in docs by
  @DanielEScherzer in libgit2/libgit2#7228
* fix(clone): propagate object format in local clone by @weihanglo in
  libgit2/libgit2#7226
* repo: Fix possible null pointer dereference by @csware in
  libgit2/libgit2#7225
* revparse: Allow `HEAD` abbreviation `@` by @KoviRobi in
  libgit2/libgit2#7218
* camke: include libssh2 in `Requires.private` in the PC file
  by @carlosmn in libgit2/libgit2#7215
* futils: fix undefined behavior in O_FSYNC fallback definition
  by @cehoffman in libgit2/libgit2#7211
* pcre: actually fix dangling-pointer warning by @ethomson in
  libgit2/libgit2#7206
* pcre: update cmake warnings for non-gcc by @ethomson in
  libgit2/libgit2#7205
* Fix some warnings with gcc by @ethomson in
  libgit2/libgit2#7203
* fix: apply insteadOf from global config for detached remotes by
  @weihanglo in libgit2/libgit2#7195
* Fix `git_index_entry` documentation by @bakersdozen123 in
  libgit2/libgit2#7192
* config: Fix potential null value passed to %s by @ethomson in
  libgit2/libgit2#7190
* index: support USE_NSEC=OFF by @ethomson in
  libgit2/libgit2#7187
* feat(remote): expose `git_remote_oid_type` by @weihanglo in
  libgit2/libgit2#7185
* fix(smart): keep caps across RPC stream resets by @weihanglo in
  libgit2/libgit2#7183
* fix wrong comment by @Murmele in
  libgit2/libgit2#7181
* fix(sha256): pass correct oid type by @weihanglo in
  libgit2/libgit2#7179
* examples: correct `git_commit_time` comment by @qaqland in
  libgit2/libgit2#7175
* tests: update to latest clar by @ethomson in
  libgit2/libgit2#7173
* delta: fix undefined behavior in hdr_sz varint parsing
  by @Oblivionsage in libgit2/libgit2#7172
* ci: Update macos-13 to macos-14 images on GitHub Actions by @ambv
  in libgit2/libgit2#7167
* ci: Fix cases of -Werror=discarded-qualifiers raised by @gcc 15.2
  by @ambv in libgit2/libgit2#7164
* Use CMAKE_INSTALL_INCLUDEDIR for libgit2package INSTALL_INTERFACE
  by @aware70 in libgit2/libgit2#7155
* Fix C4703 uninitialized pointer variable warnings by
  @ShiningMassXAcc in libgit2/libgit2#7154
* test: check the correct filesystem for case-sensitivity by @ambv
  in libgit2/libgit2#7153
* ci: update ci/docker/fedora to work with Rawhide 44 by @ambv
  in libgit2/libgit2#7152
* refs: honor REFSPEC_SHORTHAND for multi-segment refs by @roberth
  in libgit2/libgit2#7148
* config: Fix potential null value passed to %s by @orgads in
  libgit2/libgit2#7131
* Fix potential access to uninitialized variables by @orgads
  in libgit2/libgit2#7130
* refspec: Detect DEL character in is_valid_name by @xokdvium
  in libgit2/libgit2#7120
* Update documentation to clarify that cert cb is always called
  by @ehuss in libgit2/libgit2#7119
* Update `racy.c` reference by @emmanuel-ferdman in
  libgit2/libgit2#7091
* Avoid duplicate definition of git_http_auth_dummy. by
  @JohannesWilde in libgit2/libgit2#7077
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants