[doc] Tiny followups to new getpeerinfo connection type field #20090
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maflcko
reviewed
Oct 6, 2020
doc/release-notes.md
Outdated
| @@ -108,6 +108,8 @@ will trigger BIP 125 (replace-by-fee) opt-in. (#11413) | |||
| - The `getpeerinfo` RPC now returns a `connection_type` field. This indicates | |||
| the type of connection established with the peer. It will return one of six | |||
| options. For more information, see the `getpeerinfo` help documentation. | |||
| Please note that this string output is unlikely to be stable in upcoming | |||
| releases as we iterate to best capture connection behaviors. | |||
There was a problem hiding this comment.
This is a generally correct statement, that could go into the RPC help instead?
promag
reviewed
Oct 7, 2020
src/net.h
Outdated
| "manual (added via addnode RPC or -addnode/-connect configuration options)", | ||
| "addr-fetch (short-lived automatic connection for soliciting addresses)", | ||
| "feeler (short-lived automatic connection for testing addresses)"}; | ||
| extern const std::vector<std::string> CONNECTION_TYPE_DOC; |
There was a problem hiding this comment.
not sure if this was asked before, CONNECTION_TYPE_DOC is used only in src/rpc/net.cpp, why not just have it there?
There was a problem hiding this comment.
hmm, good point!
history: Marco suggested extracting in #19725 (comment). I thought a benefit was to keep CONNECTION_TYPE_DOC next to ConnectionType definition for future updates, but now we don't have that regardless. I've moved into src/rpc/net.cpp and added a comment on the ConnectionType enum for future code changes.
This slightly reduces the size of the binary.
f476fbd to
41dca08
Compare
|
ACK 41dca08 |
|
Code review ACK 41dca08 |
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Oct 16, 2020
…on type field 41dca08 [trivial] Extract connection type doc into file where it is used. (Amiti Uttarwar) 3069b56 [doc] Improve help for getpeerinfo connection_type field. (Amiti Uttarwar) Pull request description: two commits addressing small followups from bitcoin#19725 * first commit adds a clarification in the release notes that this field shouldn't be expected to be stable (suggested by sdaftuar in bitcoin#19725 (comment)) * second commit moves the `CONNECTION_TYPE_DOC` object out of the header file to reduce the size of the binary (suggested by MarcoFalke in bitcoin#19725 (comment), he tested and found a decrease of 10kB) ACKs for top commit: achow101: ACK 41dca08 laanwj: Code review ACK 41dca08 Tree-SHA512: a555df978b4341fbe05deeb40a8a655f0d3c5c1c0adcc1737fd2cf61b204a5a24a301ca0c2b5a3616554d4abf8c57074d22dbda5a50d8450bc22c57679424985
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
two commits addressing small followups from #19725
first commit adds a clarification in the release notes that this field shouldn't be expected to be stable (suggested by sdaftuar in [RPC] Add connection type to getpeerinfo, improve logs #19725 (comment))
second commit moves the
CONNECTION_TYPE_DOCobject out of the header file to reduce the size of the binary (suggested by MarcoFalke in [RPC] Add connection type to getpeerinfo, improve logs #19725 (comment), he tested and found a decrease of 10kB)