From 8d68dbd144f2bcb9d0c89f7e978f1fd55cb281fb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Luka=20T=2E=20Koro=C5=A1ec?= <pizmovc@gmail.com>
Date: Tue, 17 Aug 2021 22:12:00 +0200
Subject: [PATCH] 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.
---
 modules/programs/git.nix | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/modules/programs/git.nix b/modules/programs/git.nix
index 9175eb9c6..70fb3ecfd 100644
--- a/modules/programs/git.nix
+++ b/modules/programs/git.nix
@@ -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>.
         '';
       };
     };