summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/databases
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2023-01-05 06:16:46 +0100
committerpennae <github@quasiparticle.net>2023-01-10 10:32:00 +0100
commitbf92eaebe4afd03f029292f8cf5efa333fd0078a (patch)
tree09d11e228801022c45c3edae5c609e291b3c206b /nixos/modules/services/databases
parentdc7788efb8bcbe68d1183cf7ee281186315802ca (diff)
nixos/manual: generate module chapters with md-to-db.sh
Diffstat (limited to 'nixos/modules/services/databases')
-rw-r--r--nixos/modules/services/databases/foundationdb.nix3
-rw-r--r--nixos/modules/services/databases/foundationdb.xml4
-rw-r--r--nixos/modules/services/databases/postgresql.nix3
-rw-r--r--nixos/modules/services/databases/postgresql.xml26
4 files changed, 16 insertions, 20 deletions
diff --git a/nixos/modules/services/databases/foundationdb.nix b/nixos/modules/services/databases/foundationdb.nix
index 0cdb832e4bc9..3d72d8ec6d27 100644
--- a/nixos/modules/services/databases/foundationdb.nix
+++ b/nixos/modules/services/databases/foundationdb.nix
@@ -424,8 +424,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`
+ # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
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 e65458779d1b..e4a012604215 100644
--- a/nixos/modules/services/databases/foundationdb.xml
+++ b/nixos/modules/services/databases/foundationdb.xml
@@ -6,7 +6,7 @@
</para>
<para>
<emphasis>Upstream documentation:</emphasis>
- <link xlink:href="https://apple.github.io/foundationdb/" role="uri">https://apple.github.io/foundationdb/</link>
+ <link xlink:href="https://apple.github.io/foundationdb/">https://apple.github.io/foundationdb/</link>
</para>
<para>
<emphasis>Maintainer:</emphasis> Austin Seipp
@@ -417,7 +417,7 @@ $ sudo -u foundationdb fdbbackup status -t default
FoundationDB is a complex piece of software, and requires careful
administration to properly use. Full documentation for
administration can be found here:
- <link xlink:href="https://apple.github.io/foundationdb/" role="uri">https://apple.github.io/foundationdb/</link>.
+ <link xlink:href="https://apple.github.io/foundationdb/">https://apple.github.io/foundationdb/</link>.
</para>
</section>
</chapter>
diff --git a/nixos/modules/services/databases/postgresql.nix b/nixos/modules/services/databases/postgresql.nix
index 9a9a083b7c3a..40a1acb39a3d 100644
--- a/nixos/modules/services/databases/postgresql.nix
+++ b/nixos/modules/services/databases/postgresql.nix
@@ -585,8 +585,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`
+ # Don't edit the docbook xml directly, edit the md and generate it using md-to-db.sh
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 7ca03264e366..6aa2a3812ffa 100644
--- a/nixos/modules/services/databases/postgresql.xml
+++ b/nixos/modules/services/databases/postgresql.xml
@@ -6,10 +6,10 @@
</para>
<para>
<emphasis>Upstream documentation:</emphasis>
- <link xlink:href="http://www.postgresql.org/docs/" role="uri">http://www.postgresql.org/docs/</link>
+ <link xlink:href="http://www.postgresql.org/docs/">http://www.postgresql.org/docs/</link>
</para>
<para>
- PostgreSQL is an advanced, free relational database. <!-- MORE -->
+ PostgreSQL is an advanced, free relational database.
</para>
<section xml:id="module-services-postgres-configuring">
<title>Configuring</title>
@@ -23,17 +23,17 @@ 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
- the most recent release of PostgreSQL.
+ <xref linkend="opt-services.postgresql.package" /> such as the
+ most recent release of PostgreSQL.
</para>
<para>
By default, PostgreSQL stores its databases in
<filename>/var/lib/postgresql/$psqlSchema</filename>. You can
override this using
- <xref linkend="opt-services.postgresql.dataDir"></xref>, e.g.
+ <xref linkend="opt-services.postgresql.dataDir" />, e.g.
</para>
<programlisting>
services.postgresql.dataDir = &quot;/data/postgresql&quot;;
@@ -122,7 +122,7 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema
the new one. You may supply arguments like
<literal>--jobs 4</literal> and <literal>--link</literal> to
speedup migration process. See
- <link xlink:href="https://www.postgresql.org/docs/current/pgupgrade.html" role="uri">https://www.postgresql.org/docs/current/pgupgrade.html</link>
+ <link xlink:href="https://www.postgresql.org/docs/current/pgupgrade.html">https://www.postgresql.org/docs/current/pgupgrade.html</link>
for details.
</para>
</listitem>
@@ -130,10 +130,9 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema
<para>
Change postgresql package in NixOS configuration to the one
you were upgrading to via
- <xref linkend="opt-services.postgresql.package"></xref>.
- Rebuild NixOS. This should start new postgres using upgraded
- data directory and all services you stopped during the
- upgrade.
+ <xref linkend="opt-services.postgresql.package" />. Rebuild
+ NixOS. This should start new postgres using upgraded data
+ directory and all services you stopped during the upgrade.
</para>
</listitem>
<listitem>
@@ -151,9 +150,8 @@ $ nix-instantiate --eval -A postgresql_13.psqlSchema
<para>
For PostgreSQL &lt; 14, run (as
<literal>su -l postgres</literal> in the
- <xref linkend="opt-services.postgresql.dataDir"></xref>,
- in this example
- <filename>/var/lib/postgresql/13</filename>):
+ <xref linkend="opt-services.postgresql.dataDir" />, in
+ this example <filename>/var/lib/postgresql/13</filename>):
</para>
<programlisting>
$ ./analyze_new_cluster.sh