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

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

41
modules/programs/bash.nix
View file

@ -27,25 +27,23 @@ in {
options = {
programs.bash = {
enable = mkEnableOption "GNU Bourne-Again SHell";
enable = mkEnableOption (lib.mdDoc "GNU Bourne-Again SHell");
enableCompletion = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Whether to enable Bash completion for all interactive Bash shells.
</para><para>
Note, if you use NixOS or nix-darwin and do not have Bash completion
enabled in the system configuration, then make sure to add
<programlisting language="nix">
```nix
environment.pathsToLink = [ "/share/bash-completion" ];
</programlisting>
```
to your system configuration to get completion for system packages.
Note, the legacy <filename>/etc/bash_completion.d</filename> path is
Note, the legacy {file}`/etc/bash_completion.d` path is
not supported by Home Manager.
'';
};
@ -53,33 +51,34 @@ in {
historySize = mkOption {
type = types.int;
default = 10000;
description = "Number of history lines to keep in memory.";
description = lib.mdDoc "Number of history lines to keep in memory.";
};
historyFile = mkOption {
type = types.nullOr types.str;
default = null;
description = "Location of the bash history file.";
description = lib.mdDoc "Location of the bash history file.";
};
historyFileSize = mkOption {
type = types.int;
default = 100000;
description = "Number of history lines to keep on file.";
description = lib.mdDoc "Number of history lines to keep on file.";
};
historyControl = mkOption {
type =
types.listOf (types.enum [ "erasedups" "ignoredups" "ignorespace" ]);
default = [ ];
description = "Controlling how commands are saved on the history list.";
description =
lib.mdDoc "Controlling how commands are saved on the history list.";
};
historyIgnore = mkOption {
type = types.listOf types.str;
default = [ ];
example = [ "ls" "cd" "exit" ];
description =
description = lib.mdDoc
"List of commands that should not be saved to the history list.";
};
@ -101,9 +100,9 @@ in {
"checkjobs"
];
example = [ "extglob" "-cdspell" ];
description = ''
description = lib.mdDoc ''
Shell options to set. Prefix an option with
"<literal>-</literal>" to unset.
"`-`" to unset.
'';
};
@ -111,7 +110,7 @@ in {
default = { };
type = types.attrs;
example = { MAILCHECK = 30; };
description = ''
description = lib.mdDoc ''
Environment variables that will be set for the Bash session.
'';
};
@ -125,7 +124,7 @@ in {
".." = "cd ..";
}
'';
description = ''
description = lib.mdDoc ''
An attribute set that maps aliases (the top level attribute names in
this option) to command strings or directly to build outputs.
'';
@ -134,7 +133,7 @@ in {
profileExtra = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra commands that should be run when initializing a login
shell.
'';
@ -143,7 +142,7 @@ in {
initExtra = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra commands that should be run when initializing an
interactive shell.
'';
@ -152,8 +151,8 @@ in {
bashrcExtra = mkOption {
default = "";
type = types.lines;
description = ''
Extra commands that should be placed in <filename>~/.bashrc</filename>.
description = lib.mdDoc ''
Extra commands that should be placed in {file}`~/.bashrc`.
Note that these commands will be run even in non-interactive shells.
'';
};
@ -161,7 +160,7 @@ in {
logoutExtra = mkOption {
default = "";
type = types.lines;
description = ''
description = lib.mdDoc ''
Extra commands that should be run when logging out of an
interactive shell.
'';