nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

treewide: adjust some DocBook for conversion

Browse source 
The NixOS variant of Markdown doesn't make a distinction between
`<code>` and `<literal>` or `<quote>` and... quotes, and doesn't
support `<parameter>` or `<replaceable>`. These are infrequently used
(apart from `<code>`) and don't add much, so just convert them to
simpler forms to allow the options containing them to be converted
to Markdown automatically.

A few minor syntactic adjustments were also made to make
`nix-doc-munge`'s job easier.
This commit is contained in:
Emily 2023-06-30 05:48:21 +01:00
parent b5a65b91fb
commit c1d8d2a3d1
30 changed files with 72 additions and 85 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/misc/dconf.nix
View file

@ -37,7 +37,7 @@ in {
Whether to enable dconf settings.
</para><para>
Note, if you use NixOS then you must add
<code>programs.dconf.enable = true</code>
<literal>programs.dconf.enable = true</literal>
to your system configuration. Otherwise you will see a systemd error
message when your configuration is activated.
'';

2
modules/misc/editorconfig.nix
View file

@ -19,7 +19,7 @@ in {
default = { };
description = ''
Configuration written to <filename>$HOME/.editorconfig</filename>.
<code>root = true</code> is automatically added to the file,
<literal>root = true</literal> is automatically added to the file,
it must not be added here.
See <link xlink:href="https://editorconfig.org"/> for documentation.
'';

6
modules/misc/xdg-desktop-entries.nix
View file

@ -181,8 +181,10 @@ in {
options.xdg.desktopEntries = mkOption {
description = ''
Desktop Entries allow applications to be shown in your desktop environment's app launcher. </para><para>
You can define entries for programs without entries or override existing entries. </para><para>
Desktop Entries allow applications to be shown in your desktop environment's app launcher.
You can define entries for programs without entries or override existing entries.
See <link xlink:href="https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#recognized-keys" /> for more information on options.
'';
default = { };

2
modules/misc/xfconf.nix
View file

@ -67,7 +67,7 @@ in {
Whether to enable Xfconf settings.
</para><para>
Note, if you use NixOS then you must add
<code>programs.xfconf.enable = true</code>
<literal>programs.xfconf.enable = true</literal>
to your system configuration. Otherwise you will see a systemd error
message when your configuration is activated.
'';