![]() - Consistently return structured data, such as actual ReceiveCommands, which is more useful for callers that are doing things other than verifying the signature, e.g. recording the set of commands. - Store the certificate version field, as this is required to be part of the signed payload. - Add a toText() method to recreate the actual payload for signature verification. This requires keeping track of the un-chomped command strings from the original protocol stream. - Separate the parser from the certificate itself, so the actual PushCertificate object can be immutable. Make a fair attempt at deep immutability, but this is not possible with the current mutable ReceiveCommand structure. - Use more detailed error messages that don't involve NON-NLS strings. - Document null return values more thoroughly. Instead of having the undocumented behavior of throwing NPE from certain methods if they are not first guarded by enabled(), eliminate enabled() and return null from those methods. - Add tests for parsing a push cert from a section of pkt-line stream using a real live stream captured with Wireshark (which, it should be noted, uncovered several simply incorrect statements in C git's Documentation/technical/pack-protocol.txt). This is a slightly breaking API change to classes that were technically public and technically released in 4.0. However, it is highly unlikely that people were actually depending on public behavior, since there were no public methods to create PushCertificates with anything other than null field values, or a PushCertificateParser that did anything other than infinite loop or throw exceptions when reading. Change-Id: I5382193347a8eb1811032d9b32af9651871372d0 |
||
---|---|---|
org.eclipse.jgit | ||
org.eclipse.jgit.ant | ||
org.eclipse.jgit.ant.test | ||
org.eclipse.jgit.archive | ||
org.eclipse.jgit.http.apache | ||
org.eclipse.jgit.http.server | ||
org.eclipse.jgit.http.test | ||
org.eclipse.jgit.junit | ||
org.eclipse.jgit.junit.http | ||
org.eclipse.jgit.packaging | ||
org.eclipse.jgit.pgm | ||
org.eclipse.jgit.pgm.test | ||
org.eclipse.jgit.test | ||
org.eclipse.jgit.ui | ||
tools | ||
.gitattributes | ||
.gitignore | ||
.mailmap | ||
CONTRIBUTING.md | ||
LICENSE | ||
README.md | ||
pom.xml |
README.md
Java Git
An implementation of the Git version control system in pure Java.
This package is licensed under the EDL (Eclipse Distribution License).
JGit can be imported straight into Eclipse, built and tested from there, but the automated builds use Maven.
-
org.eclipse.jgit
A pure Java library capable of being run standalone, with no additional support libraries. It provides classes to read and write a Git repository and operate on a working directory.
All portions of JGit are covered by the EDL. Absolutely no GPL, LGPL or EPL contributions are accepted within this package.
-
org.eclipse.jgit.java7
Extensions for users of Java 7.
-
org.eclipse.jgit.ant
Ant tasks based on JGit.
-
org.eclipse.jgit.archive
Support for exporting to various archive formats (zip etc).
-
org.eclipse.jgit.http.apache
Apache httpclient support
-
org.eclipse.jgit.http.server
Server for the smart and dumb Git HTTP protocol.
-
org.eclipse.jgit.pgm
Command-line interface Git commands implemented using JGit ("pgm" stands for program).
-
org.eclipse.jgit.packaging
Production of Eclipse features and p2 repository for JGit. See the JGit Wiki on why and how to use this module.
Tests
-
org.eclipse.jgit.junit
Helpers for unit testing
-
org.eclipse.jgit.test
Unit tests for org.eclipse.jgit
-
org.eclipse.jgit.java7.test
Unit tests for Java 7 specific features
-
org.eclipse.jgit.ant.test
-
org.eclipse.jgit.pgm.test
-
org.eclipse.jgit.http.test
-
org.eclipse.jgit.junit.test
No further description needed
Warnings/Caveats
-
Native smbolic links are supported, but only if you are using Java 7 or newer and include the org.eclipse.jgit.java7 jar/bundle in the classpath, provided the file system supports them. For Windows you must have Windows Vista/Windows 2008 or newer, use a non-administrator account and have the SeCreateSymbolicLinkPrivilege.
-
Only the timestamp of the index is used by jgit if the index is dirty.
-
JGit requires at least a Java 7 JDK.
-
CRLF conversion is performed depending on the core.autocrlf setting, however Git for Windows by default stores that setting during installation in the "system wide" configuration file. If Git is not installed, use the global or repository configuration for the core.autocrlf setting.
-
The system wide configuration file is located relative to where C Git is installed. Make sure Git can be found via the PATH environment variable. When installing Git for Windows check the "Run Git from the Windows Command Prompt" option. There are other options like Eclipse settings that can be used for pointing out where C Git is installed. Modifying PATH is the recommended option if C Git is installed.
-
We try to use the same notation of $HOME as C Git does. On Windows this is often not the same value as the user.home system property.
Package Features
-
org.eclipse.jgit/
-
Read loose and packed commits, trees, blobs, including deltafied objects.
-
Read objects from shared repositories
-
Write loose commits, trees, blobs.
-
Write blobs from local files or Java InputStreams.
-
Read blobs as Java InputStreams.
-
Copy trees to local directory, or local directory to a tree.
-
Lazily loads objects as necessary.
-
Read and write .git/config files.
-
Create a new repository.
-
Read and write refs, including walking through symrefs.
-
Read, update and write the Git index.
-
Checkout in dirty working directory if trivial.
-
Walk the history from a given set of commits looking for commits introducing changes in files under a specified path.
-
Object transport Fetch via ssh, git, http, Amazon S3 and bundles. Push via ssh, git and Amazon S3. JGit does not yet deltify the pushed packs so they may be a lot larger than C Git packs.
-
Garbage collection
-
Merge
-
Rebase
-
And much more
-
-
org.eclipse.jgit.pgm/
- Assorted set of command line utilities. Mostly for ad-hoc testing of jgit log, glog, fetch etc.
-
org.eclipse.jgit.java7/
-
Support for symbolic links.
-
Optimizations for reading file system attributes
-
-
org.eclipse.jgit.ant/
- Ant tasks
-
org.eclipse.jgit.archive/
- Support for Zip/Tar and other formats
-
org.eclipse.http.*/
- HTTP client and server support
Missing Features
There are some missing features:
- gitattributes support
Support
Post question, comments or patches to the jgit-dev@eclipse.org mailing list. You need to be subscribed to post, see here:
https://dev.eclipse.org/mailman/listinfo/jgit-dev
Contributing
See the EGit Contributor Guide:
http://wiki.eclipse.org/EGit/Contributor_Guide
About Git
More information about Git, its repository format, and the canonical C based implementation can be obtained from the Git website: