Skip to content

Javadoc: clarify Repository class description #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abhilasha2101 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Javadoc: clarify Repository class description #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e60f694
Docs: clarify recommended Java version for building
abhilasha2101 Jan 10, 2026
e1b0543
Javadoc: clarify Repository class description
abhilasha2101 Jan 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ __org.eclipse.jgit.junit.ssh__: Helpers for unit testing
- 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.
- While Java 11 is the minimum requirement, building JGit with newer Java versions (for example Java 25) may fail due to toolchain incompatibilities. Java **17** is recommended for a stable build.

- CRLF conversion is performed depending on the `core.autocrlf` setting,
however Git for Windows by default stores that setting during
Expand Down
5 changes: 3 additions & 2 deletions org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,9 @@
/**
* Represents a Git repository.
* <p>
* A repository holds all objects and refs used for managing source code (could
* be any type of file, but source code is what SCM's are typically used for).
* A repository holds all Git objects and references required to manage a
* project’s version history. While it can store any type of file, it is
* commonly used for source code.
* <p>
* The thread-safety of a {@link org.eclipse.jgit.lib.Repository} very much
* depends on the concrete implementation. Applications working with a generic
Expand Down