Changeset View
Changeset View
Standalone View
Standalone View
doc/backporting.md
BACKPORTING | BACKPORTING | ||||
=========== | =========== | ||||
The official Bitcoin-ABC guide to keeping @deadalnix happy while backporting | The official Bitcoin-ABC guide to backporting code from Bitcoin Core. When searching | ||||
code from Bitcoin Core. | for items to backport, especially be on the lookout for bug fixes, code cleanup, and | ||||
important refactors, as these help improve Bitcoin ABC despite consensus-level differences | |||||
between Bitcoin Cash and Bitcoin Core. | |||||
Identifying commits | Identifying commits | ||||
------------------- | ------------------- | ||||
1. Check out a copy of a Satoshi Bitcoin client somewhere on your machine. | 1. Check out a copy of a Satoshi Bitcoin client somewhere on your machine. | ||||
2. Identify the subsystem you'd like to work on. | 2. Identify the subsystem you'd like to work on. | ||||
3. Tag the fork commit as `fork-commit`. Bitcoin-ABC was forked from Bitcoin Core | 3. Tag the fork commit as `fork-commit`. Bitcoin-ABC was forked from Bitcoin Core | ||||
at commit `964a185cc83af34587194a6ecda3ed9cf6b49263`. | at commit `964a185cc83af34587194a6ecda3ed9cf6b49263`. | ||||
▲ Show 20 Lines • Show All 67 Lines • ▼ Show 20 Lines | |||||
Squash the commits together for backporting | Squash the commits together for backporting | ||||
------------------------------------------- | ------------------------------------------- | ||||
1. `git checkout -b PRXXXXX` | 1. `git checkout -b PRXXXXX` | ||||
2. Perform steps 2 through 6 from "Backporting each diff individually" in repetition for each diff | 2. Perform steps 2 through 6 from "Backporting each diff individually" in repetition for each diff | ||||
in a Bitcoin Core pull request. | in a Bitcoin Core pull request. | ||||
3. `git rebase -i origin/master` and squash the commits together. | 3. `git rebase -i origin/master` and squash the commits together. | ||||
4. `arc diff` and at the bottom of the summary note: "Backport of Bitcoin Core PR# <XXXXX>". | 4. `arc diff` and at the bottom of the summary note: "Backport of Bitcoin Core PR# <XXXXX>". | ||||
The title of the diff should be: `[Backport] <Description of the included changes>` | The title of the diff should be: `[Backport] <Description of the included changes>` | ||||
No newline at end of file |