nix-community/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 19:46: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

12
modules/targets/darwin/keybindings.nix
View file

@ -15,16 +15,16 @@ in {
"^u" = "deleteToBeginningOfLine:";
"^w" = "deleteWordBackward:";
};
description = ''
description = lib.mdDoc ''
This will configure the default keybindings for text fields in macOS
applications. See
<link xlink:href="https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/EventOverview/TextDefaultsBindings/TextDefaultsBindings.html">Apple's documentation</link>
[Apple's documentation](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/EventOverview/TextDefaultsBindings/TextDefaultsBindings.html)
for more details.
<warning>
<para>Existing keybinding configuration will be wiped when using this
option.</para>
</warning>
::: {.warning}
Existing keybinding configuration will be wiped when using this
option.
:::
'';
};

2
modules/targets/darwin/search.nix
View file

@ -16,7 +16,7 @@ in {
options.targets.darwin.search = mkOption {
type = with types; nullOr (enum (attrNames searchEngines));
default = null;
description = "Default search engine.";
description = lib.mdDoc "Default search engine.";
};
config = mkIf (cfg.search != null) {

30
modules/targets/darwin/user-defaults/default.nix
View file

@ -41,18 +41,18 @@ in {
DSDontWriteUSBStores = true;
};
};
description = ''
Set macOS user defaults. Values set to <literal>null</literal> are
description = lib.mdDoc ''
Set macOS user defaults. Values set to `null` are
ignored.
<warning>
<para>Some settings might require a re-login to take effect.</para>
</warning>
::: {.warning}
Some settings might require a re-login to take effect.
:::
<warning>
<para>Some settings are only read from
<option>targets.darwin.currentHostDefaults</option>.</para>
</warning>
::: {.warning}
Some settings are only read from
{option}`targets.darwin.currentHostDefaults`.
:::
'';
};
@ -62,16 +62,16 @@ in {
example = {
"com.apple.controlcenter" = { BatteryShowPercentage = true; };
};
description = ''
Set macOS user defaults. Unlike <option>targets.darwin.defaults</option>,
description = lib.mdDoc ''
Set macOS user defaults. Unlike {option}`targets.darwin.defaults`,
the preferences will only be applied to the currently logged-in host. This
distinction is important for networked accounts.
Values set to <literal>null</literal> are ignored.
Values set to `null` are ignored.
<warning>
<para>Some settings might require a re-login to take effect.</para>
</warning>
::: {.warning}
Some settings might require a re-login to take effect.
:::
'';
};

59
modules/targets/darwin/user-defaults/opts-allhosts.nix
View file

@ -14,7 +14,7 @@ let
type = with types; nullOr bool;
default = null;
example = true;
description = "Whether to enable ${name}.";
description = lib.mdDoc "Whether to enable ${name}.";
};
safari = config."com.apple.Safari";
@ -26,25 +26,26 @@ in {
AppleLanguages = mkNullableOption {
type = with types; listOf str;
example = [ "en" ];
description = "Sets the language to use in the preferred order.";
description =
lib.mdDoc "Sets the language to use in the preferred order.";
};
AppleLocale = mkNullableOption {
type = types.str;
example = "en_US";
description = "Configures the user locale.";
description = lib.mdDoc "Configures the user locale.";
};
AppleMeasurementUnits = mkNullableOption {
type = types.enum [ "Centimeters" "Inches" ];
example = "Centimeters";
description = "Sets the measurement unit.";
description = lib.mdDoc "Sets the measurement unit.";
};
AppleTemperatureUnit = mkNullableOption {
type = types.enum [ "Celsius" "Fahrenheit" ];
example = "Celsius";
description = "Sets the temperature unit.";
description = lib.mdDoc "Sets the temperature unit.";
};
AppleMetricUnits = mkNullableEnableOption "the metric system";
@ -69,17 +70,17 @@ in {
DSDontWriteNetworkStores = mkNullableOption {
type = types.bool;
example = false;
description = ''
Disable use of <filename>.DS_Store</filename> files on network shares.
See <link xlink:href="https://support.apple.com/en-us/HT208209">the
official article</link> for more info.
description = lib.mdDoc ''
Disable use of {file}`.DS_Store` files on network shares.
See [the
official article](https://support.apple.com/en-us/HT208209) for more info.
'';
};
DSDontWriteUSBStores = mkNullableOption {
type = types.bool;
example = false;
description = ''
Disable use of <filename>.DS_Store</filename> files on thumb drives.
description = lib.mdDoc ''
Disable use of {file}`.DS_Store` files on thumb drives.
'';
};
};
@ -88,7 +89,7 @@ in {
tilesize = mkNullableOption {
type = types.int;
example = 64;
description = "Sets the size of the dock.";
description = lib.mdDoc "Sets the size of the dock.";
};
size-immutable = mkNullableEnableOption "locking of the dock size";
expose-group-apps = mkNullableEnableOption
@ -98,9 +99,9 @@ in {
"com.apple.menuextra.battery".ShowPercent = mkNullableOption {
type = types.enum [ "YES" "NO" ];
example = "NO";
description = ''
description = lib.mdDoc ''
This option no longer works on macOS 11 and later. Instead, use
<option>targets.darwin.currentHostDefaults.\"com.apple.controlcenter\".BatteryShowPercentage</option>.
{option}`targets.darwin.currentHostDefaults.\"com.apple.controlcenter\".BatteryShowPercentage`.
Whether to show battery percentage in the menu bar.
'';
@ -119,24 +120,24 @@ in {
WebKitDeveloperExtrasEnabledPreferenceKey = mkNullableOption {
type = types.bool;
description = ''
description = lib.mdDoc ''
Configures the web inspector.
<warning>
<para>Instead of setting this option directly, set
<option>IncludeDevelopMenu</option> instead.</para>
</warning>
::: {.warning}
Instead of setting this option directly, set
{option}`IncludeDevelopMenu` instead.
:::
'';
};
"WebKitPreferences.developerExtrasEnabled" = mkNullableOption {
type = types.bool;
description = ''
description = lib.mdDoc ''
Configures the web inspector.
<warning>
<para>Instead of setting this option directly, set
<option>IncludeDevelopMenu</option> instead.</para>
</warning>
::: {.warning}
Instead of setting this option directly, set
{option}`IncludeDevelopMenu` instead.
:::
'';
};
};
@ -144,13 +145,13 @@ in {
"com.apple.Safari.SandboxBroker" = {
ShowDevelopMenu = mkNullableOption {
type = types.bool;
description = ''
description = lib.mdDoc ''
Show the "Develop" menu in Safari's menubar.
<warning>
<para>Instead of setting this option directly, set
<option>"com.apple.Safari".IncludeDevelopMenu</option> instead.</para>
</warning>
::: {.warning}
Instead of setting this option directly, set
{option}`"com.apple.Safari".IncludeDevelopMenu` instead.
:::
'';
};
};

4
modules/targets/darwin/user-defaults/opts-currenthost.nix
View file

@ -12,7 +12,7 @@ let
type = with lib.types; nullOr bool;
default = null;
example = true;
description = "Whether to enable ${name}.";
description = lib.mdDoc "Whether to enable ${name}.";
};
in {
freeformType = with lib.types; attrsOf (attrsOf anything);
@ -21,7 +21,7 @@ in {
"com.apple.controlcenter".BatteryShowPercentage = mkNullableOption {
type = lib.types.bool;
example = true;
description = ''
description = lib.mdDoc ''
Whether to show battery percentage in the menu bar.
'';
};