Skip to content

Commit 96209fb

Browse files
author
Denis
committed
Documentation updated
1 parent 53c238e commit 96209fb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Pk-vcs-git is lightweight library for execute basic Git VCS operations (merge, branch create etc). It uses [pk-vcs-api](https://github.com/ProjectKaiser/pk-vcs-api) exposing IVCS implementation for Git repositories and [JGit](https://eclipse.org/jgit/) as framework to work with Git repositories.
55
Features:
66
- Branch create and remove
7-
- Branch merge returning result (success or list of conflicted files)
7+
- Branch merge with result return (success or list of conflicted files)
88
- Branch commits messages list
9-
- Summarized branch changes list
9+
- Summarized diff between branches
1010
- Branches list
1111
- File content getting and setting
1212
- File create and remove
@@ -73,7 +73,7 @@ Features:
7373
- `PK_VCS_TEST_GITHUB_PASS` environment var or JVM var is used as user password for access to Github
7474
- New Test Repository is created before each test and deletes automatically after each test
7575
- To execute tests just run GitVCSTest class as JUnit test. Tests from VCSAbstractTest class will be executed. See [pk-vcs-test](https://github.com/ProjectKaiser/pk-vcs-test) for details
76-
- NOTE: Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. 2 seconds awaiting is added for testing. Also if a test failed then try to execute it again.
76+
- NOTE: Github has some latency for exposing results of previously executed operations. For example if create a new branch and immediately check branches list then Github could return old branches list. If a test is failed then try to execute it again. Also use `GitVCS.setExpectedLatency()` to set delay for 'dangerous' operations.
7777

7878
# Limitations
7979
- Commit messages can not be attached to branch create and delete operations because Git does not exposes these operations as separate commits

0 commit comments

Comments
 (0)