view release on metacpan or  search on metacpan

lib/Alien/Libgit2.pm  view on Meta::CPAN

# ABSTRACT: Find or build libgit2, the linkable Git library

package Alien::Libgit2;
our $VERSION = '0.002';
use strict;
use warnings;
use parent 'Alien::Base';

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Alien::Libgit2 - Find or build libgit2, the linkable Git library

=head1 VERSION

version 0.002

=head1 SYNOPSIS

  use Alien::Libgit2;

  # For XS consumers
  my $cflags = Alien::Libgit2->cflags;
  my $libs   = Alien::Libgit2->libs;

  # For FFI consumers (FFI::Platypus, Git::Libgit2)
  my @libs = Alien::Libgit2->dynamic_libs;

=head1 DESCRIPTION

L<Alien::Libgit2> provides the C library L<libgit2|https://libgit2.org/>
for use by other CPAN modules that need to link against it.

It first checks whether a system C<libgit2> (>= 1.9.3) is available via
C<pkg-config>. If not, it builds libgit2 from a bundled source tarball
using CMake. No network access is required during install.

The 1.9.3 floor is a bug fix, not an API requirement: below it, libgit2's
ssh transport loops forever on C<LIBSSH2_ERROR_TIMEOUT>, so a peer that
accepts the connection and then goes silent parks the caller indefinitely.
A system lib below the fix falls through to the bundled share build.

=head1 INSTALLATION

  cpanm Alien::Libgit2

If C<pkg-config> reports a system libgit2 of 1.9.3 or newer, that one is
used. Otherwise the module builds from the bundled libgit2-1.9.3 tarball
using CMake. No network access is needed either way, so the install works
on air-gapped hosts.

=head2 Build dependencies (share install)

=over

=item * C<cmake>

=item * a C compiler

=item * C<pkg-config>