Makefile: add gitlint internals note

oasisprotocol · Feb 24, 2020 · 978cc33 · 978cc33
1 parent 400f73d
commit 978cc33
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -66,6 +66,8 @@ lint-targets := lint-go lint-git lint-md lint-changelog
 lint-go:
 	@$(MAKE) -C go lint
 
+# NOTE: gitlint internally uses git rev-list, where A..B is asymmetric difference, which is kind of the opposite of
+# how git diff interprets A..B vs A...B.
 lint-git: fetch-git
 	@COMMIT_SHA=`git rev-parse $(OASIS_CORE_GIT_ORIGIN_REMOTE)/$(RELEASE_BRANCH)` && \
 	echo "Running gitlint for commits from $(OASIS_CORE_GIT_ORIGIN_REMOTE)/$(RELEASE_BRANCH) ($${COMMIT_SHA:0:7})..."; \