This is an automated email from the ASF dual-hosted git repository.
mcvsubbu pushed a commit to branch improv-compat
in repository https://gitbox.apache.org/repos/asf/incubator-pinot.git
commit 401fa5cd4617b21e57103f106c1479eb63a6a49a
Author: Subbu Subramaniam <ssubr...@linkedin.com>
AuthorDate: Sat Jun 5 19:12:44 2021 -0700
Updated README.md
---
compatibility-verifier/README.md | 17 ++++++++++++++---
1 file changed, 14 insertions(+), 3 deletions(-)
diff --git a/compatibility-verifier/README.md b/compatibility-verifier/README.md
index 1c7090b..209ae09 100644
--- a/compatibility-verifier/README.md
+++ b/compatibility-verifier/README.md
@@ -25,10 +25,21 @@
### Step 1: checkout source code and build targets for older commit and newer
commit
```shell
-./compatibility-verifier/checkoutAndBuild.sh -o olderCommit -n newerCommit [-w
workingDir]
+Usage: checkoutAndBuild.sh [-o olderCommit] [-n newerCommit] -w workingDir
+ -w, --working-dir Working directory where olderCommit
and newCommit target files reside
+
+ -o, --old-commit-hash git hash (or tag) for old commit
+
+ -n, --new-commit-hash git hash (or tag) for new commit
+
+If -n is not specified, then current commit is assumed
+If -o is not specified, then previous commit is assumed (expected -n is also
empty)
+Examples:
+ To compare this checkout with previous commit: 'checkoutAndBuild.sh -w
/tmp/wd'
+ To compare this checkout with some older tag or hash: 'checkoutAndBuild.sh
-o release-0.7.1 -w /tmp/wd'
+ To compare any two previous tags or hashes: 'checkoutAndBuild.sh -o
release-0.7.1 -n 637cc3494 -w /tmp/wd
+
```
-***NOTE***: `[workingDir]` is optional, if user does not specify
`[workingDir]`, the script will create a temporary working
-dir and output the path, which can be used in step 2.
### Step 2: run compatibility regression test against the two targets build in
step1
```shell
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org
