aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex <alex@adnab.me>2023-07-14 15:51:44 +0000
committerAlex <alex@adnab.me>2023-07-14 15:51:44 +0000
commit6ba611361e6d3ae701ea211adddbed61ea338da7 (patch)
tree85f90fdd80ee92631cb5816f087126718c3659eb
parent7605d0cb117d80e7140812e96264e86a4c987080 (diff)
parentc855284760d4ac198f5acf2ae0e18f98870be98f (diff)
downloadgarage-6ba611361e6d3ae701ea211adddbed61ea338da7.tar.gz
garage-6ba611361e6d3ae701ea211adddbed61ea338da7.zip
Merge pull request 'tree-wide: fix some typos' (#598) from flokli/garage:fix-typos into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/598
-rw-r--r--doc/api/garage-admin-v0.yml2
-rw-r--r--doc/book/reference-manual/configuration.md4
-rw-r--r--doc/book/reference-manual/k2v.md2
-rw-r--r--doc/drafts/admin-api.md4
-rw-r--r--src/garage/cli/structs.rs2
-rw-r--r--src/util/migrate.rs2
6 files changed, 8 insertions, 8 deletions
diff --git a/doc/api/garage-admin-v0.yml b/doc/api/garage-admin-v0.yml
index 51968894..83316d93 100644
--- a/doc/api/garage-admin-v0.yml
+++ b/doc/api/garage-admin-v0.yml
@@ -632,7 +632,7 @@ paths:
operationId: "UpdateBucket"
summary: "Update a bucket"
description: |
- All fields (`websiteAccess` and `quotas`) are optionnal.
+ All fields (`websiteAccess` and `quotas`) are optional.
If they are present, the corresponding modifications are applied to the bucket, otherwise nothing is changed.
In `websiteAccess`: if `enabled` is `true`, `indexDocument` must be specified.
diff --git a/doc/book/reference-manual/configuration.md b/doc/book/reference-manual/configuration.md
index 20a79aa6..b916bb61 100644
--- a/doc/book/reference-manual/configuration.md
+++ b/doc/book/reference-manual/configuration.md
@@ -409,7 +409,7 @@ message that redirects the client to the correct region.
### `root_domain` {#root_domain}
-The optionnal suffix to access bucket using vhost-style in addition to path-style request.
+The optional suffix to access bucket using vhost-style in addition to path-style request.
Note path-style requests are always enabled, whether or not vhost-style is configured.
Configuring vhost-style S3 required a wildcard DNS entry, and possibly a wildcard TLS certificate,
but might be required by softwares not supporting path-style requests.
@@ -432,7 +432,7 @@ This endpoint does not suport TLS: a reverse proxy should be used to provide it.
### `root_domain`
-The optionnal suffix appended to bucket names for the corresponding HTTP Host.
+The optional suffix appended to bucket names for the corresponding HTTP Host.
For instance, if `root_domain` is `web.garage.eu`, a bucket called `deuxfleurs.fr`
will be accessible either with hostname `deuxfleurs.fr.web.garage.eu`
diff --git a/doc/book/reference-manual/k2v.md b/doc/book/reference-manual/k2v.md
index ed069b27..c01f641e 100644
--- a/doc/book/reference-manual/k2v.md
+++ b/doc/book/reference-manual/k2v.md
@@ -3,7 +3,7 @@ title = "K2V"
weight = 100
+++
-Starting with version 0.7.2, Garage introduces an optionnal feature, K2V,
+Starting with version 0.7.2, Garage introduces an optional feature, K2V,
which is an alternative storage API designed to help efficiently store
many small values in buckets (in opposition to S3 which is more designed
to store large blobs).
diff --git a/doc/drafts/admin-api.md b/doc/drafts/admin-api.md
index 9a697a59..fb71dc83 100644
--- a/doc/drafts/admin-api.md
+++ b/doc/drafts/admin-api.md
@@ -453,7 +453,7 @@ Request body format:
}
```
-All fields (`name`, `allow` and `deny`) are optionnal.
+All fields (`name`, `allow` and `deny`) are optional.
If they are present, the corresponding modifications are applied to the key, otherwise nothing is changed.
The possible flags in `allow` and `deny` are: `createBucket`.
@@ -609,7 +609,7 @@ Request body format:
}
```
-All fields (`websiteAccess` and `quotas`) are optionnal.
+All fields (`websiteAccess` and `quotas`) are optional.
If they are present, the corresponding modifications are applied to the bucket, otherwise nothing is changed.
In `websiteAccess`: if `enabled` is `true`, `indexDocument` must be specified.
diff --git a/src/garage/cli/structs.rs b/src/garage/cli/structs.rs
index 01ae92da..6e585e53 100644
--- a/src/garage/cli/structs.rs
+++ b/src/garage/cli/structs.rs
@@ -216,7 +216,7 @@ pub struct WebsiteOpt {
#[structopt(short = "i", long = "index-document", default_value = "index.html")]
pub index_document: String,
- /// Error document: the optionnal document returned when an error occurs
+ /// Error document: the optional document returned when an error occurs
#[structopt(short = "e", long = "error-document")]
pub error_document: Option<String>,
}
diff --git a/src/util/migrate.rs b/src/util/migrate.rs
index 1229fd9c..b9cce08a 100644
--- a/src/util/migrate.rs
+++ b/src/util/migrate.rs
@@ -27,7 +27,7 @@ pub trait Migrate: Serialize + for<'de> Deserialize<'de> + 'static {
Self::Previous::decode(bytes).map(Self::migrate)
}
- /// Encode this type with optionnal version marker
+ /// Encode this type with optional version marker
fn encode(&self) -> Result<Vec<u8>, rmp_serde::encode::Error> {
let mut wr = Vec::with_capacity(128);
wr.extend_from_slice(Self::VERSION_MARKER);