From: Simon Ruderich <simon@ruderich.org>
Date: Sat, 9 Feb 2013 20:15:25 +0000 (+0100)
Subject: vimrc: Minor documentation updates.
X-Git-Url: https://ruderich.org/simon/gitweb/?a=commitdiff_plain;h=0491e759328448a035d81ef9bc3c581833c9a7d8;p=config%2Fdotfiles.git

vimrc: Minor documentation updates.
---

diff --git a/vimrc b/vimrc
index 40e95ba..2f6a20a 100644
--- a/vimrc
+++ b/vimrc
@@ -1,6 +1,6 @@
 " Vim main configuration file.
 
-" Copyright (C) 2008-2012  Simon Ruderich
+" Copyright (C) 2008-2013  Simon Ruderich
 "
 " This file is free software: you can redistribute it and/or modify
 " it under the terms of the GNU General Public License as published by
@@ -21,7 +21,8 @@
 " Save 'runtimepath' in case it was changed by the system's configuration
 " files. Also save 'diff' as set all& resets it; but somehow later (after
 " sourcing the vimrc - for example in a VimEnter autocmd) it gets
-" automagically restored to the correct value.
+" automagically restored to the correct value. Not sure what exactly Vim is
+" doing there.
 if has('eval')
     let s:save_runtimepath = &runtimepath
     let s:save_diff = &diff
@@ -49,7 +50,7 @@ set encoding=utf-8
 set runtimepath-=~/.vim
 set runtimepath^=~/.vim,~/.vim/runtime
 
-" Don't store swap files in the same directory as the edited file. But only if
+" Don't store swap files in the same directory as the edited file, but only if
 " we have a "safe" writable directory available.
 if filewritable('~/.tmp') == 2 || filewritable('~/tmp') == 2
     set directory-=.
@@ -228,9 +229,9 @@ if exists('+spell') && has('syntax')
     set spelllang=en_us
 endif
 
-" Allow buffers with changes to be hidden. Very important for effective
+" Allow buffers with changes to be hidden. Very important for efficient
 " editing with multiple buffers. Prevents the "E37: No write since last change
-" (add ! to override)" warning when switching buffers.
+" (add ! to override)" warning when switching modified buffers.
 set hidden
 
 " When splitting vertically put the new window right of the current one.
@@ -891,11 +892,12 @@ if has('eval')
     " Path to cache directory. I prefer to keep generated files as local as
     " possible.
     let g:ctrlp_cache_dir = $HOME . '/.vim/cache/ctrlp'
-    " Permanent cache, cleared by a crontab entry.
+    " Permanent cache, cleared by a crontab entry. Use <F5> to update the
+    " cache manually.
     let g:ctrlp_clear_cache_on_exit = 0
 
 " FSWitch settings.
-    " Default don't work well for my projects.
+    " Defaults don't work well for my projects.
     augroup vimrc
         autocmd BufEnter *.cc let b:fswitchdst  = 'h'
                           \ | let b:fswitchlocs = './'
@@ -937,7 +939,8 @@ if has('autocmd')
 " Automatically disable 'paste' mode when leaving insert mode. Thanks to
 " Raimondi in #vim on Freenode (2010-08-14 23:01 CEST). Very useful as I only
 " want to paste once and then 'paste' gets automatically unset. InsertLeave
-" doesn't exist in older Vims.
+" doesn't exist in older Vims. Use "*p to paste X11's selection, no need for
+" 'paste' in this case.
         if exists('##InsertLeave')
             autocmd InsertLeave * set nopaste
         endif
@@ -1018,7 +1021,7 @@ if has('eval')
 " Convenient command to see the difference between the current buffer and the
 " file it was loaded from, thus the changes you made. Thanks to the
 " vimrc_example.vim file in Vim's source. Modified to use the same filetype
-" for the diffed file than the filetype for the original file.
+" for the diffed file as the filetype for the original file.
     if !exists(':DiffOrig')
         command DiffOrig
             \ let s:diff_orig_filetype = &filetype