Doc: fix typos

Author: drmingdrmer

Makefile

@@ -53,6 +53,10 @@ lint:
 	# Thus we only check unused deps for lib
 	RUSTFLAGS=-Wunused-crate-dependencies cargo clippy --lib -- -D warnings
 
+typos:
+	# cargo install typos-cli
+	typos
+
 clean:
 	cargo clean
 

change-log.md

@@ -44,13 +44,13 @@
     Otherwise the application receives updated metrics while the internal raft
     state is still stale.
 
--   Fixed: [59ddc982](https://github.com/datafuselabs/openraft/commit/59ddc982100a390efd66632adbf25edd2c6e6a3c) avoid creating log-id with unitialized `matched.leader_id`.; by 张炎泼; 2022-07-26
+-   Fixed: [59ddc982](https://github.com/datafuselabs/openraft/commit/59ddc982100a390efd66632adbf25edd2c6e6a3c) avoid creating log-id with uninitialized `matched.leader_id`.; by 张炎泼; 2022-07-26
 
     When waiting for a newly added learner to become up to date,
     it tries to compare last-log-id and the reported `matched` replication
     state.
     But the `matched` may have not yet receive any update and is
-    unitialized, in such case, it tries to create a temp LogId with
+    uninitialized, in such case, it tries to create a temp LogId with
     `leader_id(0, 0)`, which is illegal.
 
     The fix is simple: do not use log-id. Just calculating replication lag by log index.
@@ -236,7 +236,7 @@
 
 -   Changed: [f40c2055](https://github.com/datafuselabs/openraft/commit/f40c205532b4e75384a6eaaebb601447001d13f4) Add a `RaftTypeConfig` trait to configure common types; by Ivan Schréter; 2022-02-25
 
--   Changed: [650e2352](https://github.com/datafuselabs/openraft/commit/650e23524b759219b9dea0d2fbe3e71859429115) Membership remove redundent field `learners`: the node ids that are in `Membership.nodes` but not in `Membership.configs` are learners; by 张炎泼; 2022-03-07
+-   Changed: [650e2352](https://github.com/datafuselabs/openraft/commit/650e23524b759219b9dea0d2fbe3e71859429115) Membership remove redundant field `learners`: the node ids that are in `Membership.nodes` but not in `Membership.configs` are learners; by 张炎泼; 2022-03-07
 
 -   Changed: [81cd3443](https://github.com/datafuselabs/openraft/commit/81cd3443530a9ef260ded00f0a8b2825cefe8196) EffectiveMembership.log_id to Option<LogId>; by 张炎泼; 2022-04-05
 
@@ -588,7 +588,7 @@
 
     API changes:
 
-    - Removes `allow_lagging` paramenter from `Raft::change_membership()`
+    - Removes `allow_lagging` parameter from `Raft::change_membership()`
     - Removes error `LearnerIsLagging`
 
     Upgrade tip:
@@ -648,7 +648,7 @@
 
 ### Added:
 
--   Added: [966eb287](https://github.com/datafuselabs/openraft/commit/966eb287ff9bc98112b7b5d69253cca2d86277f8) use a version to track metics change; by 张炎泼; 2022-03-03
+-   Added: [966eb287](https://github.com/datafuselabs/openraft/commit/966eb287ff9bc98112b7b5d69253cca2d86277f8) use a version to track metrics change; by 张炎泼; 2022-03-03
 
     Add `Versioned<D>` to track changes of an `Arc<D>`.
 
@@ -1380,7 +1380,7 @@
 
     - R0 to R1 `append_entries: entries=[{1,2}], prev_log_id = {1,1}, commit_index = 3`
     - R1 accepted this `append_entries` request but was not aware of that entry {2,3} is inconsistent to leader.
-      Updating commit index to 3 allows it to apply an uncommitted entrie `{2,3}`.
+      Updating commit index to 3 allows it to apply an uncommitted entries `{2,3}`.
 
 ## v0.6.2-alpha.15
 
@@ -1482,15 +1482,15 @@
 
     A membership change involves two steps: the joint config phase and the
     final config phase.
-    Each phase has a corresponding log invovled.
+    Each phase has a corresponding log involved.
 
     Previously the raft setup several channel to organize this workflow,
     which makes the logic hard to understand and introduces complexity when
-    restarting or leadership transfered: it needs to re-establish the channels and tasks.
+    restarting or leadership transferred: it needs to re-establish the channels and tasks.
 
     According to the gist of raft, all workflow should be log driven.
     Thus the new approach:
-    - Write two log(the joint and the final) at once it recevies a
+    - Write two log(the joint and the final) at once it receives a
       change-membership request.
     - All following job is done according to just what log is committed.
 
@@ -1546,7 +1546,7 @@
     logs to get the last membership that is included in state machine.
 
     By letting the state machine remember the membership log applied,
-    the snapshto creation becomes more convinient and intuitive: it does not
+    the snapshto creation becomes more convenient and intuitive: it does not
     need to scan the applied logs any more.
 
 ## v0.6.2-alpha.7
@@ -1609,7 +1609,7 @@
       a container of metadata of a snapshot.
       Reduce parameters.
 
-    - Refactor: remove redundent param `delete_through` from
+    - Refactor: remove redundant param `delete_through` from
       `finalize_snapshot_installation`.
 
 ## v0.6.2-alpha.4
@@ -1812,7 +1812,7 @@
     - Simplify CI test: test all in one action.
 
     - Disable clippy: it suggests inappropriate assert_eq to assert
-      convertion which is used in a macro.
+      conversion which is used in a macro.
 
     - Add makefile
 

change-log/v0.6.2-alpha.10.md

@@ -18,15 +18,15 @@
 
     A membership change involves two steps: the joint config phase and the
     final config phase.
-    Each phase has a corresponding log invovled.
+    Each phase has a corresponding log involved.
 
     Previously the raft setup several channel to organize this workflow,
     which makes the logic hard to understand and introduces complexity when
-    restarting or leadership transfered: it needs to re-establish the channels and tasks.
+    restarting or leadership transferred: it needs to re-establish the channels and tasks.
 
     According to the gist of raft, all workflow should be log driven.
     Thus the new approach:
-    - Write two log(the joint and the final) at once it recevies a
+    - Write two log(the joint and the final) at once it receives a
       change-membership request.
     - All following job is done according to just what log is committed.
 

change-log/v0.6.2-alpha.16.md

@@ -109,4 +109,4 @@
 
     - R0 to R1 `append_entries: entries=[{1,2}], prev_log_id = {1,1}, commit_index = 3`
     - R1 accepted this `append_entries` request but was not aware of that entry {2,3} is inconsistent to leader.
-      Updating commit index to 3 allows it to apply an uncommitted entrie `{2,3}`.
+      Updating commit index to 3 allows it to apply an uncommitted entries `{2,3}`.

change-log/v0.6.2-alpha.5.md

@@ -38,5 +38,5 @@
       a container of metadata of a snapshot.
       Reduce parameters.
 
-    - Refactor: remove redundent param `delete_through` from
+    - Refactor: remove redundant param `delete_through` from
       `finalize_snapshot_installation`.

change-log/v0.6.2-alpha.8.md

@@ -17,5 +17,5 @@
     logs to get the last membership that is included in state machine.
 
     By letting the state machine remember the membership log applied,
-    the snapshto creation becomes more convinient and intuitive: it does not
+    the snapshto creation becomes more convenient and intuitive: it does not
     need to scan the applied logs any more.

change-log/v0.6.2-alpha.md

@@ -65,7 +65,7 @@
     - Simplify CI test: test all in one action.
 
     - Disable clippy: it suggests inappropriate assert_eq to assert
-      convertion which is used in a macro.
+      conversion which is used in a macro.
 
     - Add makefile
 

change-log/v0.8.0.md

@@ -36,13 +36,13 @@
     Otherwise the application receives updated metrics while the internal raft
     state is still stale.
 
--   Fixed: [59ddc982](https://github.com/datafuselabs/openraft/commit/59ddc982100a390efd66632adbf25edd2c6e6a3c) avoid creating log-id with unitialized `matched.leader_id`.; by 张炎泼; 2022-07-26
+-   Fixed: [59ddc982](https://github.com/datafuselabs/openraft/commit/59ddc982100a390efd66632adbf25edd2c6e6a3c) avoid creating log-id with uninitialized `matched.leader_id`.; by 张炎泼; 2022-07-26
 
     When waiting for a newly added learner to become up to date,
     it tries to compare last-log-id and the reported `matched` replication
     state.
     But the `matched` may have not yet receive any update and is
-    unitialized, in such case, it tries to create a temp LogId with
+    uninitialized, in such case, it tries to create a temp LogId with
     `leader_id(0, 0)`, which is illegal.
 
     The fix is simple: do not use log-id. Just calculating replication lag by log index.
@@ -228,7 +228,7 @@
 
 -   Changed: [f40c2055](https://github.com/datafuselabs/openraft/commit/f40c205532b4e75384a6eaaebb601447001d13f4) Add a `RaftTypeConfig` trait to configure common types; by Ivan Schréter; 2022-02-25
 
--   Changed: [650e2352](https://github.com/datafuselabs/openraft/commit/650e23524b759219b9dea0d2fbe3e71859429115) Membership remove redundent field `learners`: the node ids that are in `Membership.nodes` but not in `Membership.configs` are learners; by 张炎泼; 2022-03-07
+-   Changed: [650e2352](https://github.com/datafuselabs/openraft/commit/650e23524b759219b9dea0d2fbe3e71859429115) Membership remove redundant field `learners`: the node ids that are in `Membership.nodes` but not in `Membership.configs` are learners; by 张炎泼; 2022-03-07
 
 -   Changed: [81cd3443](https://github.com/datafuselabs/openraft/commit/81cd3443530a9ef260ded00f0a8b2825cefe8196) EffectiveMembership.log_id to Option<LogId>; by 张炎泼; 2022-04-05
 
@@ -580,7 +580,7 @@
 
     API changes:
 
-    - Removes `allow_lagging` paramenter from `Raft::change_membership()`
+    - Removes `allow_lagging` parameter from `Raft::change_membership()`
     - Removes error `LearnerIsLagging`
 
     Upgrade tip:
@@ -640,7 +640,7 @@
 
 ### Added:
 
--   Added: [966eb287](https://github.com/datafuselabs/openraft/commit/966eb287ff9bc98112b7b5d69253cca2d86277f8) use a version to track metics change; by 张炎泼; 2022-03-03
+-   Added: [966eb287](https://github.com/datafuselabs/openraft/commit/966eb287ff9bc98112b7b5d69253cca2d86277f8) use a version to track metrics change; by 张炎泼; 2022-03-03
 
     Add `Versioned<D>` to track changes of an `Arc<D>`.
 

examples/raft-kv-memstore/src/client.rs

@@ -65,7 +65,7 @@ impl ExampleClient {
 
     /// Consistent Read value by key, in an inconsistent mode.
     ///
-    /// This method MUST return consitent value or CheckIsLeaderError.
+    /// This method MUST return consistent value or CheckIsLeaderError.
     pub async fn consistent_read(&self, req: &String) -> Result<String, typ::RPCError<typ::CheckIsLeaderError>> {
         self.do_send_rpc_to_leader("consistent_read", Some(req)).await
     }

examples/raft-kv-memstore/src/store/mod.rs

@@ -46,7 +46,7 @@ pub enum ExampleRequest {
  * In this example it will return a optional value from a given key in
  * the `ExampleRequest.Set`.
  *
- * TODO: SHould we explain how to create multiple `AppDataResponse`?
+ * TODO: Should we explain how to create multiple `AppDataResponse`?
  *
  */
 #[derive(Serialize, Deserialize, Debug, Clone)]

examples/raft-kv-rocksdb/src/client.rs

@@ -74,7 +74,7 @@ impl ExampleClient {
 
     /// Consistent Read value by key, in an inconsistent mode.
     ///
-    /// This method MUST return consitent value or CheckIsLeaderError.
+    /// This method MUST return consistent value or CheckIsLeaderError.
     pub async fn consistent_read(
         &self,
         req: &String,

examples/raft-kv-rocksdb/src/store.rs

@@ -55,7 +55,7 @@ pub enum ExampleRequest {
  * In this example it will return a optional value from a given key in
  * the `ExampleRequest.Set`.
  *
- * TODO: SHould we explain how to create multiple `AppDataResponse`?
+ * TODO: Should we explain how to create multiple `AppDataResponse`?
  *
  */
 #[derive(Serialize, Deserialize, Debug, Clone)]
@@ -390,7 +390,7 @@ impl RaftSnapshotBuilder<ExampleTypeConfig, Cursor<Vec<u8>>> for Arc<ExampleStor
             last_membership = state_machine.last_membership;
         }
 
-        // TODO: we probably want thius to be atomic.
+        // TODO: we probably want this to be atomic.
         let snapshot_idx: u64 = self.get_snapshot_index_()? + 1;
         self.set_snapshot_indesx_(snapshot_idx)?;
 

guide/src/faq.md

@@ -2,7 +2,7 @@
 
 -   Q: 🤔 Why is heartbeat an append-entries RPC with a blank log in openraft, while standard Raft uses empty append-entries?
 
-    Chapter [Heartbeat](./heartbeat.md) explains the benifit of the heartbeat-log design.
+    Chapter [Heartbeat](./heartbeat.md) explains the benefit of the heartbeat-log design.
 
 -   Q: 🤔 Why is log id `(term, node_id, log_index)`, while standard Raft uses just
     `(term, log_index)`?

guide/src/getting-started.md

@@ -6,7 +6,7 @@ In this chapter we are going to build a key-value store cluster with [openraft](
 is the complete example application including the server, the client and a demo cluster.
 
 [examples/raft-kv-rocksdb](https://github.com/datafuselabs/openraft/tree/main/examples/raft-kv-rocksdb)
-is the complete example application including the server, the client and a demo cluster using rocksdb for persistant storage.
+is the complete example application including the server, the client and a demo cluster using rocksdb for persistent storage.
 
 ---
 

guide/src/upgrade-v07-v08.md

@@ -65,7 +65,7 @@ Openraft v0.8 can be compatible with v0.7 if:
 - Enabling `compat-07` feature flags.
 
 Openraft uses a `RaftStorage` implementation provided by the application to
-store presistent data. When upgrading from v0.7 to v0.8, it is important to
+store persistent data. When upgrading from v0.7 to v0.8, it is important to
 ensure that the updated `RaftStorage` is backward compatible and can read the
 data written by v0.7 openraft, in addition to reading and writing v0.8 openraft data.
 This ensures that the application continues to function smoothly after upgrade.

openraft/Cargo.toml

@@ -77,10 +77,10 @@ serde = ["dep:serde"]
 # This feature is disabled by default.
 single-term-leader = []
 
-# Provide basic compatbile types
+# Provide basic compatible types
 compat = []
 
-# Turn on to let openraft provide addtional data types to build v0.7 compatible RaftStorage.
+# Turn on to let openraft provide additional data types to build v0.7 compatible RaftStorage.
 compat-07 = ["compat", "serde", "dep:or07", "compat-07-testing"]
 compat-07-testing = ["dep:tempfile", "anyhow", "dep:serde_json"]
 

openraft/src/defensive.rs

@@ -137,7 +137,7 @@ where
         Ok(())
     }
 
-    /// Trying to feed in emtpy entries slice is an inappropriate action.
+    /// Trying to feed in empty entries slice is an inappropriate action.
     ///
     /// The impl has to avoid this otherwise it may be a bug.
     async fn defensive_nonempty_input(&self, entries: &[&Entry<C>]) -> Result<(), StorageError<C::NodeId>> {
@@ -235,7 +235,7 @@ where
         Ok(())
     }
 
-    /// The entries to apply to state machien has to be last_applied_log_id.index + 1
+    /// The entries to apply to state machine has to be last_applied_log_id.index + 1
     async fn defensive_apply_index_is_last_applied_plus_one(
         &mut self,
         entries: &[&Entry<C>],

openraft/src/engine/handler/leader_handler.rs

@@ -736,7 +736,7 @@ mod tests {
                         target: 2,
                         req: Inflight::logs(None, Some(log_id(3, 6))).with_id(1),
                     },
-                    // It is correct to commit if the membership change ot a one node cluster.
+                    // It is correct to commit if the membership change to a one node cluster.
                     Command::ReplicateCommitted {
                         committed: Some(log_id(3, 6))
                     },

openraft/src/membership/membership_state.rs

@@ -155,7 +155,7 @@ where
     /// It returns the updated effective membership config if it is changed.
     ///
     /// It will reset `self.effective` to `self.committed`. Only the effective could be truncated,
-    /// when a new leader tries ot truncate follower logs that the leader does not have.
+    /// when a new leader tries to truncate follower logs that the leader does not have.
     ///
     /// If the effective membership is from a conflicting log,
     /// the membership state has to revert to the last committed membership config.

openraft/src/raft.rs

@@ -1127,7 +1127,7 @@ impl<NID: NodeId> VoteRequest<NID> {
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize), serde(bound = ""))]
 pub struct VoteResponse<NID: NodeId> {
-    /// vote after a node handling vote-reqest.
+    /// vote after a node handling vote-request.
     /// Thus `resp.vote >= req.vote` always holds.
     pub vote: Vote<NID>,
 

openraft/src/testing/suite.rs

@@ -33,7 +33,7 @@ use crate::Vote;
 
 const NODE_ID: u64 = 0;
 
-/// Helper to consturct a `BTreeSet` of `C::NodeId` from numbers.
+/// Helper to construct a `BTreeSet` of `C::NodeId` from numbers.
 macro_rules! btreeset {
     ($($key:expr,)+) => (btreeset!($($key),+));
     ( $($key:expr),* ) => {{

openraft/src/vote/leader_id/leader_id_adv.rs

@@ -73,7 +73,7 @@ mod tests {
     use crate::LeaderId;
 
     #[test]
-    fn test_commited_leader_id_serde() -> anyhow::Result<()> {
+    fn test_committed_leader_id_serde() -> anyhow::Result<()> {
         let c = CommittedLeaderId::<u32>::new(5, 10);
         let s = serde_json::to_string(&c)?;
         assert_eq!(r#"{"term":5,"node_id":10}"#, s);

openraft/src/vote/leader_id/leader_id_std.rs

@@ -104,7 +104,7 @@ mod tests {
     use crate::LeaderId;
 
     #[test]
-    fn test_commited_leader_id_serde() -> anyhow::Result<()> {
+    fn test_committed_leader_id_serde() -> anyhow::Result<()> {
         let c = CommittedLeaderId::<u32>::new(5, 10);
         let s = serde_json::to_string(&c)?;
         assert_eq!(r#"5"#, s);

rocksstore/src/lib.rs

@@ -63,7 +63,7 @@ pub enum RocksRequest {
  * In this example it will return a optional value from a given key in
  * the `RocksRequest.Set`.
  *
- * TODO: SHould we explain how to create multiple `AppDataResponse`?
+ * TODO: Should we explain how to create multiple `AppDataResponse`?
  *
  */
 #[derive(Serialize, Deserialize, Debug, Clone)]

sledstore/src/lib.rs

@@ -56,7 +56,7 @@ pub enum ExampleRequest {
  * In this example it will return a optional value from a given key in
  * the `ExampleRequest.Set`.
  *
- * TODO: SHould we explain how to create multiple `AppDataResponse`?
+ * TODO: Should we explain how to create multiple `AppDataResponse`?
  *
  */
 #[derive(Serialize, Deserialize, Debug, Clone)]
@@ -408,7 +408,7 @@ impl RaftLogReader<ExampleTypeConfig> for Arc<SledStore> {
         let logs = logs_tree
             .range::<&[u8], _>(start.as_slice()..)
             .map(|el_res| {
-                let el = el_res.expect("Faile read log entry");
+                let el = el_res.expect("Failed read log entry");
                 let id = el.0;
                 let val = el.1;
                 let entry: StorageResult<Entry<_>> = serde_json::from_slice(&val).map_err(|e| StorageError::IO {
@@ -446,7 +446,7 @@ impl RaftSnapshotBuilder<ExampleTypeConfig, Cursor<Vec<u8>>> for Arc<SledStore>
             last_membership = state_machine.last_membership;
         }
 
-        // TODO: we probably want thius to be atomic.
+        // TODO: we probably want this to be atomic.
         let snapshot_idx: u64 = self.get_snapshot_index_()? + 1;
         self.set_snapshot_index_(snapshot_idx).await?;