Skip to main content
aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorGit Development Community2009-09-29 23:47:03 +0000
committerShawn O. Pearce2009-09-29 23:47:03 +0000
commit1a6964c8274c50f0253db75f010d78ef0e739343 (patch)
treeca833cc7cf6fc8c7b9850dee258f3a356c790ffc /README
downloadjgit-1a6964c8274c50f0253db75f010d78ef0e739343.tar.gz
jgit-1a6964c8274c50f0253db75f010d78ef0e739343.tar.xz
jgit-1a6964c8274c50f0253db75f010d78ef0e739343.zip
Initial JGit contribution to eclipse.org
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 <spearce@spearce.org>
Diffstat (limited to 'README')
-rw-r--r--README122
1 files changed, 122 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000000..a39adb093f
--- /dev/null
+++ b/README
@@ -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 git@vger.kernel.org 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/
+

Back to the top