Refactor bundle transport to permit streaming from application
[egit/fonseca.git] / README
blob424f7a33aee97aae990d293bb149d1fa648950c0
1             == Java GIT and Eclipse GIT plugin ==
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.
10 This package is actually composed of three major components plus
11 three for packaging.
13   org.spearce.jgit/
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.
20     All portions of jgit are covered by the BSD.  Absolutely no GPL,
21     LGPL or EPL contributions are accepted within this package.
23   org.spearce.jgit.test/
24     Unit tests for org.spearce.jgit and the same licensing rules.
26   org.spearce.egit.core/
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.
34   org.spearce.egit.ui/
36     An Eclipse plugin providing the user interface on top of
37     org.spearce.egit.core.
39     Everything here is EPL.
41   org.spearce.egit.core.test/
43     Unit tests for org.spearce.egit.core.
45     Everything here is EPL.
47   org.spearce.egit/
49     A plugin for packaging
51     Everything here is EPL.
53   org.spearce.egit-feature
55     Also packaging. This project is for building an Eclipse "feature"
56     out of the plugins above.
58     Everything here is EPL.
60   org.spearce.egit-updatesite/
62     This package is for producing and update site, i.e. a web site
63     you can point your eclipse at and just upgrade.
65     Everything here is EPL.
67             == WARNINGS / CAVEATS              ==
69 - Symbolic links are not supported because java does not support it.
70   Such links could be damaged.
72 - Only the timestamp of the index is used by jgit check if  the index
73   is dirty.
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.
82             == COMPATIBILITY                   ==
84 - Eclipse 3.3.1 is the minimum Eclipse version, 3.4 is preferred.
86 - Newer version of EGit/JGit may implement new functionality, remove
87   existing functions and change others without other notice than what
88   is written in the commit log and source files themselves.
91             == Package Features                ==
93   org.spearce.jgit/
95     * Read loose and packed commits, trees, blobs, including
96       deltafied objects.
98     * Read objects from shared repositories
100     * Write loose commits, trees, blobs.
102     * Write blobs from local files or Java InputStreams.
104     * Read blobs as Java InputStreams.
106     * Copy trees to local directory, or local directory to a tree.
108     * Lazily loads objects as necessary.
110     * Read and write .git/config files.
112     * Create a new repository.
114     * Read and write refs, including walking through symrefs.
116     * Read, update and write the Git index.
118     * Checkout in dirty working directory if trivial.
120     * Walk the history from a given set of commits looking for commits
121       introducing changes in files under a specified path.
123   org.spearce.egit.core/
125     * Supplies an Eclipse team provider.
127     * Connect/disconnect the provider to a project.
129     * Search for the repositories associated with a project by
130       autodetecting the GIT repository directories.
132     * Store which repositories are tied to which containers in the
133       Eclipse workspace.
135     * Tracks moves/renames/deletes and reflects them in the cache
136       tree.
138     * Resolves through linked containers.
140   org.spearce.egit.ui/
142     * Connect team provider wizard panels.
144     * Connect to GIT team provider by making a new repository.
146     * Connect to GIT team provider by searching local filesystem
147       for existing repository directories.
149     * Team actions: track (add), untrack (remove), disconnect, show
150       history, compare version.
152     * Resource decorator shows file/directory state in the package
153       explorer and other views.
155     * Creating new commits or amending commits.
157     * Graphical history viewer with the ability to compare versions
158       using eclipse built-in compare editor.
160             == Missing Features                ==
162 There are a lot of missing features. You need the real Git for this.
163 For some operations it may just be the preferred solution also. There
164 are not just a command line, there is e.g. git-gui that makes committing
165 partial files simple.
167 - Merging. 
169 - Repacking from within the plugin.
171 - Generate a GIT format patch.
173 - Apply a GIT format patch.
175 - Documentation. :-)
177 - gitattributes support
178   In particular CRLF conversion is not implemented. Files are treated
179   as byte sequences.
181 - submodule support
182   Submodules are not supported or even recognized.
184 - The Eclipse plugin cannot handle files outside any Eclipse project. You
185   need commit changes to such files outside of Eclipse.
187             == Support                         ==
189   Post question, comments or patches to the git@vger.kernel.org mailing list.
192             == Contributing                    ==
194   See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
195   are also contributions.
198             == About GIT                       ==
200 More information about GIT, its repository format, and the canonical
201 C based implementation can be obtained from the GIT websites:
203   http://git.or.cz/
204   http://www.kernel.org/pub/software/scm/git/
205   http://www.kernel.org/pub/software/scm/git/docs/