diff options
author | pennae <github@quasiparticle.net> | 2023-01-04 00:52:22 +0100 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2023-01-10 10:31:52 +0100 |
commit | 22144ba269f0dc9e7babe3d3720bfb5cc5330755 (patch) | |
tree | c3f939c04e0afe5db62123d161f87f10c066e62b | |
parent | d60f02b75353fd3a3c0537d04b9e0cd50a5ffb4c (diff) | |
download | nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.tar nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.tar.gz nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.tar.bz2 nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.tar.lz nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.tar.xz nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.tar.zst nixpkgs-22144ba269f0dc9e7babe3d3720bfb5cc5330755.zip |
nixos/manual: normalize <package> -> <literal>
markdown can only do <literal>, so normalize to that. without auto-linking to a package index the distinction is not very useful anyway.
-rw-r--r-- | nixos/modules/services/backup/borgbackup.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/databases/postgresql.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/development/blackfire.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/matrix/mjolnir.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/matrix/synapse.xml | 4 | ||||
-rw-r--r-- | nixos/modules/services/misc/sourcehut/sourcehut.xml | 8 | ||||
-rw-r--r-- | nixos/modules/services/web-apps/grocy.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/web-apps/nextcloud.xml | 8 | ||||
-rw-r--r-- | nixos/modules/services/web-apps/plausible.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/web-servers/garage-doc.xml | 2 | ||||
-rw-r--r-- | nixos/modules/services/x11/desktop-managers/pantheon.xml | 2 |
11 files changed, 18 insertions, 18 deletions
diff --git a/nixos/modules/services/backup/borgbackup.xml b/nixos/modules/services/backup/borgbackup.xml index 770a06b3783..370e80de217 100644 --- a/nixos/modules/services/backup/borgbackup.xml +++ b/nixos/modules/services/backup/borgbackup.xml @@ -205,7 +205,7 @@ sudo borg init --encryption=repokey-blake2 \ disk failure, ransomware and theft. </para> <para> - It can be installed in NixOS e.g. by adding <package>pkgs.vorta</package> + It can be installed in NixOS e.g. by adding <literal>pkgs.vorta</literal> to <xref linkend="opt-environment.systemPackages" />. </para> <para> diff --git a/nixos/modules/services/databases/postgresql.xml b/nixos/modules/services/databases/postgresql.xml index fc91e0dc4c0..6199684f1a3 100644 --- a/nixos/modules/services/databases/postgresql.xml +++ b/nixos/modules/services/databases/postgresql.xml @@ -54,7 +54,7 @@ services.postgresql.dataDir = "/data/postgresql"; <note> <para> - The steps below demonstrate how to upgrade from an older version to <package>pkgs.postgresql_13</package>. + The steps below demonstrate how to upgrade from an older version to <literal>pkgs.postgresql_13</literal>. These instructions are also applicable to other versions. </para> </note> diff --git a/nixos/modules/services/development/blackfire.xml b/nixos/modules/services/development/blackfire.xml index 1df6441f66f..3e8253d29ec 100644 --- a/nixos/modules/services/development/blackfire.xml +++ b/nixos/modules/services/development/blackfire.xml @@ -43,6 +43,6 @@ in { </programlisting> </para> <para> - On your developer machine, you will also want to install <link xlink:href="https://blackfire.io/docs/up-and-running/installation#install-a-profiling-client">the client</link> (see <package>blackfire</package> package) or the browser extension to actually trigger the profiling. + On your developer machine, you will also want to install <link xlink:href="https://blackfire.io/docs/up-and-running/installation#install-a-profiling-client">the client</link> (see <literal>blackfire</literal> package) or the browser extension to actually trigger the profiling. </para> </chapter> diff --git a/nixos/modules/services/matrix/mjolnir.xml b/nixos/modules/services/matrix/mjolnir.xml index 4e0f14a3c0b..34b5d4df1d2 100644 --- a/nixos/modules/services/matrix/mjolnir.xml +++ b/nixos/modules/services/matrix/mjolnir.xml @@ -97,7 +97,7 @@ uses across an entire homeserver. </para> <para> - To use the Antispam Module, add <package>matrix-synapse-plugins.matrix-synapse-mjolnir-antispam</package> + To use the Antispam Module, add <literal>matrix-synapse-plugins.matrix-synapse-mjolnir-antispam</literal> to the Synapse plugin list and enable the <literal>mjolnir.Module</literal> module. </para> <programlisting> diff --git a/nixos/modules/services/matrix/synapse.xml b/nixos/modules/services/matrix/synapse.xml index f25ef3b0ea1..35ec03250b7 100644 --- a/nixos/modules/services/matrix/synapse.xml +++ b/nixos/modules/services/matrix/synapse.xml @@ -122,7 +122,7 @@ in { <callout arearefs='ex-matrix-synapse-well-known-server'> <para> This section is not needed if the <link linkend="opt-services.matrix-synapse.settings.server_name">server_name</link> - of <package>matrix-synapse</package> is equal to the domain (i.e. + of <literal>matrix-synapse</literal> is equal to the domain (i.e. <literal>example.org</literal> from <literal>@foo:example.org</literal>) and the federation port is 8448. Further reference can be found in the <link xlink:href="https://matrix-org.github.io/synapse/latest/delegate.html">docs @@ -196,7 +196,7 @@ registration_shared_secret: your-very-secret-secret from <citerefentry><refentrytitle>nixops</refentrytitle><manvolnum>1</manvolnum></citerefentry> or <link xlink:href="https://github.com/Mic92/sops-nix/">sops-nix</link> to e.g. <filename>/run/secrets/matrix-shared-secret</filename> and ensure that it's readable - by <package>matrix-synapse</package>. + by <literal>matrix-synapse</literal>. </para> </listitem> <listitem> diff --git a/nixos/modules/services/misc/sourcehut/sourcehut.xml b/nixos/modules/services/misc/sourcehut/sourcehut.xml index a769ded524c..5f9cc75bc9f 100644 --- a/nixos/modules/services/misc/sourcehut/sourcehut.xml +++ b/nixos/modules/services/misc/sourcehut/sourcehut.xml @@ -53,7 +53,7 @@ in { environment = "production"; global-domain = fqdn; origin = "https://${fqdn}"; - # Produce keys with srht-keygen from <package>sourcehut.coresrht</package>. + # Produce keys with srht-keygen from sourcehut.coresrht. network-key = "/run/keys/path/to/network-key"; service-key = "/run/keys/path/to/service-key"; }; @@ -109,9 +109,9 @@ in { <section xml:id="module-services-sourcehut-httpd"> <title>Using an alternative webserver as reverse-proxy (e.g. <literal>httpd</literal>)</title> <para> - By default, <package>nginx</package> is used as reverse-proxy for <package>sourcehut</package>. - However, it's possible to use e.g. <package>httpd</package> by explicitly disabling - <package>nginx</package> using <xref linkend="opt-services.nginx.enable" /> and fixing the + By default, <literal>nginx</literal> is used as reverse-proxy for <literal>sourcehut</literal>. + However, it's possible to use e.g. <literal>httpd</literal> by explicitly disabling + <literal>nginx</literal> using <xref linkend="opt-services.nginx.enable" /> and fixing the <literal>settings</literal>. </para> </section> diff --git a/nixos/modules/services/web-apps/grocy.xml b/nixos/modules/services/web-apps/grocy.xml index dc56f63f5de..025c08721c6 100644 --- a/nixos/modules/services/web-apps/grocy.xml +++ b/nixos/modules/services/web-apps/grocy.xml @@ -31,7 +31,7 @@ </para> <para> The application's state is persisted at <literal>/var/lib/grocy/grocy.db</literal> in a - <package>sqlite3</package> database. The migration is applied when requesting the <literal>/</literal>-route + <literal>sqlite3</literal> database. The migration is applied when requesting the <literal>/</literal>-route of the application. </para> </section> diff --git a/nixos/modules/services/web-apps/nextcloud.xml b/nixos/modules/services/web-apps/nextcloud.xml index 8f75d2f7c5a..434df8f0d34 100644 --- a/nixos/modules/services/web-apps/nextcloud.xml +++ b/nixos/modules/services/web-apps/nextcloud.xml @@ -11,7 +11,7 @@ desktop client is packaged at <literal>pkgs.nextcloud-client</literal>. </para> <para> - The current default by NixOS is <package>nextcloud25</package> which is also the latest + The current default by NixOS is <literal>nextcloud25</literal> which is also the latest major version available. </para> <section xml:id="module-services-nextcloud-basic-usage"> @@ -192,9 +192,9 @@ <section xml:id="module-services-nextcloud-httpd"> <title>Using an alternative webserver as reverse-proxy (e.g. <literal>httpd</literal>)</title> <para> - By default, <package>nginx</package> is used as reverse-proxy for <package>nextcloud</package>. - However, it's possible to use e.g. <package>httpd</package> by explicitly disabling - <package>nginx</package> using <xref linkend="opt-services.nginx.enable" /> and fixing the + By default, <literal>nginx</literal> is used as reverse-proxy for <literal>nextcloud</literal>. + However, it's possible to use e.g. <literal>httpd</literal> by explicitly disabling + <literal>nginx</literal> using <xref linkend="opt-services.nginx.enable" /> and fixing the settings <literal>listen.owner</literal> & <literal>listen.group</literal> in the <link linkend="opt-services.phpfpm.pools">corresponding <literal>phpfpm</literal> pool</link>. </para> diff --git a/nixos/modules/services/web-apps/plausible.xml b/nixos/modules/services/web-apps/plausible.xml index 4d162c3c956..929d4db2291 100644 --- a/nixos/modules/services/web-apps/plausible.xml +++ b/nixos/modules/services/web-apps/plausible.xml @@ -15,7 +15,7 @@ <screen><prompt>$ </prompt>openssl rand -base64 64</screen> </para> <para> - After that, <package>plausible</package> can be deployed like this: + After that, <literal>plausible</literal> can be deployed like this: <programlisting> { services.plausible = { diff --git a/nixos/modules/services/web-servers/garage-doc.xml b/nixos/modules/services/web-servers/garage-doc.xml index 452b431a2cc..5d013034690 100644 --- a/nixos/modules/services/web-servers/garage-doc.xml +++ b/nixos/modules/services/web-servers/garage-doc.xml @@ -13,7 +13,7 @@ the global environment as <literal>garage-manage</literal>. </para> <para> - The current default by NixOS is <package>garage_0_8</package> which is also the latest + The current default by NixOS is <literal>garage_0_8</literal> which is also the latest major version available. </para> <section xml:id="module-services-garage-upgrade-scenarios"> diff --git a/nixos/modules/services/x11/desktop-managers/pantheon.xml b/nixos/modules/services/x11/desktop-managers/pantheon.xml index a0784c2f2e1..1ad5bfad578 100644 --- a/nixos/modules/services/x11/desktop-managers/pantheon.xml +++ b/nixos/modules/services/x11/desktop-managers/pantheon.xml @@ -22,7 +22,7 @@ services.xserver.displayManager.lightdm.enable = false; <programlisting> services.pantheon.apps.enable = false; </programlisting> - You can also use <xref linkend="opt-environment.pantheon.excludePackages"/> to remove any other app (like <package>elementary-mail</package>). + You can also use <xref linkend="opt-environment.pantheon.excludePackages"/> to remove any other app (like <literal>elementary-mail</literal>). </para> </section> <section xml:id="sec-pantheon-wingpanel-switchboard"> |