[doc] Fix documentation of options onlynet and listenonion

ghost commented at 4:04 pm on December 6, 2020: none

See #13378 I think a first step to improvement is to document precisely and correctly the current behavior, and then decide if that behavior is wanted and/or accepted.

fanquake added the label Docs on Dec 7, 2020

unknown renamed this:
~~[doc] Fix documenation of options onlynet and listenonion~~
[doc] Fix documentation of options onlynet and listenonion
on Dec 7, 2020

[doc] Fix documenation of options onlynet and listenonion

See #13378
I think a first step to improvement is to document precisely and correctly the current behavior, and then decide if that behavior is wanted and/or accepted.

ce2948e0cd

in src/init.cpp:460 in 8f326878ed outdated

457     argsman.AddArg("-maxsendbuffer=<n>", strprintf("Maximum per-connection send buffer, <n>*1000 bytes (default: %u)", DEFAULT_MAXSENDBUFFER), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
458     argsman.AddArg("-maxtimeadjustment", strprintf("Maximum allowed median peer time offset adjustment. Local perspective of time may be influenced by peers forward or backward by this amount. (default: %u seconds)", DEFAULT_MAX_TIME_ADJUSTMENT), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
459     argsman.AddArg("-maxuploadtarget=<n>", strprintf("Tries to keep outbound traffic under the given target (in MiB per 24h). Limit does not apply to peers with 'download' permission. 0 = no limit (default: %d)", DEFAULT_MAX_UPLOAD_TARGET), ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
460     argsman.AddArg("-onion=<ip:port>", "Use separate SOCKS5 proxy to reach peers via Tor onion services, set -noonion to disable (default: -proxy)", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
461-    argsman.AddArg("-onlynet=<net>", "Make outgoing connections only through network <net> (ipv4, ipv6 or onion). Incoming connections are not affected by this option. This option can be specified multiple times to allow multiple networks.", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);
462+    argsman.AddArg("-onlynet=<net>", "Make outgoing connections only through network <net> (ipv4, ipv6 or onion). Incoming connections are not affected by this option. This option can be specified multiple times to allow multiple networks. Regardless of this setting, outgoing onion connections are enabled by listenonion=1", ArgsManager::ALLOW_ANY, OptionsCategory::CONNECTION);

laanwj commented at 1:56 pm on December 10, 2020:

Nit: missing . at end of sentence

ghost commented at 3:06 pm on December 10, 2020: none

Added the dot, rebased&squashed.

Edit: There are two other lines in the output of bin/bitcoind --help that end with key=value. where the dot does not belong to the value, but marks the end of the sentence:

Equivalent to -chain=signet. Equivalent to -chain=test. (even at the end of the paragraph, like it is in this PR the case, too)

(in src/chainparamsbase.cpp)

DrahtBot commented at 9:06 pm on December 17, 2020: 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:

#20757 (doc: tor.md and -onlynet help updates by jonatack)

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.

ghost commented at 8:19 am on December 18, 2020: none

I would appreciate if this could be merged now, so it is done.

DrahtBot added the label Needs rebase on Jan 27, 2021

DrahtBot commented at 2:18 pm on January 27, 2021: member

🐙 This pull request conflicts with the target branch and needs rebase.

Want to unsubscribe from rebase notifications on this pull request? Just convert this pull request to a “draft”.

ghost commented at 6:06 am on January 31, 2021: none

The chaotic networking behavior is now reasonably documented with #20757 I guess, closing.

unknown closed this on Jan 31, 2021

unknown deleted the branch on Jan 31, 2021

jonatack commented at 9:28 pm on February 1, 2021: member

@wodry I’m sorry, I overlooked this pull when consolidating ideas for #20757, otherwise would have been happy to look at including it. Maybe it’s complementary.

ghost commented at 10:01 pm on February 1, 2021: none

@jonatack Thanks, that’s nice of you, nevermind, my impression is that the subject of Tor network and it’s documentation is in good hands of you right now. There was some dynamic changes currently in this subject, I lost overview and only use release versions, so I do not know the current (master branch) behavior. I would check later time with new releases maybe again. Feel free to check if the issue I mentioned here is of any value anymore maybe worth to include :-)

DrahtBot locked this on Aug 16, 2022

[doc] Fix documentation of options onlynet and listenonion #20582

Conflicts