eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-23 18:29:47 +01:00
Code Issues Releases Wiki Activity

doc: Add an example for a git includes section (#2275)

Browse source 
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:
Luka T. Korošec 2021-08-17 22:12:00 +02:00 committed by GitHub
parent 7ef3db3730
commit 8d68dbd144
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
modules/programs/git.nix
View file

@ -108,8 +108,26 @@ let
contents = mkOption {
type = types.attrsOf types.anything;
default = { };
example = literalExample ''
{
user = {
email = "bob@work.example.com";
name = "Bob Work";
signingKey = "1A2B3C4D5E6F7G8H";
};
commit = {
gpgSign = true;
};
};
'';
description = ''
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>.
'';
};
};