Improve raft.go comments
#4724
Merged
Improve raft.go comments
#4724
Conversation
This file contains 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
neilalexander
force-pushed
the
neil/raftdocs
branch
from
0fa835f
to
3d7e050
Compare
Signed-off-by: Neil Twigg <[email protected]>
neilalexander
force-pushed
the
neil/raftdocs
branch
from
3d7e050
to
486316b
Compare
server/raft.go
Outdated
| qn int // Number of nodes needed to establish quorum | ||
| peers map[string]*lps // Other peers in the Raft group | ||
|
|
||
| removed map[string]struct{} // |
There was a problem hiding this comment.
Forgot to fill those in, have done so now.
| @@ -380,7 +376,6 @@ func (s *Server) startRaftNode(accName string, cfg *RaftConfig, labels pprofLabe | |||
| track: cfg.Track, | |||
| csz: ps.clusterSize, | |||
| qn: ps.clusterSize/2 + 1, | |||
| hash: hash, | |||
There was a problem hiding this comment.
Why removed? Never accessed?
There was a problem hiding this comment.
Yep, it was never used.
server/raft.go
Outdated
| @@ -819,7 +859,7 @@ func (n *raft) PauseApply() error { | |||
| n.stepdown.push(noLeader) | |||
| } | |||
|
|
|||
| n.debug("Pausing our apply channel") | |||
| n.debug("Pausing our apply queue") | |||
There was a problem hiding this comment.
These are tough, sometimes easy to see a better log line but if its out there folks could depend on it, so I usually shy away from changing.
There was a problem hiding this comment.
Good point, I've put them back to what they were.
Signed-off-by: Neil Twigg <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR mostly just tries to comment what is going on inside
raft.goand does odd little bits of housekeeping/cleanup in places.Signed-off-by: Neil Twigg [email protected]