Mercurial > hg
diff hgext/hgk.py @ 5395:e73a83af7926
hgk: add basic usage and configuration documentation
author | Patrick Mezard <pmezard@gmail.com> |
---|---|
date | Fri, 05 Oct 2007 23:40:33 +0200 |
parents | c2ad1890fc53 |
children | 0145f9afb0e7 |
line wrap: on
line diff
--- a/hgext/hgk.py Tue Oct 02 23:28:04 2007 +0200 +++ b/hgext/hgk.py Fri Oct 05 23:40:33 2007 +0200 @@ -4,6 +4,46 @@ # # This software may be used and distributed according to the terms # of the GNU General Public License, incorporated herein by reference. +# +# The hgk extension allows browsing the history of a repository in a +# graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is +# not distributed with Mercurial.) +# +# hgk consists of two parts: a Tcl script that does the displaying and +# querying of information, and an extension to mercurial named hgk.py, +# which provides hooks for hgk to get information. hgk can be found in +# the contrib directory, and hgk.py can be found in the hgext +# directory. +# +# To load the hgext.py extension, add it to your .hgrc file (you have +# to use your global $HOME/.hgrc file, not one in a repository). You +# can specify an absolute path: +# +# [extensions] +# hgk=/usr/local/lib/hgk.py +# +# Mercurial can also scan the default python library path for a file +# named 'hgk.py' if you set hgk empty: +# +# [extensions] +# hgk= +# +# The hg view command will launch the hgk Tcl script. For this command +# to work, hgk must be in your search path. Alternately, you can +# specify the path to hgk in your .hgrc file: +# +# [hgk] +# path=/location/of/hgk +# +# hgk can make use of the extdiff extension to visualize +# revisions. Assuming you had already configured extdiff vdiff +# command, just add: +# +# [hgk] +# vdiff=vdiff +# +# Revisions context menu will now display additional entries to fire +# vdiff on hovered and selected revisions. import sys, os from mercurial import hg, fancyopts, commands, ui, util, patch, revlog