[BTC-dev] Creating, Naming and Submitting A Patch
modsix at gmail.com
Mon Dec 1 16:40:44 UTC 2014
-----BEGIN PGP SIGNED MESSAGE-----
..::[ The Bitcoin Foundation: Creating, Naming And Submitting A Patch ]::..
[ Date: 2014.11.21 ]
[ Version: 0.0.1 ]
[ Author: mod6 [R.01] ]
0x00] Purpose: To maintain consistency and provide clarification in naming and
numerical ordering of patches to the Bitcoin reference implementation.
0x01] Creating the Patch:
When creating the patch, ensure that you have already pruned the codebase
in accordance with asciilifeform's Manifest file [R.1] and applied all of
the published patches from The Bitcoin Foundation. You may find a list
of all published patches here: [R.02]. For a guide to this process see
The Bitcoin Foundation document ``Building with Patch Files''.
With all of the patches from The Bitcoin Foundation applied, follow these
next steps to copy over the patched source so you can make the changes for
your patch and then output the diff of the changes.
cp -pr bitcoin-bitcoin-a8def6b a && cp -pr bitcoin-bitcoin-a8def6b b
Now that you have the patched source base copied into ``a'' and ``b'':
Now you should make your changes to the code as necessary.
0x02] Naming and Numbering the Patch:
[ NOTE ]:
This document supersedes the previously published announcement about
how to properly name your patch. The previously described
nomenclature was lacking a numbering scheme; this is important as
all patches are required to be applied in specific order.
Once the code changes are complete, create a diff of the changes:
diff -uNr a b > \
diff -uNr a b > \
0x03] Signing the Patch:
The Bitcoin Foundation requires that you use a GnuPG Detached Signature
to sign your patch file.
Sign the patch file as follows:
gpg --output <your_patch_file>.sig --detach-sig <your_patch_file>
gpg --output bitcoin-v0_5_3-test_patch.5.patch.sig \
0x04] Submitting the Patch
To send your patch(s) to the BTC-Dev [R.05] mailing list, first you need
to create a GPG signed message and then attach your patch file(s) and
your detached signature files to the email.
[ NOTE ]:
The BTC-Dev mailing list will not relay any messages unless they are
signed by GPG keys associated with #bitcoin-otc WoT [R.06] identities
with positive trust from the ``assbot'' entity in the WoT.
The BTC-dev [R.05] mailing list won't broadcast messages that aren't GPG
signed with a GPG key in the #bitcoin-otc WoT [R.06]. Your submission
must be signed with a key that has positive ratings with respect
to `assbot`'s L2 [R.07].
Read more about this here: [R.08].
[ References ]:
[R.01] 027A 8D7C 0FB8 A166 4372 0F40 7217 05A8 B71E ADAF
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.13 (FreeBSD)
-----END PGP SIGNATURE-----
More information about the BTC-dev