README

   1             == Java GIT and Eclipse GIT plugin ==
   2
   3 Parts of this package are licensed under the BSD, and others are
   4 licensed under the EPL.  Please refer to the COPYING and LICENSE
   5 files for the complete licenses within each package, and please
   6 refer to the individual source file header to determine
   7 which license covers it.
   8
   9
  10 This package is actually composed of three major components plus
  11 three for packaging.
  12
  13   org.spearce.jgit/
  14
  15     A pure Java library capable of being run standalone, with no
  16     additional support libraries.  Some JUnit tests are provided
  17     to exercise the library.  The library provides functions to
  18     read and write a GIT formatted repository.
  19
  20     All portions of jgit are covered by the BSD.  Absolutely no GPL,
  21     LGPL or EPL contributions are accepted within this package.
  22
  23   org.spearce.jgit.test/
  24     Unit tests for org.spearce.jgit and the same licensing rules.
  25
  26   org.spearce.egit.core/
  27
  28     An Eclipse plugin providing an interface to org.spearce.jgit
  29     and support routines to allow processing against the Eclipse
  30     workspace and resource APIs, rather than the standard Java
  31     file APIs.  It also supplies the team provider implementation.
  32     Everything here is EPL.
  33
  34   org.spearce.egit.ui/
  35
  36     An Eclipse plugin providing the user interface on top of
  37     org.spearce.egit.core.
  38
  39     Everything here is EPL.
  40
  41   org.spearce.egit.core.test/
  42
  43     Unit tests for org.spearce.egit.core.
  44
  45     Everything here is EPL.
  46
  47   org.spearce.egit/
  48
  49     A plugin for packaging
  50
  51     Everything here is EPL.
  52
  53   org.spearce.egit-feature
  54
  55     Also packaging. This project is for building an Eclipse "feature"
  56     out of the plugins above.
  57
  58     Everything here is EPL.
  59
  60   org.spearce.egit-updatesite/
  61
  62     This package is for producing and update site, i.e. a web site
  63     you can point your eclipse at and just upgrade.
  64
  65     Everything here is EPL.
  66
  67             == WARNINGS / CAVEATS              ==
  68
  69 - Symbolic links are not supported because java does not support it.
  70   Such links could be damaged.
  71
  72 - Only the timestamp of the index is used by jgit check if  the index
  73   is dirty.
  74
  75 - Don't try the plugin with a JDK other than 1.6 (Java 6) unless you
  76   are prepared to investigate problems yourself. JDK 1.5.0_11 and later
  77   Java 5 versions *may* work. Earlier versions do not. JDK 1.4 is *not*
  78   supported. Apple's Java 1.5.0_07 is reported to work acceptably. We
  79   have no information about other vendors. Please report your findings
  80   if you try.
  81
  82 - CRLF conversion is never performed. On Windows you should thereforc
  83   make sure your projects and workspaces are configured to save files
  84   with Unix (LF) line endings.
  85
  86             == COMPATIBILITY                   ==
  87
  88 - Eclipse 3.4 is the minimum Eclipse version.
  89
  90 - Newer version of EGit/JGit may implement new functionality, remove
  91   existing functions and change others without other notice than what
  92   is written in the commit log and source files themselves.
  93
  94
  95             == Package Features                ==
  96
  97   org.spearce.jgit/
  98
  99     * Read loose and packed commits, trees, blobs, including
 100       deltafied objects.
 101
 102     * Read objects from shared repositories
 103
 104     * Write loose commits, trees, blobs.
 105
 106     * Write blobs from local files or Java InputStreams.
 107
 108     * Read blobs as Java InputStreams.
 109
 110     * Copy trees to local directory, or local directory to a tree.
 111
 112     * Lazily loads objects as necessary.
 113
 114     * Read and write .git/config files.
 115
 116     * Create a new repository.
 117
 118     * Read and write refs, including walking through symrefs.
 119
 120     * Read, update and write the Git index.
 121
 122     * Checkout in dirty working directory if trivial.
 123
 124     * Walk the history from a given set of commits looking for commits
 125       introducing changes in files under a specified path.
 126
 127     * Object transport
 128       Fetch via ssh, git, http, Amazon s3 and bundles.
 129       Push via ssh, git and Amazon s3. Jgit does not yet deltify the pushed
 130       packes to they may be a lot larger than C Git packs.
 131
 132   org.spearce.jgit.pgm
 133
 134     * Assorted set of command line utilities. Mostly for ad-hoc testing of jgit
 135       log, glog, fetch etc.
 136
 137   org.spearce.egit.core/
 138
 139     * Supplies an Eclipse team provider.
 140
 141     * Connect/disconnect the provider to a project.
 142
 143     * Search for the repositories associated with a project by
 144       autodetecting the GIT repository directories.
 145
 146     * Store which repositories are tied to which containers in the
 147       Eclipse workspace.
 148
 149     * Tracks moves/renames/deletes and reflects them in the cache
 150       tree.
 151
 152     * Resolves through linked containers.
 153
 154   org.spearce.egit.ui/
 155
 156     * Connect team provider wizard panels.
 157
 158     * Connect to GIT team provider by making a new repository.
 159
 160     * Connect to GIT team provider by searching local filesystem
 161       for existing repository directories.
 162
 163     * Team actions: track (add), untrack (remove), disconnect, show
 164       history, compare version.
 165
 166     * Resource decorator shows file/directory state in the package
 167       explorer and other views.
 168
 169     * Creating new commits or amending commits.
 170
 171     * Graphical history viewer with the ability to compare versions
 172       using eclipse built-in compare editor.
 173
 174      * Clone, push, fetch
 175
 176             == Missing Features                ==
 177
 178 There are a lot of missing features. You need the real Git for this.
 179 For some operations it may just be the preferred solution also. There
 180 are not just a command line, there is e.g. git-gui that makes committing
 181 partial files simple.
 182
 183 - Merging.
 184
 185 - Repacking from within the plugin.
 186
 187 - Generate a GIT format patch.
 188
 189 - Apply a GIT format patch.
 190
 191 - Documentation. :-)
 192
 193 - gitattributes support
 194   In particular CRLF conversion is not implemented. Files are treated
 195   as byte sequences.
 196
 197 - submodule support
 198   Submodules are not supported or even recognized.
 199
 200 - The Eclipse plugin cannot handle files outside any Eclipse project. You
 201   need commit changes to such files outside of Eclipse.
 202
 203             == Support                         ==
 204
 205   Post question, comments or patches to the git@vger.kernel.org mailing list.
 206
 207
 208             == Contributing                    ==
 209
 210   See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
 211   are also contributions.
 212
 213
 214             == About GIT                       ==
 215
 216 More information about GIT, its repository format, and the canonical
 217 C based implementation can be obtained from the GIT websites:
 218
 219   http://git.or.cz/
 220   http://www.kernel.org/pub/software/scm/git/
 221   http://www.kernel.org/pub/software/scm/git/docs/
 222