view contrib/win32/mercurial.ini @ 29859:a1092e2d70a3

help: internals topic for wire protocol

The Mercurial wire protocol is under-documented. This includes a lack
of source docstrings and comments as well as pages on the official
wiki.

This patch adds the beginnings of "internals" documentation on the
wire protocol.

The documentation should have nearly complete coverage on the
lower-level parts of the protocol, such as the different transport
mechanims, how commands and arguments are sent, capabilities, and,
of course, the commands themselves.

As part of writing this documentation, I discovered a number of
deficiencies in the protocol and bugs in the implementation. I've
started sending patches for some of the issues. I hope to send a lot
more.

This patch starts with the scaffolding for a new internals page.

; 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]>

; 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
; https://www.mercurial-scm.org/wiki/UsingExtensions
;
; Extensions shipped with Mercurial
;
[extensions]
;acl =
;blackbox =
;bugzilla =
;children =
;churn =
;color =
;convert =
;eol =
;extdiff =
;fetch =
;gpg =
;hgk =
;highlight = 
;histedit =
;interhg =
;largefiles =
;keyword =
;mq =
;notify =
;pager =
;patchbomb =
;progress =
;purge =
;rebase =
;record =
;relink =
;schemes =
;share =
;shelve =
;transplant =
;win32mbcs =
;zeroconf =

;
; 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' fnameescape(argv(0)) fnameescape(argv(1))"


[hgk]
; Replace the following with your path to hgk, uncomment it and 
; 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