mirror of
https://github.com/nix-community/home-manager
synced 2024-12-24 10:49:48 +01:00
doc: Add an example for a git includes section (#2275)
This adds an example for the `programs.git.includes.*.contents` section since it was a bit ambiguous as to what kind of format it expects.
This commit is contained in:
parent
7ef3db3730
commit
8d68dbd144
1 changed files with 18 additions and 0 deletions
|
@ -108,8 +108,26 @@ let
|
||||||
contents = mkOption {
|
contents = mkOption {
|
||||||
type = types.attrsOf types.anything;
|
type = types.attrsOf types.anything;
|
||||||
default = { };
|
default = { };
|
||||||
|
example = literalExample ''
|
||||||
|
{
|
||||||
|
user = {
|
||||||
|
email = "bob@work.example.com";
|
||||||
|
name = "Bob Work";
|
||||||
|
signingKey = "1A2B3C4D5E6F7G8H";
|
||||||
|
};
|
||||||
|
commit = {
|
||||||
|
gpgSign = true;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
'';
|
||||||
description = ''
|
description = ''
|
||||||
Configuration to include. If empty then a path must be given.
|
Configuration to include. If empty then a path must be given.
|
||||||
|
|
||||||
|
This follows the configuration structure as described in
|
||||||
|
<citerefentry>
|
||||||
|
<refentrytitle>git-config</refentrytitle>
|
||||||
|
<manvolnum>1</manvolnum>
|
||||||
|
</citerefentry>.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in a new issue