Go to file
Matthias Sohn c177c6f4c5 Merge branch 'master' into stable-5.4
* master:
  Handle missing "ours" stage in WorkingTreeIterator.hasCrLfInIndex()
  Config: Add helper method to check for empty value
  ErrorProne: Increase severity of FutureReturnValueIgnored to ERROR
  FS_Win32: Add missing parentheses on if-blocks
  Upgrade spotbugs to 3.1.12
  Abbreviated{Long}ObjectId: Make operator precedence explicit
  GC: Update TODO comments
  FS_POSIX: Fix reference comparison of Boolean.FALSE
  Increase bazel timeout for long running tests
  Use bazelisk to switch between used bazel version
  Bump minimum Bazel version to 0.26.1
  Bazel: Bump skylib library version to 0.8.0
  Retry loading config when locked by another process
  Make pull --rebase on an unborn branch do a checkout
  Warn if configured cookie file is missing
  Handle escaped CR-LF in git config files
  DescribeCommand: use glob match instead of path match
  Fix off-by-one error in RebaseTodoFile when reading a todo file
  Consistently use "!isEmpty()" to detect non-empty list
  TransportHttp: Check for non-empty list with "!isEmpty()" rather than
    "size() > 0"
  TransportHttp: Fix comparison of size with ">= 0"
  NetscapeCookieFileTest: Split HttpCookiesMatcher to own class
  Bazel: Add missing dependency on mockito for TransportHttpTest
  Determine hard-linking and nlink support per FileStore
  Support reading and writing cookies.
  Repository: Add getIdentifier() method to avoid instanceof operator
  Update to Orbit R20190602212107
  PacketLineIn: Deprecate the END constant
  PacketLineIn: Add an iterator over strings in the input stream
  Replace most usages of PacketLineIn.END with PacketLineIn.end()
  PacketLineIn: Deprecate DELIM constant
  Replace trivial reference comparison of PacketLineIn.{DELIM,END}
  PacketLineIn: Rename isDelim to isDelimiter
  ProtocolV2ParserTest: Fix typo in comment
  Upgrade Bouncy Castle to 1.61
  Update to Orbit R20190531194818 and rollback update to Ant 1.10.6
  cli: Add the --always option to describe
  DescribeCommand: Support the "always" option
  cli: Add the --tags option to describe
  DescribeCommand: Consistenly omit the default value
  Remove excess blank line in FileUtilsTest
  PacketLineIn: Add helper methods to check for END and DELIM
  UploadPackTest: Rename variable to avoid hiding class member
  UploadPackTest: Add missing <> operator on instantiation of ArrayList
  BitmapCalculator: javadoc fixes
  RevWalkUtils: add progress callback to findBranchesReachableFrom
  Upgrade maven-source-plugin to 3.1.0
  Upgrade maven-jar-plugin to 3.1.2
  Upgrade jacoco-maven-plugin to 0.8.4
  BitmapCalculator and its test: add missing license header
  RevWalk: new method createReachabilityChecker()

Change-Id: I4d76c7c0dbe6411c842f3468b709f7df51789c08
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
2019-06-11 23:30:26 +02: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 Bazel: Simplify names of bouncy castle libraries 2019-05-16 19:04:40 +02:00
org.eclipse.jgit Merge branch 'master' into stable-5.4 2019-06-11 23:30:26 +02:00
org.eclipse.jgit.ant Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.ant.test Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.archive Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.coverage Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.http.apache Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.http.server Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.http.test Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.junit Merge branch 'stable-5.3' into stable-5.4 2019-06-06 17:14:31 +02:00
org.eclipse.jgit.junit.http Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.junit.ssh Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.lfs Abbreviated{Long}ObjectId: Make operator precedence explicit 2019-06-11 10:37:18 +09:00
org.eclipse.jgit.lfs.server Consistently use "!isEmpty()" to detect non-empty list 2019-06-07 12:12:44 +09:00
org.eclipse.jgit.lfs.server.test ErrorProne: Increase severity of FutureReturnValueIgnored to ERROR 2019-06-11 10:51:30 +09:00
org.eclipse.jgit.lfs.test Merge branch 'stable-5.3' into stable-5.4 2019-06-06 17:14:31 +02:00
org.eclipse.jgit.packaging Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.pgm Consistently use "!isEmpty()" to detect non-empty list 2019-06-07 12:12:44 +09:00
org.eclipse.jgit.pgm.test Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.ssh.apache Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.ssh.apache.test Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
org.eclipse.jgit.test Merge branch 'master' into stable-5.4 2019-06-11 23:30:26 +02:00
org.eclipse.jgit.ui Prepare 5.3.3-SNAPSHOT builds 2019-06-05 23:35:14 +02:00
tools Merge branch 'master' into stable-5.4 2019-06-11 23:30:26 +02:00
.bazelrc Enable error-prone checks by default 2019-05-26 17:47:08 +09:00
.bazelversion Use bazelisk to switch between used bazel version 2019-06-10 20:44:51 +02:00
.gitattributes Initial JGit contribution to eclipse.org 2009-09-29 16:47:03 -07:00
.gitignore .gitignore: remove editor- and OS-specific files 2019-04-01 13:38:00 -07: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 Bump minimum Bazel version to 0.26.1 2019-06-10 20:44:51 +02:00
pom.xml Upgrade spotbugs to 3.1.12 2019-06-11 10:37:18 +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.