ad5df35a47
Welcome to yet another libgit2 release, this one being the biggest we've shipped so far. Highlights on this release include diff, branches, notes and submodules support. The new diff API is shiny and powerful. Check it out. Apologies, one more time, to all the early adopters for the breaking API changes. We've been iterating on the error handling for the library until we reached its current state, which we believe it's significantly more usable both for normal users and for developers of bindings to other languages. Also, we've renamed a few legacy calls to ensure that the whole external API uses a consistent naming scheme. As always, check the API docs for the full list of new API calls and backwards-incompatible changes. http://libgit2.github.com/libgit2/ Changelog of new features follows: Attributes: - Added function macros to check attribute values instead of having to manually compare them - Added support for choosing the attribute loading order (workdir files vs index) and to skip the systems' default `.gitattributes` - Fixed issues when fetching attribute data on bare repositories Blob: - Added support for creating blobs from any file on disk (not restricted to the repository's working directory) - Aded support for smudge filters when writing blobs to the ODB - So far only CRLF normalization is available Branches: - Added a high-level branch API: - git_branch_create - git_branch_delete - git_branch_list - git_branch_move Commit: - Commit messages are now filtered to match Git rules (stripping comments and adding proper whitespacing rules) Config: - Added support for setting and getting multivars - Added `git_config_get_mapped` to map the value of a config variable based on its defaults Diff: - Added full diff API: - tree to tree - index to tree - workdir to index - workdir to tree - blob to blob - Added helper functions to print the diffs as valid patchfiles Error handling: - New design for the error handling API, taking into consideration the requirements of dynamic languages Indexer: - Added streaming packfile indexer Merge: - Added support for finding the merge base between two commits Notes: - Full git-notes support: - git_note_read - git_note_message/git_note_oid - git_note_create - git_note_remove - git_note_free - git_note_foreach References: - Added `git_reference_name_to_oid` helper to resolve a reference to its final OID - Added `git_reference_cmp` to compare two references with a stable order Remotes: - Added support for writing and saving remotes - `git_remote_add` - `git_remote_save` - Setters for all the attributes of a remote - Switched remote download to the new streaming packfile indexer - Fixed fetch on HTTP and Git under Windows - Added `git_remote_supported_url` helper to check if a protocol can be accessed by the library - Added `git_remote_list` Repository: - Made `git_repository_open` smarter when finding the `.git` folder. - Added `git_repository_open_ext` with extra options when opening a repository Revwalk: - Added support for pushing/hiding several references through a glob - Added helper to push/hide the current HEAD to the walker - Added helper to push/hide a single reference to the walker Status: - Greatly improved Status implementation using the new `diff` code as a backend Submodules: - Added a partial submodules API to get information about a submodule and list all the submodules in a repository - git_submodule_foreach - git_submodule_lookup Tag: - Added `git_tag_peel` helper to peel a tag to its pointed object - Tag messages are now filtered to match Git rules (stripping comments and adding proper whitespacing rules) Tree: - Killed the old `git_tree_diff` API, which is replaced by the new diff code. Signed-off-by: Vicent Marti <tanoku@gmail.com> |
||
|---|---|---|
| deps | ||
| docs | ||
| examples | ||
| include | ||
| packaging/rpm | ||
| src | ||
| tests-clar | ||
| .gitattributes | ||
| .gitignore | ||
| .HEADER | ||
| .travis.yml | ||
| api.docurium | ||
| AUTHORS | ||
| CMakeLists.txt | ||
| CONVENTIONS | ||
| COPYING | ||
| git.git-authors | ||
| libgit2.pc.in | ||
| Makefile.embed | ||
| README.md | ||
libgit2 - the Git linkable library
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.
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.
- Mailing list: libgit2@librelist.org
- Archives: http://librelist.com/browser/libgit2/
- Website: http://libgit2.github.com
- API documentation: http://libgit2.github.com/libgit2
- Usage guide: http://libgit2.github.com/api.html
What It Can Do
libgit2 is already very usable.
- SHA conversions, formatting and shortening
- abstracted ODB backend system
- commit, tag, tree and blob parsing, editing, and write-back
- tree traversal
- revision walking
- index file (staging area) manipulation
- reference management (including packed references)
- config file management
- high level repository management
- thread safety and reentrancy
- descriptive and detailed error messages
- ...and more (over 175 different API calls)
Building libgit2 - Using CMake
libgit2 builds cleanly on most platforms without any external dependencies.
Under Unix-like systems, like Linux, *BSD and Mac OS X, libgit2 expects pthreads to be available;
they should be installed by default on all systems. Under Windows, libgit2 uses the native Windows API
for threading.
The libgit2 library is built using CMake 2.6+ (http://www.cmake.org) on all platforms.
On most systems you can build the library using the following commands
$ mkdir build && cd build
$ cmake ..
$ cmake --build .
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:
$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
$ cmake --build . --target install
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.
For more advanced use or questions about CMake please read http://www.cmake.org/Wiki/CMake_FAQ.
The following CMake variables are declared:
INSTALL_BIN: Where to install binaries to.INSTALL_LIB: Where to install libraries to.INSTALL_INC: Where to install headers to.BUILD_SHARED_LIBS: Build libgit2 as a Shared Library (defaults to ON)BUILD_CLAR: Build Clar-based test suite (defaults to ON)THREADSAFE: Build libgit2 with threading support (defaults to OFF)
Language Bindings
Here are the bindings to libgit2 that are currently available:
- C++
- libqgit2, Qt bindings https://projects.kde.org/projects/playground/libs/libqgit2/
- Chicken Scheme
- chicken-git https://wiki.call-cc.org/egg/git
- Delphi
- GitForDelphi https://github.com/libgit2/GitForDelphi
- Erlang
- Go
- GObject
- libgit2-glib https://github.com/nacho/libgit2-glib
- Haskell
- Lua
- .NET
- libgit2net, low level bindings https://github.com/txdv/libgit2net
- libgit2sharp https://github.com/libgit2/libgit2sharp
- Node.js
- node-gitteh https://github.com/libgit2/node-gitteh
- nodegit https://github.com/tbranyen/nodegit
- Objective-C
- objective-git https://github.com/libgit2/objective-git
- OCaml
- libgit2-ocaml https://github.com/burdges/libgit2-ocaml
- Parrot Virtual Machine
- parrot-libgit2 https://github.com/letolabs/parrot-libgit2
- Perl
- git-xs-pm https://github.com/ingydotnet/git-xs-pm
- PHP
- Python
- Ruby
- Vala
If you start another language binding to libgit2, please let us know so we can add it to the list.
How Can I Contribute?
Fork libgit2/libgit2 on GitHub, add your improvement, push it to a branch in your fork named for the topic, send a pull request.
You can also file bugs or feature requests under the libgit2 project on GitHub, or join us on the mailing list by sending an email to:
License
libgit2 is under GPL2 with linking exemption. This means you can link to the library with any program, commercial, open source or other. However, you cannot modify libgit2 and distribute it without supplying the source.
See the COPYING file for the full license text.