You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 4.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. Java Git
  2. ========
  3. An implementation of the Git version control system in pure Java.
  4. This package is licensed under the EDL (Eclipse Distribution
  5. License).
  6. JGit can be imported straight into Eclipse, built and tested from
  7. there, but the automated builds use Maven.
  8. - org.eclipse.jgit
  9. A pure Java library capable of being run standalone, with no
  10. additional support libraries. It provides classes to read and
  11. write a Git repository and operate on a working directory.
  12. All portions of JGit are covered by the EDL. Absolutely no GPL,
  13. LGPL or EPL contributions are accepted within this package.
  14. - org.eclipse.jgit.java7
  15. Extensions for users of Java 7.
  16. - org.eclipse.jgit.ant
  17. Ant tasks based on JGit.
  18. - org.eclipse.jgit.archive
  19. Support for exporting to various archive formats (zip etc).
  20. - org.eclipse.jgit.http.apache
  21. Apache httpclient support
  22. - org.eclipse.jgit.http.server
  23. Server for the smart and dumb Git HTTP protocol.
  24. - org.eclipse.jgit.pgm
  25. Command-line interface Git commands implemented using JGit
  26. ("pgm" stands for program).
  27. - org.eclipse.jgit.packaging
  28. Production of Eclipse features and p2 repository for JGit. See the JGit
  29. Wiki on why and how to use this module.
  30. Tests
  31. -----
  32. - org.eclipse.jgit.junit
  33. Helpers for unit testing
  34. - org.eclipse.jgit.test
  35. Unit tests for org.eclipse.jgit
  36. - org.eclipse.jgit.java7.test
  37. Unit tests for Java 7 specific features
  38. - org.eclipse.jgit.ant.test
  39. - org.eclipse.jgit.pgm.test
  40. - org.eclipse.jgit.http.test
  41. - org.eclipse.jgit.junit.test
  42. No further description needed
  43. Warnings/Caveats
  44. ----------------
  45. - Native smbolic links are supported, but only if you are using Java 7
  46. or newer and include the org.eclipse.jgit.java7 jar/bundle in the
  47. classpath, provided the file system supports them. For Windows you
  48. must have Windows Vista/Windows 2008 or newer, use a
  49. non-administrator account and have the SeCreateSymbolicLinkPrivilege.
  50. - Only the timestamp of the index is used by jgit if the index is
  51. dirty.
  52. - JGit requires at least a Java 7 JDK.
  53. - CRLF conversion is performed depending on the core.autocrlf setting,
  54. however Git for Windows by default stores that setting during
  55. installation in the "system wide" configuration file. If Git is not
  56. installed, use the global or repository configuration for the
  57. core.autocrlf setting.
  58. - The system wide configuration file is located relative to where C
  59. Git is installed. Make sure Git can be found via the PATH
  60. environment variable. When installing Git for Windows check the "Run
  61. Git from the Windows Command Prompt" option. There are other options
  62. like Eclipse settings that can be used for pointing out where C Git
  63. is installed. Modifying PATH is the recommended option if C Git is
  64. installed.
  65. - We try to use the same notation of $HOME as C Git does. On Windows
  66. this is often not the same value as the user.home system property.
  67. Package Features
  68. ----------------
  69. - org.eclipse.jgit/
  70. * Read loose and packed commits, trees, blobs, including
  71. deltafied objects.
  72. * Read objects from shared repositories
  73. * Write loose commits, trees, blobs.
  74. * Write blobs from local files or Java InputStreams.
  75. * Read blobs as Java InputStreams.
  76. * Copy trees to local directory, or local directory to a tree.
  77. * Lazily loads objects as necessary.
  78. * Read and write .git/config files.
  79. * Create a new repository.
  80. * Read and write refs, including walking through symrefs.
  81. * Read, update and write the Git index.
  82. * Checkout in dirty working directory if trivial.
  83. * Walk the history from a given set of commits looking for commits
  84. introducing changes in files under a specified path.
  85. * Object transport
  86. Fetch via ssh, git, http, Amazon S3 and bundles.
  87. Push via ssh, git and Amazon S3. JGit does not yet deltify
  88. the pushed packs so they may be a lot larger than C Git packs.
  89. * Garbage collection
  90. * Merge
  91. * Rebase
  92. * And much more
  93. - org.eclipse.jgit.pgm/
  94. * Assorted set of command line utilities. Mostly for ad-hoc testing of jgit
  95. log, glog, fetch etc.
  96. - org.eclipse.jgit.java7/
  97. * Support for symbolic links.
  98. * Optimizations for reading file system attributes
  99. - org.eclipse.jgit.ant/
  100. * Ant tasks
  101. - org.eclipse.jgit.archive/
  102. * Support for Zip/Tar and other formats
  103. - org.eclipse.http.*/
  104. * HTTP client and server support
  105. Missing Features
  106. ----------------
  107. There are some missing features:
  108. - gitattributes support
  109. Support
  110. -------
  111. Post question, comments or patches to the jgit-dev@eclipse.org mailing list.
  112. You need to be subscribed to post, see here:
  113. https://dev.eclipse.org/mailman/listinfo/jgit-dev
  114. Contributing
  115. ------------
  116. See the EGit Contributor Guide:
  117. http://wiki.eclipse.org/EGit/Contributor_Guide
  118. About Git
  119. ---------
  120. More information about Git, its repository format, and the canonical
  121. C based implementation can be obtained from the Git website:
  122. http://git-scm.com/