README.md 10.2 KB
Newer Older
Scott Chacon committed
1
libgit2 - the Git linkable library
2
==================================
Scott Chacon committed
3

4
[![Travis Build Status](https://secure.travis-ci.org/libgit2/libgit2.svg?branch=master)](http://travis-ci.org/libgit2/libgit2)
5
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/xvof5b4t5480a2q3/branch/master?svg=true)](https://ci.appveyor.com/project/libgit2/libgit2/branch/master)
6
[![Coverity Scan Build Status](https://scan.coverity.com/projects/639/badge.svg)](https://scan.coverity.com/projects/639)
7

8 9 10
`libgit2` is a portable, pure C implementation of the Git core methods
provided as a re-entrant linkable library with a solid API, allowing you to
write native speed custom Git applications in any language with bindings.
Scott Chacon committed
11

12 13 14 15 16
`libgit2` is licensed under a **very permissive license** (GPLv2 with a special
Linking Exception).  This basically means that you can link it (unmodified)
with any kind of software without having to release its source code.
Additionally, the example code has been released to the public domain (see the
[separate license](examples/COPYING) for more information).
17

18 19
Getting Help
============
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
**Join us on Slack**

Visit [slack.libgit2.org](http://slack.libgit2.org/) to sign up, then join
us in `#libgit2`.  If you prefer IRC, you can also point your client to our
slack channel once you've registered.

**Getting Help**

If you have questions about the library, please be sure to check out the
[API documentation](http://libgit2.github.com/libgit2/).  If you still have
questions, reach out to us on Slack or post a question on 
[StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) (with the `libgit2` tag).

**Reporting Bugs**

Please open a [GitHub Issue](https://github.com/libgit2/libgit2/issues) and
include as much information as possible.  If possible, provide sample code
that illustrates the problem you're seeing.  If you're seeing a bug only
on a specific repository, please provide a link to it if possible.

We ask that you not open a GitHub Issue for help, only for bug reports.
Scott Chacon committed
42 43

What It Can Do
44
==============
Scott Chacon committed
45

46 47 48 49 50 51 52 53 54 55 56
The goal of this library is to allow its users the ability to handle Git data in
their applications from their programming language of choice, as is used in
production for many applications including the GitHub.com site, in Plastic SCM
and also powering Microsoft's Visual Studio tools for Git.

It does not aim to replace the git tool or its user-facing commands. Some APIs
resemble the plumbing commands as those align closely with the concepts of the
Git system, but most commands a user would type are out of scope for this
library to implement directly.

The library provides:
57

58
* SHA conversions, formatting and shortening
59
* abstracted ODB backend system
Vicent Marti committed
60
* commit, tag, tree and blob parsing, editing, and write-back
Scott Chacon committed
61
* tree traversal
62 63 64
* revision walking
* index file (staging area) manipulation
* reference management (including packed references)
Vicent Marti committed
65 66 67 68 69
* config file management
* high level repository management
* thread safety and reentrancy
* descriptive and detailed error messages
* ...and more (over 175 different API calls)
70

71 72 73 74 75 76 77 78
Optional dependencies
=====================

While the library provides git functionality without the need for
dependencies, it can make use of a few libraries to add to it:

- pthreads (non-Windows) to enable threadsafe access as well as multi-threaded pack generation
- OpenSSL (non-Windows) to talk over HTTPS and provide the SHA-1 functions
Linquize committed
79
- LibSSH2 to enable the SSH transport
80 81
- iconv (OSX) to handle the HFS+ path encoding peculiarities

82 83 84 85 86 87 88 89 90 91 92
Initialization
===============

The library needs to keep track of some global state. Call

    git_libgit2_init();

before calling any other libgit2 functions. You can call this function many times. A matching number of calls to

    git_libgit2_shutdown();

93 94 95 96
will free the resources.  Note that if you have worker threads, you should
call `git_libgit2_shutdown` *after* those threads have exited.  If you
require assistance coordinating this, simply have the worker threads call
`git_libgit2_init` at startup and `git_libgit2_shutdown` at shutdown.
97

98 99 100 101 102
Threading
=========

See [THREADING](THREADING.md) for information

103 104 105 106 107 108
Conventions
===========

See [CONVENTIONS](CONVENTIONS.md) for an overview of the external
and internal API/coding conventions we use.

Vicent Marti committed
109 110
Building libgit2 - Using CMake
==============================
Peter Drahoš committed
111

112
`libgit2` builds cleanly on most platforms without any external dependencies.
113
Under Unix-like systems, like Linux, \*BSD and Mac OS X, libgit2 expects `pthreads` to be available;
114 115 116
they should be installed by default on all systems. Under Windows, libgit2 uses the native Windows API
for threading.

117
The `libgit2` library is built using [CMake](<https://cmake.org/>) (version 2.8 or newer) on all platforms.
Scott Chacon committed
118

Vicent Marti committed
119
On most systems you can build the library using the following commands
Scott Chacon committed
120

Vicent Marti committed
121 122 123
	$ mkdir build && cd build
	$ cmake ..
	$ cmake --build .
124

Vicent Marti committed
125 126 127
Alternatively you can point the CMake GUI tool to the CMakeLists.txt file and generate platform specific build project or IDE workspace.

To install the library you can specify the install prefix by setting:
Scott Chacon committed
128

Vicent Marti committed
129 130
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
	$ cmake --build . --target install
Scott Chacon committed
131

132
For more advanced use or questions about CMake please read <https://cmake.org/Wiki/CMake_FAQ>.
133

Vicent Marti committed
134 135
The following CMake variables are declared:

136
- `BIN_INSTALL_DIR`: Where to install binaries to.
137
- `LIB_INSTALL_DIR`: Where to install libraries to.
138
- `INCLUDE_INSTALL_DIR`: Where to install headers to.
139
- `BUILD_SHARED_LIBS`: Build libgit2 as a Shared Library (defaults to ON)
Keith Dahlby committed
140
- `BUILD_CLAR`: Build [Clar](https://github.com/vmg/clar)-based test suite (defaults to ON)
141
- `THREADSAFE`: Build libgit2 with threading support (defaults to ON)
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
- `STDCALL`: Build libgit2 as `stdcall`. Turn off for `cdecl` (Windows; defaults to ON)

Compiler and linker options
---------------------------

CMake lets you specify a few variables to control the behavior of the
compiler and linker. These flags are rarely used but can be useful for
64-bit to 32-bit cross-compilation.

- `CMAKE_C_FLAGS`: Set your own compiler flags
- `CMAKE_FIND_ROOT_PATH`: Override the search path for libraries
- `ZLIB_LIBRARY`, `OPENSSL_SSL_LIBRARY` AND `OPENSSL_CRYPTO_LIBRARY`:
Tell CMake where to find those specific libraries

MacOS X
-------

If you want to build a universal binary for Mac OS X, CMake sets it
all up for you if you use `-DCMAKE_OSX_ARCHITECTURES="i386;x86_64"`
when configuring.

Windows
-------

You need to run the CMake commands from the Visual Studio command
prompt, not the regular or Windows SDK one. Select the right generator
for your version with the `-G "Visual Studio X" option.

170
See [the website](http://libgit2.github.com/docs/guides/build-and-link/)
171
for more detailed instructions.
172

173 174 175 176
Android
-------

Extract toolchain from NDK using, `make-standalone-toolchain.sh` script.
Nicolas Kaiser committed
177 178
Optionally, crosscompile and install OpenSSL inside of it. Then create CMake
toolchain file that configures paths to your crosscompiler (substitute `{PATH}`
179 180 181 182
with full path to the toolchain):

	SET(CMAKE_SYSTEM_NAME Linux)
	SET(CMAKE_SYSTEM_VERSION Android)
nulltoken committed
183

184 185 186
	SET(CMAKE_C_COMPILER   {PATH}/bin/arm-linux-androideabi-gcc)
	SET(CMAKE_CXX_COMPILER {PATH}/bin/arm-linux-androideabi-g++)
	SET(CMAKE_FIND_ROOT_PATH {PATH}/sysroot/)
nulltoken committed
187

188 189 190 191
	SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
	SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
	SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

192
Add `-DCMAKE_TOOLCHAIN_FILE={pathToToolchainFile}` to cmake command
193 194
when configuring.

Vicent Marti committed
195 196
Language Bindings
==================================
Scott Chacon committed
197

Vicent Marti committed
198
Here are the bindings to libgit2 that are currently available:
Scott Chacon committed
199

200
* C++
201
    * libqgit2, Qt bindings <https://projects.kde.org/projects/playground/libs/libqgit2/repository/>
202 203
* Chicken Scheme
    * chicken-git <https://wiki.call-cc.org/egg/git>
204
* D
Morton Fox committed
205
    * dlibgit <https://github.com/s-ludwig/dlibgit>
206 207 208
* Delphi
    * GitForDelphi <https://github.com/libgit2/GitForDelphi>
* Erlang
209
    * Geef <https://github.com/carlosmn/geef>
210
* Go
211
    * git2go <https://github.com/libgit2/git2go>
212
* GObject
213
    * libgit2-glib <https://wiki.gnome.org/Projects/Libgit2-glib>
214
* Haskell
215
    * hgit2 <https://github.com/jwiegley/gitlib>
216 217
* Java
    * Jagged <https://github.com/ethomson/jagged>
218 219
* Julia
    * LibGit2.jl <https://github.com/jakebolewski/LibGit2.jl>
220 221 222 223 224
* Lua
    * luagit2 <https://github.com/libgit2/luagit2>
* .NET
    * libgit2sharp <https://github.com/libgit2/libgit2sharp>
* Node.js
225
    * nodegit <https://github.com/nodegit/nodegit>
226 227 228
* Objective-C
    * objective-git <https://github.com/libgit2/objective-git>
* OCaml
229
    * ocaml-libgit2 <https://github.com/fxfactorial/ocaml-libgit2>
230 231 232
* Parrot Virtual Machine
    * parrot-libgit2 <https://github.com/letolabs/parrot-libgit2>
* Perl
233
    * Git-Raw <https://github.com/jacquesg/p5-Git-Raw>
234 235
* PHP
    * php-git <https://github.com/libgit2/php-git>
236
* PowerShell
237
    * PSGit <https://github.com/PoshCode/PSGit>
238 239
* Python
    * pygit2 <https://github.com/libgit2/pygit2>
240 241
* R
    * git2r <https://github.com/ropensci/git2r>
242 243
* Ruby
    * Rugged <https://github.com/libgit2/rugged>
244 245
* Rust
    * git2-rs <https://github.com/alexcrichton/git2-rs>
246
* Swift
247
    * SwiftGit2 <https://github.com/SwiftGit2/SwiftGit2>
248 249
* Vala
    * libgit2.vapi <https://github.com/apmasell/vapis/blob/master/libgit2.vapi>
Scott Chacon committed
250 251 252 253

If you start another language binding to libgit2, please let us know so
we can add it to the list.

254
How Can I Contribute?
255 256
==================================

257 258 259 260 261 262 263 264 265
We welcome new contributors!  We have a number of issues marked as
["up for grabs"](https://github.com/libgit2/libgit2/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22)
and
["easy fix"](https://github.com/libgit2/libgit2/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22easy+fix%22)
that are good places to jump in and get started.  There's much more detailed
information in our list of [outstanding projects](PROJECTS.md).

Please be sure to check the [contribution guidelines](CONTRIBUTING.md) to
understand our workflow, and the libgit2 [coding conventions](CONVENTIONS.md).
266

267
License
Scott Chacon committed
268
==================================
269

SeijiIto committed
270
`libgit2` is under GPL2 **with linking exception**. This means you can link to
271
and use the library from any program, proprietary or open source; paid or
272 273
gratis.  However, if you modify libgit2 itself, you must distribute the
source to your modified version of libgit2.
Scott Chacon committed
274

275
See the [COPYING file](COPYING) for the full license text.