databendlabs / openraft / 24774202633
87%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 261
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 86.546% (-0.02%) from 86.561%
24774202633

push

github

drmingdrmer 
docs: expand "differences from standard Raft" FAQ entry

Turn the 5-line bullet list into a grouped, protocol-level survey of where
Openraft departs from the Raft paper. The previous entry only listed five
items and left several other departures (`Vote` as unified primitive,
extended joint consensus, leader-not-tied-to-voter, lease/follower reads)
either undocumented at this level or scattered across deeper docs with no
pointer from the FAQ.

The entry is scoped to protocol-level differences only. API conveniences
(`RaftTypeConfig`, split storage, manual triggers, lifecycle callbacks)
are called out as out-of-scope to keep the FAQ digestible.

The "Leader is not tied to voter role" section introduces an explicit
phase model: Phase A (learner/removed leader) is supported today; Phase B
(never-member leader) is on the roadmap. This surfaces a partially-rolled-out
feature that previously lived only in an inline comment on
`RaftCore::current_leader`.

Changes:
- Group differences by area: Election/`Vote`, Leader-voter decoupling,
  Membership change, Log and state, Read
- Add phases A (supported) and B (roadmap) for leader-is-not-voter
- Fold the use-at-once semantic into the `change_membership` concurrency
  bullet and link to the formal constraint in `extended_membership`
- Add link refs to `Vote`, `LogId`, `ReadPolicy::LeaseRead`, and the
  replication `leader_lease` doc

16287 of 18819 relevant lines covered (86.55%)

123660.24 hits per line

Coverage Regressions

Lines Coverage ∆ File
3
88.89
 -3.7% openraft/src/core/sm/handle.rs
3
84.62
 -4.62% openraft/src/raft/raft_inner.rs
3
95.17
 -1.45% openraft/src/replication/mod.rs
2
91.6
 -1.68% openraft/src/replication/stream_state.rs
Jobs
ID Job ID Ran Files Coverage
1 24774202633.1 261
86.55
 GitHub Action Run
Source Files on build 24774202633