I noticed this while trying to run a node over Tor.
Using ./bitcoind as the executable path is incorrect.
This is a simple documentation update PR that fixes the path by removing the prefix and just
having bitcoind as the usage example targeting those who have Bitcoin Core in their PATH.
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/32679.
See the guideline for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | janb84, davidgumberg, jonatack |
| Stale ACK | hebasto, brunoerg |
If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.
ACK b42ba6f806cda1e771ca9a0d57cc9716d1110a04.
Backport to 29.x?
They are assuming you’re running the commands from whatever directory
bitcoindis in.
I dont think that’s what it is assuming by explicitly indicates that the binary is in the current directory, which isn’t true.
Yes, you could argue that the build in the new docs path is just a default and users can change it, but bin/bitcoind is constant. So we’re just updating the docs to reflect the default setup.
The docs do not assume you’re building
bitcoindfrom source.
If that were the case, the command would simply be bitcoind without the ./ prefix.
I do sort of see both points here, I think the question to answer is who this documentation is for, there being three groups:
~/Downloads/bitcoin-29.0/PATH, probably installed from a package manager.Previously, this documentation was written for $2$, and this PR changes it to be for $1$.
I lean a little towards removing the ./ prefix from the commands here to cater to group $3$, whom I assume are average users.
I lean a little towards removing the ./ prefix from the commands here to cater to group 3, whom I assume are average users.
Done, I also see thats the pattern in i2p docs. This approach also prevents use from having to update when the location of the binary after building from source change again https://github.com/bitcoin/bitcoin/compare/b42ba6f806cda1e771ca9a0d57cc9716d1110a04..4ce53495e5e18370b7935551b3b8700faa720a33
ACK 4ce53495e5e18370b7935551b3b8700faa720a33
Can imagine that the ./ is confusing for some people, removing is the best option to keep the documentation “generic”. (Although this can be a typical item that can get reintroduced in a new PR later on)
ACK https://github.com/bitcoin/bitcoin/commit/4ce53495e5e18370b7935551b3b8700faa720a33
I think this makes the documentation more generic, stable, and useful for general users of Bitcoin Core, I think people that are downloading and unzipping binaries are likely to still be able to figure out what to do from these instructions.
