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

Already on GitHub? Sign in to your account

Dev Docs: drop mention of endianness in hash byte order #1105

Merged
merged 2 commits into from Oct 30, 2015

Conversation

Projects
None yet
2 participants
Contributor

harding commented Oct 23, 2015

This tries to quickly solve some of the issues raised in #1061 and #1102 about the description of endianness in the hash byte order text.

In my opinion, simply thinking about hashes as having endianness tends to confuse developers, since hashes are usually treated as byte arrays rather than numbers. This PR simply drops the references to endianness in the hopes of minimizing confusion to new developers as well as allowing established developers to spend less time arguing about whether header hashes in Bitcoin are little or big endian.

I'm 100% open to a better patch that describes all the relevant considerations so far discussed, although I think it might be better to put that on the Wiki and then link to it from here. (That's a suggestion; feel free to PR it here if you think it's important.)

Screenshot of the revised section:

2015-10-23-100237_615x874_scrot

Dev docs: byte ordering and endian clarifications
Cherry picked and edited from: 9f1885b
Contributor

harding commented Oct 28, 2015

@mruddy cherry-picked and adjusted your commit https://github.com/mruddy/bitcoin.org/commit/9f1885beae3e1f32b2072be2501fb5d6154ee3d8 to this PR. Please let me know if that looks ok.

Current rendered section:

2015-10-28-114739_619x876_scrot

Contributor

mruddy commented Oct 28, 2015

LGTM.
I'll go close my PR #1102.

Contributor

harding commented Oct 28, 2015

@mruddy thanks!

In the absence of critical feedback, this PR will we merged on Friday.

@harding harding merged commit c23a311 into bitcoin-dot-org:master Oct 30, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

harding added a commit that referenced this pull request Oct 30, 2015

Merge pulls #1105 and #1118
- #1105: Dev Docs: drop mention of endianness in hash byte order
- #1118: Dev Docs: update v4 blocks text; mention version bits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment