README

   1             == Java GIT ==
   2
   3 This package is licensed under the BSD license.
   4
   5   org.eclipse.jgit/
   6
   7     A pure Java library capable of being run standalone, with no
   8     additional support libraries.  Some JUnit tests are provided
   9     to exercise the library.  The library provides functions to
  10     read and write a GIT formatted repository.
  11
  12     All portions of jgit are covered by the BSD.  Absolutely no GPL,
  13     LGPL or EPL contributions are accepted within this package.
  14
  15   org.eclipse.jgit.test/
  16     Unit tests for org.eclipse.jgit and the same licensing rules.
  17
  18             == WARNINGS / CAVEATS              ==
  19
  20 - Symbolic links are not supported because java does not support it.
  21   Such links could be damaged.
  22
  23 - Only the timestamp of the index is used by jgit check if  the index
  24   is dirty.
  25
  26 - Don't try the library with a JDK other than 1.6 (Java 6) unless you
  27   are prepared to investigate problems yourself. JDK 1.5.0_11 and later
  28   Java 5 versions *may* work. Earlier versions do not. JDK 1.4 is *not*
  29   supported. Apple's Java 1.5.0_07 is reported to work acceptably. We
  30   have no information about other vendors. Please report your findings
  31   if you try.
  32
  33 - CRLF conversion is never performed. On Windows you should thereforc
  34   make sure your projects and workspaces are configured to save files
  35   with Unix (LF) line endings.
  36
  37             == Package Features                ==
  38
  39   org.eclipse.jgit/
  40
  41     * Read loose and packed commits, trees, blobs, including
  42       deltafied objects.
  43
  44     * Read objects from shared repositories
  45
  46     * Write loose commits, trees, blobs.
  47
  48     * Write blobs from local files or Java InputStreams.
  49
  50     * Read blobs as Java InputStreams.
  51
  52     * Copy trees to local directory, or local directory to a tree.
  53
  54     * Lazily loads objects as necessary.
  55
  56     * Read and write .git/config files.
  57
  58     * Create a new repository.
  59
  60     * Read and write refs, including walking through symrefs.
  61
  62     * Read, update and write the Git index.
  63
  64     * Checkout in dirty working directory if trivial.
  65
  66     * Walk the history from a given set of commits looking for commits
  67       introducing changes in files under a specified path.
  68
  69     * Object transport
  70       Fetch via ssh, git, http, Amazon S3 and bundles.
  71       Push via ssh, git and Amazon S3. JGit does not yet deltify
  72       the pushed packs so they may be a lot larger than C Git packs.
  73
  74   org.eclipse.jgit.pgm/
  75
  76     * Assorted set of command line utilities. Mostly for ad-hoc testing of jgit
  77       log, glog, fetch etc.
  78
  79             == Missing Features                ==
  80
  81 There are a lot of missing features. You need the real Git for this.
  82 For some operations it may just be the preferred solution also. There
  83 are not just a command line, there is e.g. git-gui that makes committing
  84 partial files simple.
  85
  86 - Merging.
  87
  88 - Repacking.
  89
  90 - Generate a GIT format patch.
  91
  92 - Apply a GIT format patch.
  93
  94 - Documentation. :-)
  95
  96 - gitattributes support
  97   In particular CRLF conversion is not implemented. Files are treated
  98   as byte sequences.
  99
 100 - submodule support
 101   Submodules are not supported or even recognized.
 102
 103             == Support                         ==
 104
 105   Post question, comments or patches to the git@vger.kernel.org mailing list.
 106
 107
 108             == Contributing                    ==
 109
 110   See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
 111   are also contributions.
 112
 113
 114             == About GIT                       ==
 115
 116 More information about GIT, its repository format, and the canonical
 117 C based implementation can be obtained from the GIT websites:
 118
 119   http://git.or.cz/
 120   http://www.kernel.org/pub/software/scm/git/
 121   http://www.kernel.org/pub/software/scm/git/docs/
 122