nix-community/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 11:36:05 +01:00
Code Activity

treewide: convert all option docs to Markdown

Browse source 
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

To reproduce this commit, run:

  $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
    nix shell nixpkgs#coreutils \
    -c find . -name '*.nix' \
    -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
This commit is contained in:
Emily 2023-07-01 00:30:13 +01:00
parent c1d8d2a3d1
commit 36a53d9f26
355 changed files with 3805 additions and 3886 deletions
Download patch file Download diff file Expand all files Collapse all files

37
modules/config/home-cursor.nix
View file

@ -11,39 +11,40 @@ let
package = mkOption {
type = types.package;
example = literalExpression "pkgs.vanilla-dmz";
description = "Package providing the cursor theme.";
description = lib.mdDoc "Package providing the cursor theme.";
};
name = mkOption {
type = types.str;
example = "Vanilla-DMZ";
description = "The cursor name within the package.";
description = lib.mdDoc "The cursor name within the package.";
};
size = mkOption {
type = types.int;
default = 32;
example = 64;
description = "The cursor size.";
description = lib.mdDoc "The cursor size.";
};
x11 = {
enable = mkEnableOption ''
x11 config generation for <option>home.pointerCursor</option>
'';
enable = mkEnableOption (lib.mdDoc ''
x11 config generation for {option}`home.pointerCursor`
'');
defaultCursor = mkOption {
type = types.str;
default = "left_ptr";
example = "X_cursor";
description = "The default cursor file to use within the package.";
description =
lib.mdDoc "The default cursor file to use within the package.";
};
};
gtk = {
enable = mkEnableOption ''
gtk config generation for <option>home.pointerCursor</option>
'';
enable = mkEnableOption (lib.mdDoc ''
gtk config generation for {option}`home.pointerCursor`
'');
};
};
};
@ -94,21 +95,21 @@ in {
home.pointerCursor = mkOption {
type = types.nullOr pointerCursorModule;
default = null;
description = ''
Cursor configuration. Set to <literal>null</literal> to disable.
</para><para>
description = lib.mdDoc ''
Cursor configuration. Set to `null` to disable.
Top-level options declared under this submodule are backend independent
options. Options declared under namespaces such as <literal>x11</literal>
options. Options declared under namespaces such as `x11`
are backend specific options. By default, only backend independent cursor
configurations are generated. If you need configurations for specific
backends, you can toggle them via the enable option. For example,
<xref linkend="opt-home.pointerCursor.x11.enable"/>
[](#opt-home.pointerCursor.x11.enable)
will enable x11 cursor configurations.
</para><para>
Note that this will merely generate the cursor configurations.
To apply the configurations, the relevant subsytems must also be configured.
For example, <xref linkend="opt-home.pointerCursor.gtk.enable"/> will generate
the gtk cursor configuration, but <xref linkend="opt-gtk.enable"/> needs
For example, [](#opt-home.pointerCursor.gtk.enable) will generate
the gtk cursor configuration, but [](#opt-gtk.enable) needs
to be set for it to be applied.
'';
};

12
modules/config/i18n.nix
View file

@ -40,14 +40,14 @@ in {
options = {
i18n.glibcLocales = mkOption {
type = types.path;
description = ''
Customized <literal>glibcLocales</literal> package providing
the <literal>LOCALE_ARCHIVE_*</literal> environment variable.
</para><para>
description = lib.mdDoc ''
Customized `glibcLocales` package providing
the `LOCALE_ARCHIVE_*` environment variable.
This option only applies to the Linux platform.
</para><para>
When Home Manager is configured with NixOS, the default value
will be set to <varname>i18n.glibcLocales</varname> from the
will be set to {var}`i18n.glibcLocales` from the
system configuration.
'';
example = literalExpression ''