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
|
# Java Git
An implementation of the Git version control system in pure Java.
This project is licensed under the __EDL__ (Eclipse Distribution
License).
JGit can be imported straight into Eclipse and built and tested from
there. It can be built from the command line using
[Maven](https://maven.apache.org/) or [Bazel](https://bazel.build/).
The CI builds use Maven and run on [Jenkins](https://ci.eclipse.org/jgit/).
- __org.eclipse.jgit__
A pure Java library capable of being run standalone, with no
additional support libraries. It provides classes to read and
write a Git repository and operate on a working directory.
All portions of JGit are covered by the EDL. Absolutely no GPL,
LGPL or EPL contributions are accepted within this package.
- __org.eclipse.jgit.ant__
Ant tasks based on JGit.
- __org.eclipse.jgit.archive__
Support for exporting to various archive formats (zip etc).
- __org.eclipse.jgit.http.apache__
[Apache httpclient](https://hc.apache.org/httpcomponents-client-ga/) support.
- __org.eclipse.jgit.http.server__
Server for the smart and dumb
[Git HTTP protocol](https://github.com/git/git/blob/master/Documentation/technical/http-protocol.txt).
- __org.eclipse.jgit.lfs__
Support for [LFS](https://git-lfs.github.com/) (Large File Storage).
- __org.eclipse.jgit.lfs.server__
Basic LFS server support.
- __org.eclipse.jgit.packaging__
Production of Eclipse features and p2 repository for JGit. See the JGit
Wiki on why and how to use this module.
- __org.eclipse.jgit.pgm__
Command-line interface Git commands implemented using JGit
("pgm" stands for program).
- __org.eclipse.jgit.ssh.apache__
Client support for the SSH protocol based on
[Apache Mina sshd](https://mina.apache.org/sshd-project/).
- __org.eclipse.jgit.ssh.apache.agent__
Optional support for SSH agents for org.eclipse.jgit.ssh.apache.
- __org.eclipse.jgit.ui__
Simple UI for displaying git log.
## Tests
- __org.eclipse.jgit.junit__, __org.eclipse.jgit.junit.http__,
__org.eclipse.jgit.junit.ssh__: Helpers for unit testing
- __org.eclipse.jgit.ant.test__: Unit tests for org.eclipse.jgit.ant
- __org.eclipse.jgit.http.test__: Unit tests for org.eclipse.jgit.http.server
- __org.eclipse.jgit.lfs.server.test__: Unit tests for org.eclipse.jgit.lfs.server
- __org.eclipse.jgit.lfs.test__: Unit tests for org.eclipse.jgit.lfs
- __org.eclipse.jgit.pgm.test__: Unit tests for org.eclipse.jgit.pgm
- __org.eclipse.jgit.ssh.apache.test__: Unit tests for org.eclipse.jgit.ssh.apache
- __org.eclipse.jgit.test__: Unit tests for org.eclipse.jgit
## Warnings/Caveats
- Native symbolic links are supported, provided the file system supports
them. For Windows you must use a non-administrator account and have the SeCreateSymbolicLinkPrivilege.
- Only the timestamp of the index is used by JGit if the index is
dirty.
- JGit 6.0 and newer requires at least Java 11. Older versions require at least Java 1.8.
- CRLF conversion is performed depending on the `core.autocrlf` setting,
however Git for Windows by default stores that setting during
installation in the "system wide" configuration file. If Git is not
installed, use the global or repository configuration for the
core.autocrlf setting.
- The system wide configuration file is located relative to where C
Git is installed. Make sure Git can be found via the PATH
environment variable. When installing Git for Windows check the "Run
Git from the Windows Command Prompt" option. There are other options
like Eclipse settings that can be used for pointing out where C Git
is installed. Modifying PATH is the recommended option if C Git is
installed.
- We try to use the same notation of `$HOME` as C Git does. On Windows
this is often not the same value as the `user.home` system property.
## Features
- __org.eclipse.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, http, and Amazon S3. JGit does not yet deltify
the pushed packs so they may be a lot larger than C Git packs.
- Garbage collection
- Merge
- Rebase
- And much more
- __org.eclipse.jgit.pgm__
- Assorted set of command line utilities. Mostly for ad-hoc testing of jgit
log, glog, fetch etc.
- __org.eclipse.jgit.ant__
- Ant tasks
- __org.eclipse.jgit.archive__
- Support for Zip/Tar and other formats
- __org.eclipse.http__
- HTTP client and server support
## Missing Features
There are some missing features:
- signing push
- shallow and partial cloning
- support for remote helpers
- support for credential helpers
- support for multiple working trees (git-worktree)
- using external diff tools
- support for HTTPS client certificates
- SHA-256 object IDs
- git protocol V2 (client side): packfile-uris
- multi-pack index
- split index
## Support
Post questions, comments or discussions to the jgit-dev@eclipse.org mailing list.
You need to be [subscribed](https://dev.eclipse.org/mailman/listinfo/jgit-dev)
to post. File bugs and enhancement requests in
[Bugzilla](https://wiki.eclipse.org/EGit/Contributor_Guide#Filing_Bugs).
## Contributing
See the [EGit Contributor Guide](http://wiki.eclipse.org/EGit/Contributor_Guide).
## About Git
More information about Git, its repository format, and the canonical
C based implementation can be obtained from the
[Git website](http://git-scm.com/).
|
