aboutsummaryrefslogtreecommitdiff
path: root/src/util
diff options
context:
space:
mode:
authormaximilien <me@mricher.fr>2025-01-17 06:06:14 +0000
committermaximilien <me@mricher.fr>2025-01-17 06:06:14 +0000
commit294cb9940943d7febc1029ed44145daf57f914d0 (patch)
treebe9b2912ae92b07ef5e7905372b1bc2a542234c6 /src/util
parent255b01b626096ef98cf24c9552b39c0372fb4eb3 (diff)
parent2eb9fcae20cb7e41b1197f4565db492a97f95736 (diff)
downloadgarage-294cb9940943d7febc1029ed44145daf57f914d0.tar.gz
garage-294cb9940943d7febc1029ed44145daf57f914d0.zip
Merge pull request 'Fix all typos' (#928) from majst01/garage:fix-typos into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/928 Reviewed-by: maximilien <me@mricher.fr>
Diffstat (limited to 'src/util')
-rw-r--r--src/util/background/worker.rs4
-rw-r--r--src/util/config.rs4
-rw-r--r--src/util/crdt/crdt.rs4
-rw-r--r--src/util/crdt/lww.rs12
-rw-r--r--src/util/crdt/lww_map.rs4
-rw-r--r--src/util/crdt/map.rs2
-rw-r--r--src/util/encode.rs8
7 files changed, 19 insertions, 19 deletions
diff --git a/src/util/background/worker.rs b/src/util/background/worker.rs
index 8165e2cb..76fb14e8 100644
--- a/src/util/background/worker.rs
+++ b/src/util/background/worker.rs
@@ -14,7 +14,7 @@ use crate::background::{WorkerInfo, WorkerStatus};
use crate::error::Error;
use crate::time::now_msec;
-// All workers that haven't exited for this time after an exit signal was recieved
+// All workers that haven't exited for this time after an exit signal was received
// will be interrupted in the middle of whatever they are doing.
const EXIT_DEADLINE: Duration = Duration::from_secs(8);
@@ -54,7 +54,7 @@ pub trait Worker: Send {
async fn work(&mut self, must_exit: &mut watch::Receiver<bool>) -> Result<WorkerState, Error>;
/// Wait for work: await for some task to become available. This future can be interrupted in
- /// the middle for any reason, for example if an interrupt signal was recieved.
+ /// the middle for any reason, for example if an interrupt signal was received.
async fn wait_for_work(&mut self) -> WorkerState;
}
diff --git a/src/util/config.rs b/src/util/config.rs
index a24db84e..01f7350a 100644
--- a/src/util/config.rs
+++ b/src/util/config.rs
@@ -93,12 +93,12 @@ pub struct Config {
/// the addresses announced to other peers to a specific subnet.
pub rpc_public_addr_subnet: Option<String>,
- /// Timeout for Netapp's ping messagess
+ /// Timeout for Netapp's ping messages
pub rpc_ping_timeout_msec: Option<u64>,
/// Timeout for Netapp RPC calls
pub rpc_timeout_msec: Option<u64>,
- // -- Bootstraping and discovery
+ // -- Bootstrapping and discovery
/// Bootstrap peers RPC address
#[serde(default)]
pub bootstrap_peers: Vec<String>,
diff --git a/src/util/crdt/crdt.rs b/src/util/crdt/crdt.rs
index 06876897..fdf63084 100644
--- a/src/util/crdt/crdt.rs
+++ b/src/util/crdt/crdt.rs
@@ -33,8 +33,8 @@ pub trait Crdt {
/// arises very often, for example with a Lww or a LwwMap: the value type has to be a CRDT so that
/// we have a rule for what to do when timestamps aren't enough to disambiguate (in a distributed
/// system, anything can happen!), and with AutoCrdt the rule is to make an arbitrary (but
-/// determinstic) choice between the two. When using an Option<T> instead with this impl, ambiguity
-/// cases are explicitely stored as None, which allows us to detect the ambiguity and handle it in
+/// deterministic) choice between the two. When using an Option<T> instead with this impl, ambiguity
+/// cases are explicitly stored as None, which allows us to detect the ambiguity and handle it in
/// the way we want. (this can only work if we are happy with losing the value when an ambiguity
/// arises)
impl<T> Crdt for Option<T>
diff --git a/src/util/crdt/lww.rs b/src/util/crdt/lww.rs
index 958844c9..80747406 100644
--- a/src/util/crdt/lww.rs
+++ b/src/util/crdt/lww.rs
@@ -16,7 +16,7 @@ use crate::crdt::crdt::*;
/// In our case, we add the constraint that the value that is wrapped inside the LWW CRDT must
/// itself be a CRDT: in the case when the timestamp does not allow us to decide on which value to
/// keep, the merge rule of the inner CRDT is applied on the wrapped values. (Note that all types
-/// that implement the `Ord` trait get a default CRDT implemetnation that keeps the maximum value.
+/// that implement the `Ord` trait get a default CRDT implementation that keeps the maximum value.
/// This enables us to use LWW directly with primitive data types such as numbers or strings. It is
/// generally desirable in this case to never explicitly produce LWW values with the same timestamp
/// but different inner values, as the rule to keep the maximum value isn't generally the desired
@@ -28,9 +28,9 @@ use crate::crdt::crdt::*;
///
/// Given that clocks are not too desynchronized, this assumption
/// is enough for most cases, as there is few chance that two humans
-/// coordonate themself faster than the time difference between two NTP servers.
+/// coordinate themself faster than the time difference between two NTP servers.
///
-/// As a more concret example, let's suppose you want to upload a file
+/// As a more concrete example, let's suppose you want to upload a file
/// with the same key (path) in the same bucket at the very same time.
/// For each request, the file will be timestamped by the receiving server
/// and may differ from what you observed with your atomic clock!
@@ -84,16 +84,16 @@ where
&self.v
}
- /// Take the value inside the CRDT (discards the timesamp)
+ /// Take the value inside the CRDT (discards the timestamp)
pub fn take(self) -> T {
self.v
}
/// Get a mutable reference to the CRDT's value
///
- /// This is usefull to mutate the inside value without changing the LWW timestamp.
+ /// This is useful to mutate the inside value without changing the LWW timestamp.
/// When such mutation is done, the merge between two LWW values is done using the inner
- /// CRDT's merge operation. This is usefull in the case where the inner CRDT is a large
+ /// CRDT's merge operation. This is useful in the case where the inner CRDT is a large
/// data type, such as a map, and we only want to change a single item in the map.
/// To do this, we can produce a "CRDT delta", i.e. a LWW that contains only the modification.
/// This delta consists in a LWW with the same timestamp, and the map
diff --git a/src/util/crdt/lww_map.rs b/src/util/crdt/lww_map.rs
index 88113856..def0ebeb 100644
--- a/src/util/crdt/lww_map.rs
+++ b/src/util/crdt/lww_map.rs
@@ -109,7 +109,7 @@ where
}
/// Takes all of the values of the map and returns them. The current map is reset to the
- /// empty map. This is very usefull to produce in-place a new map that contains only a delta
+ /// empty map. This is very useful to produce in-place a new map that contains only a delta
/// that modifies a certain value:
///
/// ```ignore
@@ -162,7 +162,7 @@ where
}
}
- /// Gets a reference to all of the items, as a slice. Usefull to iterate on all map values.
+ /// Gets a reference to all of the items, as a slice. Useful to iterate on all map values.
/// In most case you will want to ignore the timestamp (second item of the tuple).
pub fn items(&self) -> &[(K, u64, V)] {
&self.vals[..]
diff --git a/src/util/crdt/map.rs b/src/util/crdt/map.rs
index 5d1e1520..adac3c38 100644
--- a/src/util/crdt/map.rs
+++ b/src/util/crdt/map.rs
@@ -57,7 +57,7 @@ where
Err(_) => None,
}
}
- /// Gets a reference to all of the items, as a slice. Usefull to iterate on all map values.
+ /// Gets a reference to all of the items, as a slice. Useful to iterate on all map values.
pub fn items(&self) -> &[(K, V)] {
&self.vals[..]
}
diff --git a/src/util/encode.rs b/src/util/encode.rs
index a9ab9a35..c6815d49 100644
--- a/src/util/encode.rs
+++ b/src/util/encode.rs
@@ -1,7 +1,7 @@
use serde::{Deserialize, Serialize};
-/// Serialize to MessagePacki, without versionning
-/// (see garage_util::migrate for functions that manage versionned
+/// Serialize to MessagePack, without versioning
+/// (see garage_util::migrate for functions that manage versioned
/// data formats)
pub fn nonversioned_encode<T>(val: &T) -> Result<Vec<u8>, rmp_serde::encode::Error>
where
@@ -13,8 +13,8 @@ where
Ok(wr)
}
-/// Deserialize from MessagePacki, without versionning
-/// (see garage_util::migrate for functions that manage versionned
+/// Deserialize from MessagePack, without versioning
+/// (see garage_util::migrate for functions that manage versioned
/// data formats)
pub fn nonversioned_decode<T>(bytes: &[u8]) -> Result<T, rmp_serde::decode::Error>
where