Skip to content
This repository has been archived by the owner on Oct 13, 2020. It is now read-only.

Commit

Permalink
Initial JGit contribution to eclipse.org
Browse files Browse the repository at this point in the history
Per CQ 3448 this is the initial contribution of the JGit project
to eclipse.org.  It is derived from the historical JGit repository
at commit 3a2dd9921c8a08740a9e02c421469e5b1a9e47cb.

Signed-off-by: Shawn O. Pearce <[email protected]>
  • Loading branch information
Git Development Community authored and spearce committed Sep 29, 2009
0 parents commit 1a6964c
Show file tree
Hide file tree
Showing 561 changed files with 103,222 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.java diff=java
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/jgit
/jgit.jar
/jgit_src.zip
/jgit_docs.zip
/org.eclipse.jgit/lib/jsch-*.jar
/org.eclipse.jgit.pgm/lib/args4j-*.jar
42 changes: 42 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

122 changes: 122 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
== Java GIT ==

This package is licensed under the BSD.

org.eclipse.jgit/

A pure Java library capable of being run standalone, with no
additional support libraries. Some JUnit tests are provided
to exercise the library. The library provides functions to
read and write a GIT formatted repository.

All portions of jgit are covered by the BSD. Absolutely no GPL,
LGPL or EPL contributions are accepted within this package.

org.eclipse.jgit.test/
Unit tests for org.eclipse.jgit and the same licensing rules.

== WARNINGS / CAVEATS ==

- Symbolic links are not supported because java does not support it.
Such links could be damaged.

- Only the timestamp of the index is used by jgit check if the index
is dirty.

- Don't try the library with a JDK other than 1.6 (Java 6) unless you
are prepared to investigate problems yourself. JDK 1.5.0_11 and later
Java 5 versions *may* work. Earlier versions do not. JDK 1.4 is *not*
supported. Apple's Java 1.5.0_07 is reported to work acceptably. We
have no information about other vendors. Please report your findings
if you try.

- CRLF conversion is never performed. On Windows you should thereforc
make sure your projects and workspaces are configured to save files
with Unix (LF) line endings.

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

org.eclipse.jgit.pgm/

* Assorted set of command line utilities. Mostly for ad-hoc testing of jgit
log, glog, fetch etc.

== Missing Features ==

There are a lot of missing features. You need the real Git for this.
For some operations it may just be the preferred solution also. There
are not just a command line, there is e.g. git-gui that makes committing
partial files simple.

- Merging.

- Repacking.

- Generate a GIT format patch.

- Apply a GIT format patch.

- Documentation. :-)

- gitattributes support
In particular CRLF conversion is not implemented. Files are treated
as byte sequences.

- submodule support
Submodules are not supported or even recognized.

== Support ==

Post question, comments or patches to the [email protected] mailing list.


== Contributing ==

See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
are also contributions.


== About GIT ==

More information about GIT, its repository format, and the canonical
C based implementation can be obtained from the GIT websites:

http://git.or.cz/
http://www.kernel.org/pub/software/scm/git/
http://www.kernel.org/pub/software/scm/git/docs/

Loading

0 comments on commit 1a6964c

Please sign in to comment.