From 6809ac7a818051182090a09b94441070f01c4b3a Mon Sep 17 00:00:00 2001
From: Leonid Volnitsky <Leonid@Volnitsky.com>
Date: Mon, 16 Mar 2009 14:43:13 +0200
Subject: -- docs for external config, labels

---
 git-prompt.conf | 56 +++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 33 insertions(+), 23 deletions(-)

(limited to 'git-prompt.conf')

diff --git a/git-prompt.conf b/git-prompt.conf
index 3b29beb..64c158a 100644
--- a/git-prompt.conf
+++ b/git-prompt.conf
@@ -1,43 +1,55 @@
-# git-prompt.sh config
-# 
-# commented-out variales are default values
 
+###  GIT-PROMPT.SH CONFIG
+###
+###    lines commented-out with single '#' are default values
+###    lines commented-out with double '##' are examples
 
-#####  MODULES
-#git_module=on
-#svn_module=off
-#vim_module=on
 
+############################################################   MODULES
 
-###  Default objects are not displayed 
-#default_user=lvv 		
-#default_host="ahp"     		# remote host is always shown
-#default_domain="lvvnet"	
+# git_module=on
+# svn_module=off
+# vim_module=on
 
+# max_file_list_length=100	# in characters
 
-#####  dir, exit code, root color 
-#if [ 0`tput colors` -ge 8 ];  then		#  if terminal supports colors
+###########################################################   DEFAULT OBJECTS
+
+###  Default objects are not displayed.  Example:
+
+## default_user=lvv 		
+## default_host="ahp"     		# remote host is always shown
+## default_domain="lvvnet"	
+
+
+###########################################################   COLOR 
+
+###  directory, exit code, root color 
+
+# if [ 0`tput colors` -ge 8 ];  then		#  if terminal supports colors
 	#	dir_color=CYAN
 	#	rc_color=red
 	#	root_id_color=magenta
-#else						#  B/W terminal
+# else						#  B/W terminal
 	#	dir_color=bw_bold
 	#	rc_color=bw_bold
-#fi
+# fi
+
+
+#####  Per host color.  If not set, color derived from host-name  checksum)
+
+### variable name is uppercase-short-hostname with appended "_host_color"
+### Per host color.  If not set, color derived from host-name  checksum)
+### Example per-host-color config:  
 
-#####  Per host color  .If not set, color derived from host-name  checksum)
-## variable name is uppercase-short-hostname with appended "_host_color"
-## Per host color.  If not set, color derived from host-name  checksum)
-## Example per-host-color config:  
-##
 ##	    TASHA_host_color=cyan
 ##	       AL_host_color=green
 ##	      LVV_host_color=blue
 ##	      AHP_host_color=white
 
 
+#####  VCS (version control system)  state colors
 
-#####  VCS state colors
 #		 init_vcs_color=WHITE     # initial
 #		clean_vcs_color=blue      # nothing to commit (working directory clean)
 #	     modified_vcs_color=red       # Changed but not updated:
@@ -47,7 +59,5 @@
 #		   op_vcs_color=MAGENTA
 #	     detached_vcs_color=RED
 
-#	max_file_list_length=100
-
 
 : vim:ft=sh:
-- 
cgit v1.2.3