From f50325e78ac8b7357b1fdb6f0026527680032352 Mon Sep 17 00:00:00 2001
From: Charles Hall <charles@computer.surgery>
Date: Mon, 12 Jun 2023 02:55:47 -0700
Subject: [PATCH] update doku (#3003)
Fixes malformed documentation generated by previous version.
---
Cargo.lock | 8 +++---
Cargo.toml | 2 +-
config/defaults.hjson | 63 +++++++++++++++++++++----------------------
3 files changed, 36 insertions(+), 37 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 881efdcd0..1008cdaa0 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1491,9 +1491,9 @@ checksum = "0688c2a7f92e427f44895cd63841bff7b29f8d7a1648b9e7e07a4a365b2e1257"
[[package]]
name = "doku"
-version = "0.20.0"
+version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "966b1227ac4d9d77f4d7e9507dd01c56ceaec6e35888661b54319123da47b159"
+checksum = "d018fadaf95088d2c12b66fe5b9d7c04a027b996c42a7b403b83fbd7a1c31531"
dependencies = [
"doku-derive",
"serde",
@@ -1503,9 +1503,9 @@ dependencies = [
[[package]]
name = "doku-derive"
-version = "0.20.0"
+version = "0.21.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "252ec56116f931b050b5d80512c2c76f4807a297dd95a93f37593dd7650868a5"
+checksum = "74073dd10495ce912909655131925b0459d49363751b93676148d843097fe825"
dependencies = [
"darling 0.13.4",
"proc-macro2",
diff --git a/Cargo.toml b/Cargo.toml
index f275ddbf8..621949278 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -77,7 +77,7 @@ reqwest = { version = "0.11.12", features = ["json", "blocking"] }
reqwest-middleware = "0.2.0"
reqwest-tracing = "0.4.0"
clokwerk = "0.3.5"
-doku = { version = "0.20.0", features = ["url-2"] }
+doku = { version = "0.21.1", features = ["url-2"] }
bcrypt = "0.13.0"
chrono = { version = "0.4.22", features = ["serde"], default-features = false }
serde_json = { version = "1.0.87", features = ["preserve_order"] }
diff --git a/config/defaults.hjson b/config/defaults.hjson
index a686cdfed..4c38ddd45 100644
--- a/config/defaults.hjson
+++ b/config/defaults.hjson
@@ -1,39 +1,38 @@
{
# settings related to the postgresql database
database: {
+ # Configure the database by specifying a URI
+ #
+ # This is the preferred method to specify database connection details since
+ # it is the most flexible.
+ # Connection URI pointing to a postgres instance
+ #
+ # This example uses peer authentication to obviate the need for creating,
+ # configuring, and managing passwords.
+ #
+ # For an explanation of how to use connection URIs, see [here][0] in
+ # PostgreSQL's documentation.
+ #
+ # [0]: https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6
+ uri: "postgresql:///lemmy?user=lemmy&host=/var/run/postgresql"
- # Configure the database by specifying a URI
- #
- # This is the preferred method to specify database connection details since
- # it is the most flexible.
- # Connection URI pointing to a postgres instance
- #
- # This example uses peer authentication to obviate the need for creating,
- # configuring, and managing passwords.
- #
- # For an explanation of how to use connection URIs, see [here][0] in
- # PostgreSQL's documentation.
- #
- # [0]: https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6
- uri: "postgresql:///lemmy?user=lemmy&host=/var/run/postgresql"
- // or
- # Configure the database by specifying parts of a URI
- #
- # Note that specifying the `uri` field should be preferred since it provides
- # greater control over how the connection is made. This merely exists for
- # backwards-compatibility.
- {
- # Username to connect to postgres
- user: "string"
- # Password to connect to postgres
- password: "string"
- # Host where postgres is running
- host: "string"
- # Port where postgres can be accessed
- port: 123
- # Name of the postgres database for lemmy
- database: "string"
- }
+ # or
+
+ # Configure the database by specifying parts of a URI
+ #
+ # Note that specifying the `uri` field should be preferred since it provides
+ # greater control over how the connection is made. This merely exists for
+ # backwards-compatibility.
+ # Username to connect to postgres
+ user: "string"
+ # Password to connect to postgres
+ password: "string"
+ # Host where postgres is running
+ host: "string"
+ # Port where postgres can be accessed
+ port: 123
+ # Name of the postgres database for lemmy
+ database: "string"
# Maximum number of active sql connections
pool_size: 5
}
--
GitLab