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: manually convert some docs to Markdown

Browse source 
These files all have options that trip up the `nix-doc-munge`
conversion tool for one reason or another (syntax that clashes with
Markdown, options that were already using Markdown syntax despite not
being marked that way, output that differs slightly after conversion,
syntax too elaborate to convert with some cheap regular expressions,
...). Translate them manually and do a little copyediting to options
in the vicinity while we're at it.
This commit is contained in:
Emily 2023-06-30 23:35:51 +01:00
parent e2a1cb50d8
commit 3228f92b90
17 changed files with 242 additions and 213 deletions
Download patch file Download diff file Expand all files Collapse all files

22
nixos/common.nix
View file

@ -43,22 +43,20 @@ let
in {
options.home-manager = {
useUserPackages = mkEnableOption ''
useUserPackages = mkEnableOption (mdDoc ''
installation of user packages through the
<option>users.users.&lt;name&gt;.packages</option> option
'';
{option}`users.users.<name>.packages` option'');
useGlobalPkgs = mkEnableOption ''
using the system configuration's <literal>pkgs</literal>
useGlobalPkgs = mkEnableOption (mdDoc ''
using the system configuration's `pkgs`
argument in Home Manager. This disables the Home Manager
options <option>nixpkgs.*</option>
'';
options {option}`nixpkgs.*`'');
backupFileExtension = mkOption {
type = types.nullOr types.str;
default = null;
example = "backup";
description = ''
description = mdDoc ''
On activation move existing files by appending the given
file extension rather than exiting with an error.
'';
@ -68,8 +66,8 @@ in {
type = types.attrs;
default = { };
example = literalExpression "{ inherit emacs-overlay; }";
description = ''
Extra <literal>specialArgs</literal> passed to Home Manager. This
description = mdDoc ''
Extra `specialArgs` passed to Home Manager. This
option can be used to pass additional arguments to all modules.
'';
};
@ -78,7 +76,7 @@ in {
type = with types; listOf raw;
default = [ ];
example = literalExpression "[ { home.packages = [ nixpkgs-fmt ]; } ]";
description = ''
description = mdDoc ''
Extra modules added to all users.
'';
};
@ -90,7 +88,7 @@ in {
default = { };
# Prevent the entire submodule being included in the documentation.
visible = "shallow";
description = ''
description = mdDoc ''
Per-user Home Manager configuration.
'';
};