README

   1             == Eclipse GIT plugin ==
   2
   3 This package is licensed under the EPL.  Please refer to the COPYING
   4 and LICENSE files for the complete licenses within each package.
   5
   6 This package is actually composed of three major components plus
   7 three for packaging.
   8
   9   org.eclipse.egit.core/
  10
  11     An Eclipse plugin providing an interface to org.eclipse.jgit
  12     and support routines to allow processing against the Eclipse
  13     workspace and resource APIs, rather than the standard Java
  14     file APIs.  It also supplies the team provider implementation.
  15
  16   org.eclipse.egit.ui/
  17
  18     An Eclipse plugin providing the user interface on top of
  19     org.eclipse.egit.core.
  20
  21   org.eclipse.egit.core.test/
  22
  23     Unit tests for org.eclipse.egit.core.
  24
  25   org.eclipse.egit/
  26
  27     A plugin for packaging
  28
  29   org.eclipse.egit-feature/
  30
  31     Also packaging. This project is for building an Eclipse "feature"
  32     out of the plugins above.
  33
  34   org.eclipse.egit-updatesite/
  35
  36     This package is for producing and update site, i.e. a web site
  37     you can point your eclipse at and just upgrade.
  38
  39             == WARNINGS / CAVEATS              ==
  40
  41 - Symbolic links are not supported because java does not support it.
  42   Such links could be damaged.
  43
  44 - Only the timestamp of the index is used by jgit check if  the index
  45   is dirty.
  46
  47 - Don't try the plugin with a JDK other than 1.6 (Java 6) unless you
  48   are prepared to investigate problems yourself. JDK 1.5.0_11 and later
  49   Java 5 versions *may* work. Earlier versions do not. JDK 1.4 is *not*
  50   supported. Apple's Java 1.5.0_07 is reported to work acceptably. We
  51   have no information about other vendors. Please report your findings
  52   if you try.
  53
  54 - CRLF conversion is never performed. On Windows you should thereforc
  55   make sure your projects and workspaces are configured to save files
  56   with Unix (LF) line endings.
  57
  58             == COMPATIBILITY                   ==
  59
  60 - Eclipse 3.4 is the minimum Eclipse version.
  61
  62 - Newer version of EGit may implement new functionality, remove
  63   existing functions and change others without other notice than what
  64   is written in the commit log and source files themselves.
  65
  66
  67             == Package Features                ==
  68
  69   org.eclipse.egit.core/
  70
  71     * Supplies an Eclipse team provider.
  72
  73     * Connect/disconnect the provider to a project.
  74
  75     * Search for the repositories associated with a project by
  76       autodetecting the GIT repository directories.
  77
  78     * Store which repositories are tied to which containers in the
  79       Eclipse workspace.
  80
  81     * Tracks moves/renames/deletes and reflects them in the cache
  82       tree.
  83
  84     * Resolves through linked containers.
  85
  86   org.eclipse.egit.ui/
  87
  88     * Connect team provider wizard panels.
  89
  90     * Connect to GIT team provider by making a new repository.
  91
  92     * Connect to GIT team provider by searching local filesystem
  93       for existing repository directories.
  94
  95     * Team actions: track (add), untrack (remove), disconnect, show
  96       history, compare version.
  97
  98     * Resource decorator shows file/directory state in the package
  99       explorer and other views.
 100
 101     * Creating new commits or amending commits.
 102
 103     * Graphical history viewer with the ability to compare versions
 104       using eclipse built-in compare editor.
 105
 106      * Clone, push, fetch
 107
 108             == Missing Features                ==
 109
 110 There are a lot of missing features. You need the real Git for this.
 111 For some operations it may just be the preferred solution also. There
 112 are not just a command line, there is e.g. git-gui that makes committing
 113 partial files simple.
 114
 115 - Merging.
 116
 117 - Repacking from within the plugin.
 118
 119 - Generate a GIT format patch.
 120
 121 - Apply a GIT format patch.
 122
 123 - Documentation. :-)
 124
 125 - gitattributes support
 126   In particular CRLF conversion is not implemented. Files are treated
 127   as byte sequences.
 128
 129 - submodule support
 130   Submodules are not supported or even recognized.
 131
 132 - The Eclipse plugin cannot handle files outside any Eclipse project. You
 133   need commit changes to such files outside of Eclipse.
 134
 135             == Support                         ==
 136
 137   Post question, comments or patches to the git@vger.kernel.org mailing list.
 138
 139
 140             == Contributing                    ==
 141
 142   See SUBMITTING_PATCHES in this directory. However, feedback and bug reports
 143   are also contributions.
 144
 145
 146             == About GIT                       ==
 147
 148 More information about GIT, its repository format, and the canonical
 149 C based implementation can be obtained from the GIT websites:
 150
 151   http://git.or.cz/
 152   http://www.kernel.org/pub/software/scm/git/
 153   http://www.kernel.org/pub/software/scm/git/docs/
 154