search

chaincodelabs / onboarding-to-bitcoin-core

The missing onboarding guide to Bitcoin Core
https://bitcoincore.academy
91 stars 37 forks source link

Chapter 3 - Add link to PR that renames CChainState #45

Closed satsie closed 2 years ago

satsie commented 2 years ago

Chapter 3: The Multiple Chains section talks about the CChainState data structure, however it will be renamed to Chainstate in v24.0 per PR #24513.

I know this book explicitly states that it's written with v23.0 as a reference, but readers may be pointing to a more recent copy of the code, especially if they are periodically revisiting this book in between other activities like PR review. If they try to grep the code base for 'CChainState', they probably won't find anything. Maybe release notes if they are lucky?

The PR also has a delightful description and reviewing it is probably a good exercise for beginners in understanding the implications of a large renaming PR like this.

I understand it is simpler to leave this out, but I think there is a case to be made for mentioning the rename!

willcl-ark commented 2 years ago

Also happy to add this, although it is alluded to in the General Design Principles tip box ;)

satsie commented 2 years ago

Omg I totally forgot about this! Good point :+1: