Go to file
Thomas Wolf 6aa29d1166 Better git system config finding
We've used "GIT_EDITOR=edit git config --system --edit" to determine
the location of the git system config for a long time. But git 2.34.0
always expects this command to have a tty, but there isn't one when
called from Java. If there isn't one, the Java process may get a
SIGTTOU from the child process and hangs.

Arguably it's a bug in C git 2.34.0 to unconditionally assume there
was a tty. But JGit needs a fix *now*, otherwise any application using
JGit will lock up if git 2.34.0 is installed on the machine.

Therefore, use a different approach if the C git found is 2.8.0 or
newer: parse the output of

  git config --system --show-origin --list -z

"--show-origin" exists since git 2.8.0; it prefixes the values with
the file name of the config file they come from, which is the system
config file for this command. (This works even if the first item in
the system config is an include.)

Bug: 577358
Change-Id: I3ef170ed3f488f63c3501468303119319b03575d
Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>
(cherry picked from commit 9446e62733)
2021-11-23 19:42:34 +01:00
.mvn Configure max heap size for Maven build 2016-12-09 11:02:10 +01:00
.settings Add resource preferences for top level jgit project 2019-12-16 11:20:12 +01:00
Documentation Document gc and pack relevant options 2020-04-03 11:50:27 +09:00
lib Decouple JSch from JGit Core 2020-06-01 01:46:59 +02:00
org.eclipse.jgit Better git system config finding 2021-11-23 19:42:34 +01:00
org.eclipse.jgit.ant Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
org.eclipse.jgit.ant.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.archive Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
org.eclipse.jgit.benchmarks Fix running benchmarks from bazel 2021-09-27 16:50:15 +02:00
org.eclipse.jgit.coverage Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.gpg.bc Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.gpg.bc.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.http.apache Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
org.eclipse.jgit.http.server GitServlet: allow to override default error handlers 2021-09-01 15:25:30 +02:00
org.eclipse.jgit.http.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.junit Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
org.eclipse.jgit.junit.http Merge branch 'stable-5.8' into stable-5.9 2021-07-29 13:10:16 +02:00
org.eclipse.jgit.junit.ssh Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.lfs Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.lfs.server Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
org.eclipse.jgit.lfs.server.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.lfs.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.packaging Fix target platforms 2021-11-03 22:41:33 +01:00
org.eclipse.jgit.pgm Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
org.eclipse.jgit.pgm.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.ssh.apache Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.ssh.apache.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.ssh.jsch Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.ssh.jsch.test Ignore missing javadoc in test bundles 2021-06-24 23:14:13 +02:00
org.eclipse.jgit.test Fix missing peel-part in lsRefsV2 for loose annotated tags 2021-10-15 22:29:28 +02:00
org.eclipse.jgit.ui Prepare 5.1.17-SNAPSHOT builds 2021-06-05 00:45:08 +02:00
tools Bazel: Add workspace status command to stamp final artifact 2020-07-17 01:10:15 +02:00
.bazelrc Bazel: Add workspace status command to stamp final artifact 2020-07-17 01:10:15 +02:00
.bazelversion Update bazlets and bazel version 2021-05-14 23:37:43 +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 [Java 11] Remove dependency on javax.xml.bind package 2019-06-18 02:22:21 +02: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 Merge branch 'stable-5.4' into stable-5.5 2021-06-05 22:49:56 +02:00
pom.xml Merge branch 'stable-5.7' into stable-5.8 2021-10-08 00:33:33 +02: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.