diff options
author | pennae <github@quasiparticle.net> | 2023-01-04 06:56:24 +0100 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2023-01-10 10:31:59 +0100 |
commit | 23ea73b4169d68c0d22c3d9aed6e2a692a793ff5 (patch) | |
tree | 393a187a611654ac8b341b10f86efa8cd05f2dfc /nixos/modules/services/databases | |
parent | 03c72f224cc721b359c5477aeef4bcfa185477bd (diff) | |
download | nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.tar nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.tar.gz nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.tar.bz2 nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.tar.lz nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.tar.xz nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.tar.zst nixpkgs-23ea73b4169d68c0d22c3d9aed6e2a692a793ff5.zip |
nixos/manual: enable smart quotes for all MD chapters
Diffstat (limited to 'nixos/modules/services/databases')
-rw-r--r-- | nixos/modules/services/databases/foundationdb.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/databases/foundationdb.xml | 16 | ||||
-rw-r--r-- | nixos/modules/services/databases/postgresql.nix | 2 | ||||
-rw-r--r-- | nixos/modules/services/databases/postgresql.xml | 8 |
4 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix index fdfe5a28f31..0cdb832e4bc 100644 --- a/nixos/modules/services/databases/foundationdb.nix +++ b/nixos/modules/services/databases/foundationdb.nix @@ -425,7 +425,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc foundationdb.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > foundationdb.xml` + # `pandoc foundationdb.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > foundationdb.xml` meta.doc = ./foundationdb.xml; meta.maintainers = with lib.maintainers; [ thoughtpolice ]; } diff --git a/nixos/modules/services/databases/foundationdb.xml b/nixos/modules/services/databases/foundationdb.xml index ae7a6dae955..e65458779d1 100644 --- a/nixos/modules/services/databases/foundationdb.xml +++ b/nixos/modules/services/databases/foundationdb.xml @@ -15,7 +15,7 @@ <emphasis>Available version(s):</emphasis> 5.1.x, 5.2.x, 6.0.x </para> <para> - FoundationDB (or "FDB") is an open source, distributed, + FoundationDB (or <quote>FDB</quote>) is an open source, distributed, transactional key-value store. </para> <section xml:id="module-services-foundationdb-configuring"> @@ -115,8 +115,8 @@ a@link> SSD-storage based database for development and basic usage. This storage engine is designed for SSDs and will perform poorly on HDDs; however it can handle far more data than the alternative - "memory" engine and is a better default choice for most - deployments. (Note that you can change the storage backend + <quote>memory</quote> engine and is a better default choice for + most deployments. (Note that you can change the storage backend on-the-fly for a given FoundationDB cluster using <command>fdbcli</command>.) </para> @@ -151,7 +151,7 @@ services.foundationdb.dataDir = "/data/fdb"; <para> FoundationDB worker processes typically require 4GB of RAM per-process at minimum for good performance, so this option is set - to 1 by default since the maximum amount of RAM is unknown. You're + to 1 by default since the maximum amount of RAM is unknown. You’re advised to abide by this restriction, so pick a number of processes so that each has 4GB or more. </para> @@ -282,7 +282,7 @@ fdbcli> coordinators auto FoundationDB uses a pluggable design to transport security, and out of the box it supports a LibreSSL-based plugin for TLS support. This plugin not only does in-flight encryption, but also - performs client authorization based on the given endpoint's + performs client authorization based on the given endpoint’s certificate chain. For example, a FoundationDB server may be configured to only accept client connections over TLS, where the client TLS certificate is from organization <emphasis>Acme @@ -303,7 +303,7 @@ fdbcli> coordinators auto </para> <para> After you have a key and certificate file in place, it is not - enough to simply set the NixOS module options -- you must also + enough to simply set the NixOS module options – you must also configure the <command>fdb.cluster</command> file to specify that a given set of coordinators use TLS. This is as simple as adding the suffix <command>:tls</command> to your cluster coordinator @@ -333,7 +333,7 @@ XXXXXX:XXXXXX@127.0.0.1:4500:tls </para> <para> However, a side effect of this is that the - <command>fdbbackup</command> command doesn't work properly for + <command>fdbbackup</command> command doesn’t work properly for local filesystem backups: FoundationDB uses a server process alongside the database processes to perform backups and copy the backups to the filesystem. As a result, this process is put under @@ -403,7 +403,7 @@ $ sudo -u foundationdb fdbbackup status -t default <section xml:id="module-services-foundationdb-options"> <title>Options</title> <para> - NixOS's FoundationDB module allows you to configure all of the + NixOS’s FoundationDB module allows you to configure all of the most relevant configuration options for <command>fdbmonitor</command>, matching it quite closely. A complete list of options for the FoundationDB module may be found diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix index b390199a851..9a9a083b7c3 100644 --- a/nixos/modules/services/databases/postgresql.nix +++ b/nixos/modules/services/databases/postgresql.nix @@ -586,7 +586,7 @@ in }; # Don't edit the docbook xml directly, edit the md and generate it: - # `pandoc postgresql.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > postgresql.xml` + # `pandoc postgresql.md -t docbook --top-level-division=chapter --extract-media=media -f markdown+smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > postgresql.xml` meta.doc = ./postgresql.xml; meta.maintainers = with lib.maintainers; [ thoughtpolice danbst ]; } diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index 4cb0dc929c6..7ca03264e36 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -23,7 +23,7 @@ services.postgresql.package = pkgs.postgresql_11; </programlisting> <para> Note that you are required to specify the desired version of - PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since + PostgreSQL (e.g. <literal>pkgs.postgresql_11</literal>). Since upgrading your PostgreSQL version requires a database dump and reload (see below), NixOS cannot provide a default value for <xref linkend="opt-services.postgresql.package"></xref> such as @@ -51,7 +51,7 @@ services.postgresql.dataDir = "/data/postgresql"; <para> Major PostgreSQL upgrades require a downtime and a few imperative steps to be called. This is the case because each major version - has some internal changes in the databases' state during major + has some internal changes in the databases’ state during major releases. Because of that, NixOS places the state into <filename>/var/lib/postgresql/<version></filename> where each <literal>version</literal> can be obtained like this: @@ -138,7 +138,7 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema </listitem> <listitem> <para> - After the upgrade it's advisable to analyze the new cluster. + After the upgrade it’s advisable to analyze the new cluster. </para> <itemizedlist> <listitem> @@ -228,7 +228,7 @@ self: super: { } </programlisting> <para> - Here's a recipe on how to override a particular plugin through an + Here’s a recipe on how to override a particular plugin through an overlay: </para> <programlisting> |