Skip to content

Commit 07e286d

Browse files
committed
Improve scripted-diff developer docs
Instead of verifying all scripted-diffs, provide an example that only verifies all scripted-diffs in commits since `origin/master.
1 parent e74649e commit 07e286d

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/developer-notes.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,16 @@ To create a scripted-diff:
827827
- `-BEGIN VERIFY SCRIPT-`
828828
- `-END VERIFY SCRIPT-`
829829

830-
The scripted-diff is verified by the tool `test/lint/commit-script-check.sh`
830+
The scripted-diff is verified by the tool `test/lint/commit-script-check.sh`. The tool's default behavior when supplied
831+
with a commit is to verify all scripted-diffs from the beginning of time up to said commit. Internally, the tool passes
832+
the first supplied argument to `git rev-list --reverse` to determine which commits to verify script-diffs for, ignoring
833+
commits that don't conform to the commit message format described above.
834+
835+
For development, it might be more convenient to verify all scripted-diffs in a range `A..B`, for example:
836+
837+
```bash
838+
test/lint/commit-script-check.sh origin/master..HEAD
839+
```
831840

832841
Commit [`bb81e173`](https://github.com/bitcoin/bitcoin/commit/bb81e173) is an example of a scripted-diff.
833842

0 commit comments

Comments
 (0)