From f77fd5e915479f630faa2698d300f2cd8eadd9bd Mon Sep 17 00:00:00 2001
From: Franck Cuny <franck@fcuny.net>
Date: Mon, 20 Jun 2022 14:37:52 -0700
Subject: doc(home/git): comment some of the options

Change-Id: I7c898923c423a30cbc5ba8ba79fb8b9e8e4d2d21
Reviewed-on: https://cl.fcuny.net/c/world/+/461
Reviewed-by: Franck Cuny <franck@fcuny.net>
Tested-by: CI
---
 home/git/default.nix | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'home')

diff --git a/home/git/default.nix b/home/git/default.nix
index 8188884..7ec9dcc 100644
--- a/home/git/default.nix
+++ b/home/git/default.nix
@@ -18,11 +18,15 @@ in
       extraConfig = {
         core.whitespace = "trailing-space,space-before-tab";
         color.ui = "true";
+        # abort if the remote branch does not match the local one
         push.default = "simple";
         init.defaultBranch = "main";
         pull.rebase = true;
         rebase = {
+          # Automatically create a temporary stash entry before the
+          # operation begins, and apply it after the operation ends.
           autoStash = true;
+          # Print a warning if some commits are removed
           missingCommitsCheck = "warn";
         };
         branch.autosetuprebase = "remote";
-- 
cgit 1.4.1