Go to file
Matthias Sohn 164cb8d87d Merge branch 'stable-5.3'
* stable-5.3:
  Prepare 5.3.0-SNAPSHOT builds
  JGit v5.3.0.201903061415-rc1
  Fix error log message in ObjectDirectory.handlePackError()
  Properly format pack checksums in PackFile.idx()
  Cancel gc if thread was interrupted
  PackFile: report correct message for checksum mismatch
  ObjectDirectory: Clean up logging
  Bazel: Stop using native.git_repository
  ObjectDirectory: extra logging on packfile exceptions

Change-Id: I8c7dfd5141be0d27547d65f19054f9a1665b55fb
2019-03-07 00:25:22 +01:00
.mvn Configure max heap size for Maven build 2016-12-09 11:02:10 +01:00
Documentation/technical reftable: explicitly store update_index per ref 2017-08-21 15:39:08 -07:00
lib Implement signing commits using BouncyCastle 2019-01-16 10:05:10 +01:00
org.eclipse.jgit Track object inflation time in DfsReaderIoStats 2019-03-06 10:54:52 -08:00
org.eclipse.jgit.ant Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.ant.test Capture test coverage and add an aggregate test coverage report 2018-12-21 20:43:07 -05:00
org.eclipse.jgit.archive Prepare 5.3.0-SNAPSHOT builds 2018-12-03 02:32:49 +01:00
org.eclipse.jgit.coverage Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.http.apache Prepare 5.3.0-SNAPSHOT builds 2018-12-03 02:32:49 +01:00
org.eclipse.jgit.http.server GitSmartHttpTools: Open SideBandOutputStream in try-with-resource 2019-01-21 14:02:02 +09:00
org.eclipse.jgit.http.test SmartClientSmartServerTest: Open Repository in try-with-resource 2019-01-21 15:54:30 +09:00
org.eclipse.jgit.junit LocalDiskRepositoryTestCase#createRepository: Default auto-close to false 2019-01-20 20:09:16 +09:00
org.eclipse.jgit.junit.http HttpTestCase#fsck: Open TestRepository in try-with-resource 2019-01-20 14:52:09 +09:00
org.eclipse.jgit.junit.ssh Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.lfs Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.lfs.server LfsGson: Remove unnecessary @since tag 2018-12-20 08:33:43 +09:00
org.eclipse.jgit.lfs.server.test Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.lfs.test Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.packaging Update Orbit to R20190226160451 2019-03-06 00:41:47 +01:00
org.eclipse.jgit.pgm diff: add option metaVar for --src-prefix and --dst-prefix 2019-03-04 16:58:07 +01:00
org.eclipse.jgit.pgm.test Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.ssh.apache SshdSessionFactory: generalize providing default keys 2019-01-22 06:42:26 -05:00
org.eclipse.jgit.ssh.apache.test Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
org.eclipse.jgit.test Merge branch 'stable-5.2' 2019-03-05 10:24:34 +09:00
org.eclipse.jgit.ui Prepare 5.3.0-SNAPSHOT builds 2019-01-17 04:23:42 +01:00
tools Bazel: Stop using native.git_repository 2019-03-03 13:15:19 +09:00
.gitattributes Initial JGit contribution to eclipse.org 2009-09-29 16:47:03 -07:00
.gitignore git ignore .DS_Store 2017-07-28 11:09:47 +01:00
.mailmap Update .mailmap 2018-09-25 19:03:22 -04:00
BUILD Bazel: Support building with Java 9 2018-02-07 17:51:35 -05:00
CONTRIBUTING.md Update SUBMITTING_PATCHES 2014-07-20 17:44:53 -04:00
LICENSE Clean up LICENSE file 2010-07-02 14:52:49 -07:00
README.md Update README 2019-02-19 08:34:38 +09:00
WORKSPACE Add 4.11-staging target platform and update Orbit to I20190123233226 2019-01-27 21:04:59 +01:00
pom.xml Upgrade maven-javadoc-plugin to 3.1.0 2019-03-05 19:54:31 +09:00

README.md

Java Git

An implementation of the Git version control system in pure Java.

This project is licensed under the EDL (Eclipse Distribution License).

JGit can be imported straight into Eclipse and built and tested from there. It can be built from the command line using Maven or Bazel. The CI builds use Maven and run on Jenkins.

  • 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.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.lfs

    Support for LFS (Large File Storage).

  • org.eclipse.jgit.lfs.server

    Basic LFS server support.

  • 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.

  • org.eclipse.jgit.pgm

    Command-line interface Git commands implemented using JGit ("pgm" stands for program).

  • org.eclipse.jgit.ssh.apache

    Client support for the ssh protocol based on Apache Mina sshd.

  • org.eclipse.jgit.ui

    Simple UI for displaying git log.

Tests

  • org.eclipse.jgit.junit, org.eclipse.jgit.junit.http, org.eclipse.jgit.junit.ssh: Helpers for unit testing
  • org.eclipse.jgit.ant.test: Unit tests for org.eclipse.jgit.ant
  • org.eclipse.jgit.http.test: Unit tests for org.eclipse.jgit.http.server
  • org.eclipse.jgit.lfs.server.test: Unit tests for org.eclipse.jgit.lfs.server
  • org.eclipse.jgit.lfs.test: Unit tests for org.eclipse.jgit.lfs
  • org.eclipse.jgit.pgm.test: Unit tests for org.eclipse.jgit.pgm
  • org.eclipse.jgit.ssh.apache.test: Unit tests for org.eclipse.jgit.ssh.apache
  • org.eclipse.jgit.test: Unit tests for org.eclipse.jgit

Warnings/Caveats

  • Native symbolic links are supported, provided the file system supports them. For Windows you must 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 8 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.

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.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:

  • verifying signed commits
  • signing tags
  • signing push

Support

Post questions, comments or discussions to the jgit-dev@eclipse.org mailing list. You need to be subscribed to post. File bugs and enhancement requests in Bugzilla.

Contributing

See the 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.