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