Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Improve scripted-diff developer docs #14731

Merged
merged 1 commit into from Nov 16, 2018

Conversation

Projects
None yet
4 participants
@dongcarl
Copy link
Contributor

commented Nov 15, 2018

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

doc/developer-notes.md Outdated
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 since the beginning of time. For development, it might be more convienient
to verify all scripted-diffs in commits since `origin/master`:

This comment has been minimized.

Copy link
@MarcoFalke

MarcoFalke Nov 15, 2018

Member
Suggested change
to verify all scripted-diffs in commits since `origin/master`:
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 dongcarl force-pushed the dongcarl:patch-4 branch Nov 15, 2018

@MarcoFalke MarcoFalke changed the title Improve scripted-diff developer docs doc: Improve scripted-diff developer docs Nov 15, 2018

@MarcoFalke MarcoFalke added the Docs label Nov 15, 2018

@MarcoFalke

This comment has been minimized.

Copy link
Member

commented Nov 15, 2018

ACK 2734aaf1897b1cb6c0fd73d220980fd698e1b934

@dongcarl dongcarl force-pushed the dongcarl:patch-4 branch Nov 15, 2018

@practicalswift

This comment has been minimized.

Copy link
Member

commented Nov 15, 2018

ACK 5013895bc9b63ef47462d9f6658e86520d2ac0f5 modulo typo fix

Nice documentation improvement!

doc/developer-notes.md Outdated
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 convienient to verify all scripted-diffs in a range `A..B`, for example:

This comment has been minimized.

Copy link
@practicalswift

practicalswift Nov 15, 2018

Member

Convenient :-)

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.

@dongcarl dongcarl force-pushed the dongcarl:patch-4 branch to 07e286d Nov 15, 2018

@promag

This comment has been minimized.

Copy link
Member

commented Nov 16, 2018

ACK 07e286d.

@practicalswift

This comment has been minimized.

Copy link
Member

commented Nov 16, 2018

ACK 07e286d

MarcoFalke added a commit to MarcoFalke/bitcoin that referenced this pull request Nov 16, 2018

Merge bitcoin#14731: doc: Improve scripted-diff developer docs
07e286d 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

@MarcoFalke MarcoFalke merged commit 07e286d into bitcoin:master Nov 16, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.