diff options
| author | Carl Dong <accounts@carldong.me> | 2018-11-15 08:52:01 -0800 |
|---|---|---|
| committer | Carl Dong <accounts@carldong.me> | 2018-11-15 15:45:48 -0800 |
| commit | 07e286d94038f52aa3969f8d3d8c6aeab8eb3d51 (patch) | |
| tree | 337219cf1a2e73bd0ea3c44e881734c79d5b7eba /doc | |
| parent | e74649e95122c9c61aadf607461cf701c3953f88 (diff) | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index fd5cc78297..bb477d4be0 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -827,7 +827,16 @@ To create a scripted-diff: - `-BEGIN VERIFY SCRIPT-` - `-END VERIFY SCRIPT-` -The scripted-diff is verified by the tool `test/lint/commit-script-check.sh` +The scripted-diff is verified by the tool `test/lint/commit-script-check.sh`. The tool's default behavior when supplied +with a commit is to verify all scripted-diffs from the beginning of time up to said commit. Internally, the tool passes +the first supplied argument to `git rev-list --reverse` to determine which commits to verify script-diffs for, ignoring +commits that don't conform to the commit message format described above. + +For development, it might be more convenient to verify all scripted-diffs in a range `A..B`, for example: + +```bash +test/lint/commit-script-check.sh origin/master..HEAD +``` Commit [`bb81e173`](https://github.com/bitcoin/bitcoin/commit/bb81e173) is an example of a scripted-diff. |