diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2018-11-16 11:20:53 -0500 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2018-11-16 11:21:28 -0500 |
| commit | 35739976c1d9ad250ece573980c57e7e7976ae23 (patch) | |
| tree | cfdd073fed0d7edbd02488d2509079022206a93c | |
| parent | 384967f311b4c6b1d6c797f7821d25feb26bafbf (diff) | |
| parent | 07e286d94038f52aa3969f8d3d8c6aeab8eb3d51 (diff) | |
Merge #14731: doc: Improve scripted-diff developer docs
07e286d940 Improve scripted-diff developer docs (Carl Dong)
Pull request description:
Instead of verifying all scripted-diffs, provide an example that only verifies all scripted-diffs in commits since `origin/master`.
Tree-SHA512: 2faecfd1df04046c77ca2b7426675265f7ed656b2b7e2714ae61c0a38b3ea239f35d2be6d615c5191a21f3a453e37f6a4622bd4558173b768cb73183b56c4d62
| -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. |