doc: Deduplicate list of possible chain strings in RPC help texts #30648

pull martinsaposnic wants to merge 1 commits into bitcoin:master from martinsaposnic:202408-doc-deduplicate-chain-network-strings-rpc-help changing 4 files +8 −3

martinsaposnic commented at 5:06 PM on August 13, 2024: contributor
As mentioned in issue #30645:

Many command line parameter and RPC help texts currently contain the list of chain/network names hardcoded ("main, test, testnet4, signet, regtest"), which is error-prone as it can easily happen to miss an instance if the list ever changes again.

This PR deduplicates the list of possible chain/network strings in RPC/parameter help texts, and it creates a macro LIST_CHAIN_NAMES in src/chainparamsbase.h. In the future, there is only 1 place where that list of possible values lives, so maintainability is improved and errors are avoided.

All three places where this change impacts:
```
./bitcoin-cli --help
./bitcoin-cli help getblockchaininfo
./bitcoin-cli help getmininginfo
```
They all return the correct string "main, test, testnet4, signet, regtest"

See #30642 (review)
Deduplicate list of chain strings in RPC help texts 9b29755520
DrahtBot commented at 5:06 PM on August 13, 2024: contributor



The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Code Coverage

For detailed information about the code coverage, see the test coverage report.



Reviews

See the guideline for information on the review process.

Type Reviewers

ACK maflcko, MarnixCroes, theStack, danielabrozzoni, achow101

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
DrahtBot added the label Docs on Aug 13, 2024
maflcko commented at 7:28 AM on August 14, 2024: member

lgtm ACK 9b297555207b4ea54bc0051f09c7084797aa9def
MarnixCroes approved
MarnixCroes commented at 8:16 AM on August 14, 2024: contributor

ACK 9b297555207b4ea54bc0051f09c7084797aa9def
theStack approved
theStack commented at 10:12 AM on August 14, 2024: contributor

ACK 9b297555207b4ea54bc0051f09c7084797aa9def
danielabrozzoni approved
danielabrozzoni commented at 10:37 AM on August 14, 2024: contributor

ACK 9b297555207b4ea54bc0051f09c7084797aa9def
achow101 commented at 3:47 PM on August 14, 2024: member

ACK 9b297555207b4ea54bc0051f09c7084797aa9def
achow101 merged this on Aug 14, 2024
achow101 closed this on Aug 14, 2024
bitcoin locked this on Aug 14, 2025