Skip to content

Commit 4043391

Browse files
authored
Update README.md
1 parent 17e49f7 commit 4043391

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Use cases
2626
# Terms
2727
- Workspace Home
2828
- Home local folder of all folders used by vcs-related operations. See [scm4j-vcs-api](https://github.com/scm4j/scm4j-vcs-api) for details
29-
- Locked Working Copy,
29+
- Locked Working Copy, LWC
3030
- Local folder where vcs-related operations are executed. Provides thread- and process-safe repository of working folders. See [scm4j-vcs-api](https://github.com/scm4j/scm4j-vcs-api) for details
3131
- Test Repository
3232
- Git repository which is used to execute functional tests
@@ -51,7 +51,7 @@ Use cases
5151
Or download release jars from https://github.com/scm4j/scm4j-vcs-git/releases
5252
- Code snippet
5353
```java
54-
public static final String WORKSPACE_DIR = System.getProperty("java.io.tmpdir") + "git-workspaces";
54+
final String WORKSPACE_DIR = System.getProperty("java.io.tmpdir") + "git-workspaces";
5555
IVCSWorkspace workspace = new VCSWorkspace(WORKSPACE_DIR);
5656
String repoUrl = "https://github.com/MyUser/MyRepo";
5757
IVCSRepositoryWorkspace repoWorkspace = workspace.getVCSRepositoryWorkspace(repoUrl);
@@ -66,13 +66,13 @@ Use cases
6666
- [JGit](https://eclipse.org/jgit/) is used as framework to work with Git repositories
6767
- Each vcs operation is executed within a LWC
6868
- `getLocalGit(IVCSLockedWorkingCopy wc)` method is used to create a Git implementation to execute vcs operations within `wc` Working Copy
69-
- If provided LWC is empty then current Test Repository is cloned into this LWC, otherwise existing repository is just switched to required branch
69+
- If provided LWC is empty then current Test Repository is cloned into this LWC, otherwise existing repository is just switched to the required branch
7070
- If `IVCS.setProxy()` is called then provided proxy is used for each url which contains `repoUrl`
7171

7272
# Functional testing
7373
- New local file-based Test Repository is created before each test and deletes automatically after each test
7474
- To execute tests just run GitVCSTest class as JUnit test. Tests from VCSAbstractTest class will be executed. See [scm4j-vcs-test](https://github.com/scm4j/scm4j-vcs-test) for details
75-
- Run `gradle test` to execute tests
75+
- Or run `gradle test` to execute tests
7676

7777
# Limitations
78-
- Commit messages can not be attached to branch create and delete operations because Git does not exposes these operations as separate commits
78+
- Commit messages can not be attached to branch create and delete operations because Git does not expose these operations as separate commits

0 commit comments

Comments
 (0)