Skip to content

Commit eaf2ba3

Browse files
author
Denis
committed
minor refactoring
Terms updated in arguments and documentation
1 parent 09049e9 commit eaf2ba3

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@ Also see [pk-vcs-test](https://github.com/ProjectKaiser/pk-vcs-test) project. It
3535

3636
# Using VCS interface
3737
IVCS interface consists of few basic vcs functions.
38-
Note: null passed as a branch name is considered as Master Branch. Also any branch name is considered as user-created branch within conventional place for branches: any branch except "master" for Git, any branch within "Branches" branch for SVN etc. For SVN do not use "Branches\my-branch" as branch name, use "my-branch" instead.
39-
- `void createBranch(String srcBranchPath, String dstBranchPath, String commitMessage)`
40-
- Creates a new branch with name `dstBranchPath` from the Head of `srcBranchPath`.
38+
Note: null passed as a branch name is considered as Master Branch. Any non-null branch name is considered as user-created branch within conventional place for branches: any branch except "master" for Git, any branch within "Branches" branch for SVN etc. For SVN do not use "Branches\my-branch" as branch name, use "my-branch" instead.
39+
- `void createBranch(String srcBranchName, String dstBranchName, String commitMessage)`
40+
- Creates a new branch with name `dstBranchName` from the Head of `srcBranchName`.
4141
- commitMessage is a log message which will be attached to branch create operation if it possible (e.g. Git does not posts branch create operation as a separate commit)
42-
- `VCSMergeResult merge(String srcBranchPath, String dstBranchPath, String commitMessage);`
43-
- Merge all commits from `srcBranchPath` to `dstBranchPah` with `commitMessage` attached
42+
- `VCSMergeResult merge(String srcBranchName, String dstBranchName, String commitMessage);`
43+
- Merge all commits from `srcBranchName` to `dstBranchName` with `commitMessage` attached
4444
- `VCSMergeResult.getSuccess() == true`
4545
- merge is successful
4646
- `VCSMergeResult.getSuccess() == false`
4747
- Automatic merge can not be completed due of conflicting files
4848
- `VCSMergeResult.getConflictingFiles()` contains paths to conflicting files
4949
- Heads of branches `srcBranchName` and `dstBranchName` are used
50-
- `void deleteBranch(String branchPath, String commitMessage)`
51-
- Deletes branch with path `branchPath` and attaches `commitMessage` to branch delete operation if possible (e.g. Git does not posts branch delete operation as a separate commit)
50+
- `void deleteBranch(String branchName, String commitMessage)`
51+
- Deletes branch with path `branchName` and attaches `commitMessage` to branch delete operation if possible (e.g. Git does not posts branch delete operation as a separate commit)
5252
- `void setCredentials(String user, String password)`
5353
- Applies credentials to existing IVCS implementation. I.e. first a IVCS implementation should be created, then credentials should be applied when necessary
5454
- `void setProxy(String host, int port, String proxyUser, String proxyPassword)`

src/main/java/com/projectkaiser/scm/vcs/api/IVCS.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
import com.projectkaiser.scm.vcs.api.exceptions.EVCSFileNotFound;
77

88
public interface IVCS {
9-
void createBranch(String srcBranchPath, String dstBranchPath, String commitMessage);
9+
void createBranch(String srcBranchName, String dstBranchName, String commitMessage);
1010

11-
VCSMergeResult merge(String srcBranchPath, String dstBranchPath, String commitMessage);
11+
VCSMergeResult merge(String srcBranchName, String dstBranchName, String commitMessage);
1212

13-
void deleteBranch(String branchPath, String commitMessage);
13+
void deleteBranch(String branchName, String commitMessage);
1414

1515
void setCredentials(String user, String password);
1616

0 commit comments

Comments
 (0)