doc: added info to bitcoin.conf doc #22393

pull bliotti wants to merge 1 commits into bitcoin:master from bliotti:patch-1 changing 1 files +2 −0

bliotti commented at 4:23 AM on July 3, 2021: contributor

Should probably be explicitly stated to not make modifications to the conf file while daemon is running. ref #11586

For example, if rpc credentials are modified while bitcoind is running, bitcoin-cli stop is unable to stop bitcoind until the original credentials are restored in bitcoin.conf
bliotti renamed this:
~~added info to bitcoin.conf doc~~
doc: added info to bitcoin.conf doc
on Jul 3, 2021
DrahtBot added the label Docs on Jul 3, 2021

in doc/bitcoin-conf.md:7 in 03713ab929 outdated

   3 | @@ -4,6 +4,8 @@ The configuration file is used by `bitcoind`, `bitcoin-qt` and `bitcoin-cli`.
   4 |  
   5 |  All command-line options (except for `-?`, `-help`, `-version` and `-conf`) may be specified in a configuration file, and all configuration file options (except for `includeconf`) may also be specified on the command line. Command-line options override values set in the configuration file and configuration file options override values set in the GUI.
   6 |  
   7 | +The configuration file should not be modified while `bitcoind` is running.

hebasto commented at 4:48 PM on July 3, 2021:

The configuration file should not be modified while `bitcoind` or `bitcoin-qt` is running.

hebasto commented at 4:48 PM on July 3, 2021: member

Concept ACK.
Zero-1729 commented at 9:05 PM on July 3, 2021: contributor

Concept ACK (esp with @hebasto's suggestion)
sipa commented at 9:07 PM on July 3, 2021: member

I'm not sure that's the advice we should give. There is no problem with modifying the config file while Bitcoin Core is running per se; it's just that changes won't take effect until you restart.
Zero-1729 commented at 9:29 PM on July 3, 2021: contributor
To @sipa's point, if you are going to add a warning it should probably be to notify users that the changes take effect only after restart. bitcoin-qt already warns the users about it when they modify the configuration file.

So I suppose maybe rewording it to something like:
```
Changes to the configuration file while `bitcoind` or `bitcoin-qt` is running only takes effect after reset.
```
brunoerg commented at 10:27 PM on July 4, 2021: member
To @sipa's point, if you are going to add a warning it should probably be to notify users that the changes take effect only after restart. bitcoin-qt already warns the users about it when they modify the configuration file.

So I suppose maybe rewording it to something like:

Changes to the configuration file while `bitcoind` or `bitcoin-qt` is running only takes effect after reset.
I think restarting instead of reset would be better.
jonatack commented at 10:30 PM on July 4, 2021: member

and s/takes/take/
Zero-1729 commented at 3:23 AM on July 5, 2021: contributor
Thanks @brunoerg and @jonatack for the catch! It should have been restarting instead of reset. take also fits better, grammatically speaking.

So it should (have) read:
```
Changes to the configuration file while `bitcoind` or `bitcoin-qt` is running only take effect after restarting.
```
fanquake deleted a comment on Jul 5, 2021
doc: added info to bitcoin.conf doc fa84caebc7
bliotti force-pushed on Jul 6, 2021
Zero-1729 approved
Zero-1729 commented at 4:00 PM on July 6, 2021: contributor

ACK fa84caebc7b647d9483262b6634bfe6b02b90a69
theStack approved
theStack commented at 12:11 AM on July 8, 2021: member

LGTM ACK fa84caebc7b647d9483262b6634bfe6b02b90a69 🗄️
rajarshimaitra commented at 9:33 AM on July 8, 2021: contributor

ACK https://github.com/bitcoin/bitcoin/pull/22393/commits/fa84caebc7b647d9483262b6634bfe6b02b90a69
MarcoFalke merged this on Jul 15, 2021
MarcoFalke closed this on Jul 15, 2021
sidhujag referenced this in commit a2aa6e186a on Jul 23, 2021
PastaPastaPasta referenced this in commit ce42c1bdc5 on Mar 5, 2022
PastaPastaPasta referenced this in commit 0c0c296089 on Mar 5, 2022
PastaPastaPasta referenced this in commit f875baae9b on Mar 5, 2022
PastaPastaPasta referenced this in commit e206ffed6c on Mar 7, 2022
gwillen referenced this in commit 0bfb3367ed on Jun 1, 2022
DrahtBot locked this on Aug 18, 2022

Contributors

Labels

Linked (view graph)

#11586 Cannot stop daemon when changing config for RPC