docs: Update rpcbind doc to match the manpage #14740

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

blob42 commented at 10:37 PM on November 16, 2018: none

The rpcbind documentation on the example file should match the Manpage. Even more they have opposite meanings.

This should close #9272
blob42 renamed this:
~~Update `rpcbind` doc to match the manpage closes #9272~~
Update `rpcbind` doc to match the manpage
on Nov 16, 2018
fanquake added the label Docs on Nov 16, 2018
fanquake commented at 2:44 AM on November 17, 2018: member

Please fix the trailing whitespace on the lines you've modified.
MarcoFalke commented at 5:13 PM on November 17, 2018: member

Unfortunately this file isn't really maintained. Couldn't we remove the help texts and refer everyone to the manpages/bitcoind -help?
Update `rpcbind` doc to match the manpage
Also should close #9272
d61b44b559
blob42 force-pushed on Nov 18, 2018
blob42 commented at 6:26 PM on November 18, 2018: none

@fanquake I amended the commit with the fix. I agree with @MarcoFalke if the file is not maintained it should be refered to the Manpage, it is however usually expected from a standard Debian package to offer an example conf in /usr/share/doc.
laanwj commented at 10:23 AM on November 21, 2018: member

I vaguely remember we had a script at some point that generated a sample bitcoin.conf from the option help, this would be more convenient than manually maintaining documentation in multiple places. No idea though. Didn't even know this file was shipped.
laanwj commented at 10:25 AM on November 21, 2018: member

BTW this will change with #14532
blob42 commented at 2:09 AM on November 25, 2018: none

I tried looking for the script and could not find it. I am willing to make a new script to generate this file, is it ok to do it in python ?

Also there some sections in the sample conf with more details which are not in the Man, maybe they should moved the Man ?

On November 21, 2018 11:27:06 AM GMT+01:00, "Wladimir J. van der Laan" notifications@github.com wrote:

BTW this will change with #14532

-- You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: https://github.com/bitcoin/bitcoin/pull/14740#issuecomment-440612921

-- Sent from my Android device with K-9 Mail. Please excuse my brevity.
laanwj commented at 11:09 PM on February 13, 2019: member

@luke-jr can you please check whether this matches the changes you did in #14532
fanquake requested review from luke-jr on Feb 17, 2019

in share/examples/bitcoin.conf:70 in d61b44b559

  67 | -# This option can be specified multiple times (default: bind to all interfaces)
  68 | +# Bind to given address to listen for JSON-RPC connections. This option is ignored
  69 | +# unless `-rpcallowip` is also passed. Port is optional and overrides `-rpcport`.
  70 | +# Use [host]:port notation for IPv6.  This option can be specified multiple
  71 | +# times (default: 127.0.0.1 and ::1 i.e., localhost, or if `-rpcallowip` has
  72 | +# been specified, 0.0.0.0 and :: i.e., all addresses)

luke-jr commented at 5:55 PM on February 22, 2019:

Default is only ever localhost now.

luke-jr changes_requested
fanquake renamed this:
~~Update `rpcbind` doc to match the manpage~~
docs: Update rpcbind doc to match the manpage
on Mar 2, 2019
fanquake commented at 10:10 AM on March 2, 2019: member

@sp4ke Are you able to follow up here?
blob42 commented at 12:05 PM on April 5, 2019: none

@fanquake sorry missed the notifications. I think the best would be to generate the doc from the manpage as previously stated. I will make a PR if I have sometime. It would be great if someone could share previous work done on this task so I can pick it up
DrahtBot closed this on Aug 16, 2019
DrahtBot commented at 1:48 PM on August 16, 2019: member

The last travis run for this pull request was 270 days ago and is thus outdated. To trigger a fresh travis build, this pull request should be closed and re-opened.
DrahtBot reopened this on Aug 16, 2019
MarcoFalke added the label Waiting for author on Aug 16, 2019
MarcoFalke removed the label Waiting for author on Aug 16, 2019
DrahtBot commented at 8:05 PM on August 16, 2019: member


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



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #16634 (doc: Refer in rpcbind doc to the manpage by MarcoFalke)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
laanwj closed this on Aug 19, 2019
sidhujag referenced this in commit 74f4e6d259 on Aug 19, 2019
PastaPastaPasta referenced this in commit f465bec708 on Jun 27, 2021
PastaPastaPasta referenced this in commit dcaabc5862 on Jun 28, 2021
PastaPastaPasta referenced this in commit 0df3e73a1e on Jun 29, 2021
PastaPastaPasta referenced this in commit be419b4062 on Jul 1, 2021
PastaPastaPasta referenced this in commit cf19d789c2 on Jul 1, 2021
PastaPastaPasta referenced this in commit 91cc5488af on Jul 12, 2021
DrahtBot locked this on Dec 16, 2021

Contributors

Labels

Linked (view graph)

#9272 Default behavior of binding to all interfaces for RPC server not working #16634 doc: Refer in rpcbind doc to the manpage

docs: Update rpcbind doc to match the manpage #14740

Conflicts