doc: Improve scripted-diff developer docs #14731

pull dongcarl wants to merge 1 commits into bitcoin:master from dongcarl:patch-4 changing 1 files +10 −1

dongcarl commented at 4:52 PM on November 15, 2018: member

Instead of verifying all scripted-diffs, provide an example that only verifies all scripted-diffs in commits since origin/master.

in doc/developer-notes.md:832 in d500b50ac5 outdated

 826 | @@ -827,7 +827,13 @@ To create a scripted-diff:
 827 |      - `-BEGIN VERIFY SCRIPT-`
 828 |      - `-END VERIFY SCRIPT-`
 829 |  
 830 | -The scripted-diff is verified by the tool `test/lint/commit-script-check.sh`
 831 | +The scripted-diff is verified by the tool `test/lint/commit-script-check.sh`. The tool's default behavior when supplied
 832 | +with a commit is to verify all scripted-diffs since the beginning of time. For development, it might be more convienient
 833 | +to verify all scripted-diffs in commits since `origin/master`:

MarcoFalke commented at 5:00 PM on November 15, 2018:

to verify all scripted-diffs in a range `A..B`, for example:

nit: Not sure if worth changing, but it should accept any range.

dongcarl force-pushed on Nov 15, 2018
MarcoFalke renamed this:
~~Improve scripted-diff developer docs~~
doc: Improve scripted-diff developer docs
on Nov 15, 2018
MarcoFalke added the label Docs on Nov 15, 2018
MarcoFalke commented at 5:00 PM on November 15, 2018: member

ACK 2734aaf1897b1cb6c0fd73d220980fd698e1b934
dongcarl force-pushed on Nov 15, 2018
practicalswift commented at 10:24 PM on November 15, 2018: contributor

ACK 5013895bc9b63ef47462d9f6658e86520d2ac0f5 modulo typo fix

Nice documentation improvement!

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.

07e286d940

in doc/developer-notes.md:835 in 5013895bc9 outdated

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

practicalswift commented at 11:41 PM on November 15, 2018:

Convenient :-)

dongcarl force-pushed on Nov 15, 2018
promag commented at 11:19 AM on November 16, 2018: member

ACK 07e286d.
practicalswift commented at 3:55 PM on November 16, 2018: contributor

ACK 07e286d94038f52aa3969f8d3d8c6aeab8eb3d51
MarcoFalke referenced this in commit 35739976c1 on Nov 16, 2018
MarcoFalke merged this on Nov 16, 2018
MarcoFalke closed this on Nov 16, 2018
PastaPastaPasta referenced this in commit 6dcc44ac04 on Jun 27, 2021
PastaPastaPasta referenced this in commit 58d0ed019b on Jun 28, 2021
PastaPastaPasta referenced this in commit 4e43a1e60a on Jun 29, 2021
PastaPastaPasta referenced this in commit d0647f6a37 on Jul 1, 2021
PastaPastaPasta referenced this in commit c8ac58ddbe on Jul 1, 2021
PastaPastaPasta referenced this in commit 9f42adb761 on Jul 1, 2021
UdjinM6 referenced this in commit a427e368cb on Jul 5, 2021
DrahtBot locked this on Sep 8, 2021

Contributors

Labels