README.txt

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