Skip to content

Commit

Permalink
added docu to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cecom committed Mar 15, 2019
1 parent b435c5a commit b094f05
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,11 @@ then run the `git merge-file` command (which is used by the default merge driver
*merge* Command *ADVANCED* Usage
------------
It is also possible to write your own *Rule* for conflict resolution. Currently there are two
implemented rules:
It is also possible to write your own *Rule* for conflict resolution. Currently there are three implemented rules:
- de.oppermann.pomutils.rules.ProjectAndParentVersionRule
- de.oppermann.pomutils.rules.PropertyRule
- de.oppermann.pomutils.rules.ScmTagRule
If you don't specify `--ruleset` on command line the *de.oppermann.pomutils.rules.ProjectAndParentVersionRule*
rule is used. But if you want e.g. to resolve conflicts on maven properties too, or want
Expand All @@ -127,6 +127,10 @@ to evaluate your own rule, you have to create a ruleset configuration file. This
- foobar.version
propertiesRegex: # resolves properties in the global and profile property section matching regex expression, using the *OUR* strategy
- .+\.version
--- !!de.oppermann.pomutils.rules.ScmTagRule
strategy: OUR # possible values: OUR|THEIR
# resolves the <scm><tag>...</tag></scm> element conflicts, using the *OUR* strategy
Basically you define the rules which should be used by adding the implementation class of the rule with *--- !!*,
followed by the configuration. If you want to write your own rule, have a look at the implemented ones and perhaps send
Expand Down

0 comments on commit b094f05

Please sign in to comment.