I couldn't figure out why Core was creating a new blocks\ dir one extra level deep
Its because the blocksdir= setting demands the parent folder. Core GUI menu option Help->Command Line Options, explains it properly
This github doc in this PR is ambiguous and should be changed
Co-authored-by: Kristaps Kaupe <kristaps@blogiem.lv>
44 | @@ -45,7 +45,7 @@ Chain option | Data directory path 45 | 46 | Subdirectory | File(s) | Description 47 | -------------------|-----------------------|------------ 48 | -`blocks/` | | Blocks directory; can be specified by `-blocksdir` option (except for `blocks/index/`) 49 | +`blocks/` | | Blocks directory; can be changed by specifying the parent dir with the `-blocksdir` option (except for `blocks/index/`)
`blocks/` | | Blocks directory; can be changed by specifying the parent directory with the `-blocksdir` option (except for `blocks/index/`)
44 | @@ -45,7 +45,7 @@ Chain option | Data directory path 45 | 46 | Subdirectory | File(s) | Description 47 | -------------------|-----------------------|------------ 48 | -`blocks/` | | Blocks directory; can be specified by `-blocksdir` option (except for `blocks/index/`) 49 | +`blocks/` | | Blocks directory; can be changed by specifying the parent directory with the `-blocksdir` option (except for `blocks/index/`)
Core GUI menu option Help->Command Line Options, explains it properly
Yes, as does ./src/bitcoind -h | grep -A3 blocksdir, which is the help documentation on how to use the -blocksdir option.
I think the vocation of files.md is to describe the role of each file/directory and not how to use configuration options, so the help docs would be the right place to maintain this information without redundancy.
Quite right that the true documentation is maintained elsewhere. But don't you agree that this doc is unclear? And if so then why not fix it? Or remove the blocksdir note altogether
NACK
Though this doc may not contain much detail about the usage of -blocksdir, it's certainly not the best place to make usage clarifications; as @jonatack has also mentioned, the file's purpose isn't explicitly for config options usage info.
If the user needs more clarity on the -blocksdir option, they can already check the usage either through ./src/bitcoind -h | grep -A3 blocksdir or Help->Command Line Options, for example.
I think that the proposed changed is more confusing. Someone reading this document will first read this https://github.com/bitcoin/bitcoin/blob/1bad29fe02096b269858b192a4a91c785a44e505/doc/files.md?plain=1#L35
Which implicitly says that the blocks directory is chain-specific. Therefore the blocksdir= is indeed specifying the general/parent/all-chains blocks directory because it must somehow separate between chains, which does by creating chain-specific folders one level deeper.
Concept 0
This file describes roles. We just shouldn't duplicate usage information across different files. As stated in the PR description, and in other reviews here, usage is already properly documented in the appropriate areas.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--174a7506f384e20aa4161008e828411d-->
No conflicts as of last run.
Closing for now due to controversy