diff contrib/win32/mercurial.ini @ 9322:81900431589f

mercurial.ini: provide more useful info

* Add warning about not editing the site-wide file on Vista
* More detail about where to create user Mercurial.ini
* Provide examples for ssh tools
* List extensions, all disabled
* add [patch] section, for fixing patch behavior when using win32text
* example [extdiff] section, all disabled
* example [diff] section, all disabled

--- a/contrib/win32/mercurial.ini	Wed Aug 05 17:17:06 2009 -0700
+++ b/contrib/win32/mercurial.ini	Mon Aug 03 23:27:25 2009 -0500
@@ -1,30 +1,71 @@
-; System-wide Mercurial config file.  To override these settings on a
-; per-user basis, please edit the following file instead, where
-; USERNAME is your Windows user name:
-;   C:\Documents and Settings\USERNAME\Mercurial.ini
+; System-wide Mercurial config file.
+;
+; !!!  Do Not Edit This File !!!
+;
+; This file will be replaced by the installer on every upgrade.
+; Editing this file can cause strange side effects on Vista.
+;
+; http://bitbucket.org/tortoisehg/stable/issue/135
+;
+; To change settings you see in this file, override (or enable) them in
+; your user Mercurial.ini file, where USERNAME is your Windows user name:
+;
+; XP or older    - C:\Documents and Settings\USERNAME\Mercurial.ini
+; Vista or later - C:\Users\USERNAME\Mercurial.ini
+
 
 [ui]
+; editor used to enter commit logs, etc.  Most text editors will work.
 editor = notepad
 ; show changed files and be a bit more verbose if True
 ; verbose = True
-
+ 
 ; username data to appear in commits
 ; it usually takes the form: Joe User <[e-mail]>
 ; username = Joe User <[e-mail]>
 
-
-; By default, we try to encode and decode all files that do not
-; contain ASCII NUL characters.  What this means is that we try to set
-; line endings to Windows style on update, and to Unix style on
-; commit.  This lets us cooperate with Linux and Unix users, so
-; everybody sees files with their native line endings.
+; In order to push/pull over ssh you must specify an ssh tool
+;ssh = "C:\Progra~1\TortoiseSVN\bin\TortoisePlink.exe" -ssh -2
+;ssh = C:\cygwin\bin\ssh
 
+;
+; For more information about mercurial extensions, start here
+; http://www.selenic.com/mercurial/wiki/index.cgi/UsingExtensions
+;
+; Extensions shipped with Mercurial
+;
 [extensions]
-; The win32text extension is available and installed by default.  It
-; provides built-in Python hooks to perform line ending conversions.
-; This is normally much faster than running an external program.
-hgext.win32text =
+;acl =
+;alias =
+;bookmarks =
+;bugzilla =
+;children =
+;churn =
+;color =
+;convert =
+;extdiff =
+;fetch =
+;gpg =
+;graphlog = 
+;hgcia =
+;hgk =
+;highlight = 
+;interhg =
+;keyword =
+;mq =
+;notify =
+;pager =
+;parentrevspec =
+;patchbomb =
+;purge =
+;rebase =
+;record =
+;transplant =
+;win32mbcs =
+;win32text =
+;zeroconf =
 
+; To use cleverencode/cleverdecode, you must enable win32text extension
 
 [encode]
 ; Encode files that don't contain NUL characters.
@@ -44,10 +85,40 @@
 
 ; Alternatively, you can explicitly specify each file extension that
 ; you want decoded (any you omit will be left untouched), like this:
+
 ; **.txt = dumbdecode:
+
+[patch]
+; If you enable win32text filtering, you will want to enable this
+; line as well to allow patching to work correctly.
+
+; eol = crlf
+
+
+;
+; Define external diff commands
+;
+[extdiff]
+;cmd.bc3diff = C:\Program Files\Beyond Compare 3\BCompare.exe
+;cmd.vdiff = C:\Progra~1\TortoiseSVN\bin\TortoiseMerge.exe
+;cmd.vimdiff = gvim.exe
+;opts.vimdiff = -f '+next' '+execute "DirDiff ".argv(0)." ".argv(1)'
+
+
 [hgk]
 ; Replace the following with your path to hgk, uncomment it and 
-; install ActiveTcl (or another win32 port)
+; install ActiveTcl (or another win32 port like tclkit)
 ; path="C:\Program Files\Mercurial\Contrib\hgk.tcl"
+; vdiff=vdiff
+ 
 
+;
+; The git extended diff format can represent binary files, file
+; permission changes, and rename information that the normal patch format
+; cannot describe.  However it is also not compatible with tools which
+; expect normal patches. so enable git patches at your own risk.
+;
+[diff]
+;git = false
+;nodates = false