README

   1             == Java GIT and Eclipse GIT plugin ==
   2
   3 Parts of this package are licensed under the LGPL and others are
   4 licensed under the EPL.  Please refer to COPYING and LICENSE for
   5 the complete licenses.  Please refer to the individual source file
   6 header to determine which license covers it.
   7
   8
   9 This package is actually composed of three major components:
  10
  11   org.spearce.jgit/
  12
  13     A pure Java library capable of being run standalone, with no
  14     additional support libraries.  Some JUnit tests are provided
  15     to exercise the library.  The library provides functions to
  16     read and write a GIT formatted repository.
  17
  18     All portions of jgit are covered by the LGPL.  Absolute no EPL
  19     contributions are accepted within this package.
  20
  21   org.spearce.egit.core/
  22
  23     An Eclipse plugin providing an interface to org.spearce.jgit
  24     and support routines to allow processing against the Eclipse
  25     workspace and resource APIs, rather than the standard Java
  26     file APIs.  It also supplies the team provider implementation.
  27
  28     Portions of this package are covered under the LGPL and others
  29     under the EPL.  Refer to individual file headers for details.
  30
  31   org.spearce.egit.ui/
  32
  33     An Eclipse plugin providing the user interface on top of
  34     org.spearce.egit.core.
  35
  36     Portions of this package are covered under the LGPL and others
  37     under the EPL.  Refer to individual file headers for details.
  38
  39
  40             == WARNINGS / CAVEATS              ==
  41
  42 - The Eclipse plugin doesn't always save the workbench state when
  43   projects get closed or the workbench is shutdown.  This means
  44   the current state of files may be lost.
  45
  46 - The plugin could lockup your Eclipse workbench.  I've tried to
  47   make it stable and function in such a way that it can't crash
  48   the workbench, but that doesn't mean it won't.  :-)
  49
  50 - This package might eat your files.  Everything I've added to a
  51   repository with it has unpacked properly both with itself and
  52   with the canonical C based implementation, but that doesn't mean
  53   it won't generate a corrupt object.
  54
  55 - This package cannot read the new loose object format header
  56   just added to canonical GIT in mid-July 2006 by Linus Torvalds.
  57   Support for that will be coming soon.
  58
  59 - This package won't damage an existing symlink stored within a
  60   repository but it can't create a new symlink from the filesystem,
  61   nor can it extract a symlink from the repository to the filesystem.
  62   This is due to Java's lack of symlink support.
  63
  64 - It may take a long time to connect the GIT team provider to an
  65   existing project full of files as the cache tree needs to be
  66   generated from scratch.  This can take a while as most Java SHA1
  67   implementations are not exactly the fastest SHA1 implementations
  68   available.
  69
  70
  71             == Package Features                ==
  72
  73   org.spearce.jgit/
  74
  75     * Read loose and packed commits, trees, blobs, including
  76       deltafied objects.
  77
  78     * Write loose commits, trees, blobs.
  79
  80     * Write blobs from local files or Java InputStreams.
  81
  82     * Read blobs as Java InputStreams.
  83
  84     * Copy trees to local directory, or local directory to a tree.
  85
  86     * Create an N-way structual difference between N trees
  87       (minimum of 2, maximum is limited only by available memory).
  88
  89     * Lazily loads trees as necessary.
  90
  91     * Read and write .git/config files.
  92
  93     * Create a new repository.
  94
  95     * Read and write refs, including walking through symrefs.
  96
  97   org.spearce.egit.core/
  98
  99     * Supplies an Eclipse team provider.
 100
 101     * Connect/disconnect the provider to a project.
 102
 103     * Search for the repositories associated with a project by
 104       autodecting the GIT repository directories.
 105
 106     * Store which repositories are tied to which containers in the
 107       Eclipse workspace.
 108
 109     * Maintains a cache tree holding a snapshot of the workspace.
 110       The cache tree is diff'd against the current `HEAD` to show
 111       file status in the decorator.
 112
 113     * Runs a checkpoint job to flush the cache tree to the repository
 114       on a periodic basis.
 115
 116     * Tracks moves/renames/deletes and reflects them in the cache
 117       tree.
 118
 119     * Resolves through linked containers.
 120
 121   org.spearce.egit.ui/
 122
 123     * Connect team provider wizard panels.
 124
 125     * Connect to GIT team provider by making a new repository.
 126
 127     * Connect to GIT team provider by searching local filesystem
 128       for existing repository directories.
 129
 130     * Team actions: track (add), untrack (remove), disconnect.
 131
 132     * Resource director shows file/directory state in the explorer
 133       various views (e.g. Navigator and Package Explorer).
 134
 135
 136             == Missing Features                ==
 137
 138 - Commit from within the Eclipse UI.
 139
 140 - Difference work file against historical version and display
 141   the difference in the Eclipse difference viewer.
 142
 143 - GIT network protocol to pull objects from a remote repository or
 144   push objects to a remote repository.
 145
 146 - Common base computation for a merge base.
 147
 148 - Generate a GIT format patch.
 149
 150 - Apply a GIT format patch.
 151
 152 - Documentation.  :-)
 153
 154
 155             == About GIT                       ==
 156
 157 More information about GIT, its repository format, and the canonical
 158 C based implementation can be obtained from the GIT websites:
 159
 160   http://git.or.cz/
 161   http://www.kernel.org/pub/software/scm/git/
 162   http://www.kernel.org/pub/software/scm/git/docs/