Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 4.64 KB

LIBGIT_NOTES.md

File metadata and controls

123 lines (90 loc) · 4.64 KB
Raw

Instructions to build libgit2

For windows

Make sure you have the following applications installed on your system

  • VS 2019 for the C/C++ compiler
  • cmake
  • cygwin with the following packages
    • gcc
      • The package will be downloaded to <cygwin_dir>\bin\ as x86_64-w64-mingw32-gcc.exe. This has to be renamed to gcc.exe so that go can find the package while building gitconvex with libgit2
    • pkg-config
      • The pkg-config exe will be downloaded with a different name, so rename the <cygwin_dir>\pkgconf.exe file to pkg-config.exe

After setting up cygwin, add cygwin /bin folder to the path environment variable. Also make sure that you follow the package renaming instructions for gcc and pkg-config without fail to build or run gitconvex with libgit2

The libraries required for setting up libgit2 with libssh2 and openssl are available as a zip file in lib/win. Extract the content of the zip file into the same folder (lib/win)

Steps

  • Download the .zip file from the libgit2 releases or clone the repo from github

Note : gitconvex was tested against libgit v1.1.0. So we recommend you to download the zip file from the releases section for stability

Extract / clone the libgit2 source to an easily accessible folder and copy the lib folder to the root of libgit2 directory

  • Clone libssh2 into the root of the libgit2 folder
git clone https://github.com/libssh2/libssh2 libssh2
  • Search for Cygwin64 Terminal and open it. Run the following commands to generate the libgit2 DLL
cd <FOLDER WHERE LIBGIT2 IS AVAILABLE>

mkdir build && cd build

cmake -DCMAKE_INSTALL_PREFIX=../install \
      -DOPENSSL_ROOT_DIR=../lib/win/ \
      -DBUILD_CLAR=OFF \
      -DEMBED_SSH_PATH=../libssh2 ..

# If the above command completes without any error, execute the following command      
cmake --build . --target install
  • After the command completes execution, the required DLL and libs for libgit2 will be available in <libgit2_root>/install folder
    • copy the git2.dll from install/bin/ to <cygwin>/bin folder
    • copy git2.lib from install/lib to <cygwin>/lib folder
    • copy libgit2.pc from install/lib/pkgconfig to <cygwin>/lib/pkgconfig

Following the above steps will make libgit2 available as a shared library for git2go.

For Linux (tested on Ubuntu 20.04)

If you have brew installed on your linux machine then you can follow the same instructions mentioned below for MacOS to setup libgit2

Make sure you have the following packages installed on your system

Make sure you have required rights for running the following commands. If any of these fail due to access errors then try with sudo

# Download and setup openssl
cd ~ && git clone https://github.com/openssl/openssl.git openssl
cd openssl && ./Configure 
make && make install 
cp -rp *.so* /usr/lib/

# Download and setup libssh2
cd ~ && git clone https://github.com/libssh2/libssh2.git libssh2
cd libssh2/ 
mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX=../install .. 
cmake --build . --target install

#Download and setup libgit2
cd ~ && wget https://github.com/libgit2/libgit2/releases/download/v1.1.0/libgit2-1.1.0.tar.gz
tar -xzf libgit2-1.1.0.tar.gz 
cd libgit2-1.1.0/
mkdir build && cd build 
cmake -DCMAKE_PREFIX_PATH=../../libssh2/install/ -DCMAKE_INSTALL_PREFIX=../install -DBUILD_CLAR=OFF .. 
cmake --build . --target install 

# Copy the libgit2 shared object and pkconfig files to the /usr/lib path
cp -rp ~/libgit2-1.1.0/install/include/* /usr/include/ && \
cp -rp ~/libgit2-1.1.0/install/lib/pkgconfig/* /usr/lib/ && \
cp -rp ~/libgit2-1.1.0/install/lib/lib* /usr/lib/

For MacOS

The dependencies required to build and run gitconvex are readily available from brew

Download and setup brew to install all the required packages