improve various comments

3 files changed, 16 insertions, 12 deletions

diff --git a/bin/bstraph.sh b/bin/bstraph.sh
index e7e2abe9..31918036 100755
--- a/bin/bstraph.sh
+++ b/bin/bstraph.sh
@@ -17,7 +17,7 @@ STOWSHA256SUM="8b89d79939cf9ae87d2f223bb36a3b2d0c66775b62aeb9953c6d33dab40d3c2b
 
 # ---- Handle special case hosts
 
-# On athena, clone URLs are different as they come from /home/git (and
+# On athena, clone URLs are different as they come from /srv/git (and
 # pushInsteadOf won't work because that can't append the required
 # `.git').  So we must change to the athena branch now in order to get
 # a fixed .mrconfig.
diff --git a/bin/git-pull-safe b/bin/git-pull-safe
index c0bfe33e..1750230e 100755
--- a/bin/git-pull-safe
+++ b/bin/git-pull-safe
@@ -7,7 +7,7 @@
 
 # This script is based on the value of git_update set by the myrepos
 # dgit plugin.  That library uses an unconditional `git pull` to match
-# global myrepos conventions.  The main reason for having that script
+# global myrepos conventions.  The main reason for having this script
 # is to override that unconditional `git pull`
 
 set -e
diff --git a/home-mrconfig b/home-mrconfig
index e4cecbdb..256026a6 100644
--- a/home-mrconfig
+++ b/home-mrconfig
@@ -7,7 +7,8 @@
 # avoid hangs due to SSH connection sharing
 jobs = 1
 
-# custom actions to be configured repository-by-repository
+# custom actions to be configured repository-by-repository, that do
+# nothing by default
 git_sync = :
 git_rebase = :
 git_autoci = :
@@ -20,8 +21,10 @@ git_push = git push-all
 # files and stashes
 git_isclean = git is-clean
 
-# --- Experimental plugin for dgit repos
+# --- Plugin for dgit repos
 
+# actually shipped with upstream mr, but use an include command that
+# will always work
 include = cat ~/src/dotfiles/lib/mr/dgit
 
 # --- git-svn
@@ -30,13 +33,15 @@ include = [ -e "/usr/share/mr/git-svn" ] && cat /usr/share/mr/git-svn
 
 # --- Sensible pulls
 
-# Redefine git_update to avoid an unconditional `git pull` which can
+# Redefine git_update to avoid an unconditional `git pull`, which can
 # result in unwanted merge commits all over $HOME (this has to come
-# after we include the dgit lib, which also defines git_update)
+# after we include the dgit lib, which also redefines git_update)
 git_update = git pull-safe
 
 # --- Adam Spiers' plugin for managing dotfile symlinks with mr
 
+# actually shipped with upstream mr, but use an include command that
+# will always work
 include =
     # stow is not available on Windows
     if [ -e "$HOME/src/dotfiles/lib/mr/stow" \
@@ -198,8 +203,7 @@ checkout = git clone gcrypt::rsync://athena:/srv/gcrypt/priv.git priv
 stowable = true
 
 # this repository can't be checked out until we install
-# git-remote-gcrypt.  And thanks to gcrypt being slow, skip if I run
-# via fmr.
+# git-remote-gcrypt
 skip = (! gcrypt) || (! workstation)
 
 fixups =
@@ -229,10 +233,10 @@ pre_stow = homedir_mkdirs
 # --- hosts configuration
 
 [$HOME/src/propellor]
-# this has to be a full URL, as during a spin of a host, propellor
-# sets this as the remote in /usr/local/propellor and it must be
-# possible to pull from it without root having my .gitconfig checked
-# out
+# this has to be a full URL (rather than just 'athena:', as during a
+# spin of a host, propellor sets this as the remote in
+# /usr/local/propellor and it must be possible to pull from it without
+# root having my .gitconfig checked out
 checkout = git clone https://git.spwhitton.name/propellor propellor --branch spw3conf
 post_checkout =
     cd propellor