hg/pyhgsh: README annotate

annotate README @ 631:a287f6cd9c6b

Update documentation of hg tag # HG changeset patch # User Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl> # Node ID 8fc9bfabae06cba91b05c265545bcce2654dab2f # Parent 7369ec5d93f2ffd490a43970edd9adf8d2bbe269 Update documentation of hg tag This updates the FAQ, manpage and adds hg tag to the list of commands in README. Index: hg/README ===================================================================

author	Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl>
date	Tue, 05 Jul 2005 18:23:34 -0800
parents	dd8b19114fe7
children	f597539c7abd

rev	line source
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	1 MERCURIAL QUICK-START
fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	2
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	3 Setting up Mercurial:
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	4
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	5 Note: some distributions fails to include bits of distutils by
205 d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	6 default, you'll need python-dev to install. You'll also need a C
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	7 compiler and a 3-way merge tool like merge, tkdiff, or kdiff3.
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	8
161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	9 First, unpack the source:
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	10
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	11 $ tar xvzf mercurial-<ver>.tar.gz
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	12 $ cd mercurial-<ver>
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	13
205 d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	14 To install system-wide:
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	15
161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	16 $ python setup.py install # change python to python2.3 if 2.2 is default
161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	17
205 d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	18 To install in your home directory (~/bin and ~/lib, actually), run:
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	19
161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	20 $ python2.3 setup.py install --home=~
507 dd8b19114fe7 README: mention lib64/ mpm@selenic.com parents: 445 diff changeset	21 $ export PYTHONPATH=${HOME}/lib/python # (or lib64/ on some systems)
dd8b19114fe7 README: mention lib64/ mpm@selenic.com parents: 445 diff changeset	22 $ export PATH=${HOME}/bin:$PATH # add these to your .bashrc
205 d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	23
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	24 And finally:
161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	25
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	26 $ hg # test installation, show help
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	27
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	28 If you get complaints about missing modules, you probably haven't set
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	29 PYTHONPATH correctly.
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	30
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	31 Setting up a Mercurial project:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	32
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	33 $ cd project/
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	34 $ hg init # creates .hg
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	35 $ hg status # show changes between repo and working dir
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	36 $ hg diff # generate a unidiff
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	37 $ hg addremove # add all unknown files and remove all missing files
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	38 $ hg commit # commit all changes, edit changelog entry
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	39 $ hg export <rev> # export a changeset as a diff
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	40
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	41 Mercurial will look for a file named .hgignore in the root of your
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	42 repository contains a set of regular expressions to ignore in file
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	43 paths.
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	44
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	45 Mercurial commands:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	46
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	47 $ hg help [command] # get online help
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	48 $ hg history # show changesets
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	49 $ hg log Makefile # show commits per file
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	50 $ hg update # check out the tip revision
3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	51 $ hg update <id> # check out a specified changeset
160 5c331d941c7f Update the README a bit mpm@selenic.com parents: 81 diff changeset	52 # IDs can be tags, revision numbers, or unique
5c331d941c7f Update the README a bit mpm@selenic.com parents: 81 diff changeset	53 # subsets of changeset hash numbers
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	54 $ hg add foo # add a new file for the next commit
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	55 $ hg remove bar # mark a file as removed
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	56 $ hg verify # check repo integrity
67 a182f2561c8e Add tag support mpm@selenic.com parents: 63 diff changeset	57 $ hg tags # show current tags
631 a287f6cd9c6b Update documentation of hg tag Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl> parents: 507 diff changeset	58 $ hg tag <name> # tag current tip with distributed tag <name>
a287f6cd9c6b Update documentation of hg tag Radoslaw Szkodzinski <astralstorm@gorzow.mm.pl> parents: 507 diff changeset	59 $ hg tag -l <name> # tag current tip with local tag <name>
81 17884f79d59d Add annotate and blame to the command list and README mpm@selenic.com parents: 67 diff changeset	60 $ hg annotate [files] # show changeset numbers for each file line
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	61
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	62 Branching and merging:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	63
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	64 $ cd ..
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	65 $ mkdir linux-work
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	66 $ cd linux-work
327 a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	67 $ hg init ../linux # create a new branch
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	68 $ hg update # populate the working directory
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	69 $ <make changes>
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	70 $ hg commit
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	71 $ cd ../linux
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	72 $ hg pull ../linux-work # pull changesets from linux-work
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	73 $ hg update -m # merge the new tip from linux-work into
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	74 # our working directory
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	75
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	76 Importing patches:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	77
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	78 Fast:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	79 $ patch < ../p/foo.patch
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	80 $ hg addremove
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	81 $ hg commit
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	82
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	83 Faster:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	84 $ patch < ../p/foo.patch
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	85 $ hg commit `lsdiff -p1 ../p/foo.patch`
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	86
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	87 Fastest:
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	88 $ cat ../p/patchlist \| xargs hg import -p1 -b ../p
9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	89
205 d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	90 Exporting a patch:
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	91
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	92 (make changes)
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	93 $ hg commit
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	94 $ hg tip
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	95 28237:747a537bd090880c29eae861df4d81b245aa0190
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	96 $ hg export 28237 > foo.patch # export changeset 28237
d255d99a7cbd README: integrate some changes from Kevin Smith mpm@selenic.com parents: 204 diff changeset	97
63 1c590d34bf61 Minor changes for release 0.4e mpm@selenic.com parents: 27 diff changeset	98 Network support:
1c590d34bf61 Minor changes for release 0.4e mpm@selenic.com parents: 27 diff changeset	99
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	100 # pull from the primary Mercurial repo
1 273ce12ad8f1 Update README to discuss remote pull, rsync, and the hg repo mpm@selenic.com parents: 0 diff changeset	101 foo$ hg init
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	102 foo$ hg pull http://selenic.com/hg/
3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	103 foo$ hg update # hg co works too
1 273ce12ad8f1 Update README to discuss remote pull, rsync, and the hg repo mpm@selenic.com parents: 0 diff changeset	104
160 5c331d941c7f Update the README a bit mpm@selenic.com parents: 81 diff changeset	105 # export your current repo via HTTP with browsable interface
5c331d941c7f Update the README a bit mpm@selenic.com parents: 81 diff changeset	106 foo$ hg serve -n "My repo" -p 80
5c331d941c7f Update the README a bit mpm@selenic.com parents: 81 diff changeset	107
327 a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	108 # pushing changes to a remote repo with SSH
a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	109 foo$ hg push ssh://user@example.com/~/hg/
a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	110
0 9117c6561b0b Add back links from file revisions to changeset revisions mpm@selenic.com parents: diff changeset	111 # merge changes from a remote machine
261 3dae0296551d Update README mpm@selenic.com parents: 241 diff changeset	112 bar$ hg pull http://foo/
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	113 bar$ hg update -m # merge changes into your working directory
63 1c590d34bf61 Minor changes for release 0.4e mpm@selenic.com parents: 27 diff changeset	114
160 5c331d941c7f Update the README a bit mpm@selenic.com parents: 81 diff changeset	115 # Set up a CGI server on your webserver
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	116 foo$ cp hgweb.cgi ~/public_html/hg/index.cgi
fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	117 foo$ emacs ~/public_html/hg/index.cgi # adjust the defaults
63 1c590d34bf61 Minor changes for release 0.4e mpm@selenic.com parents: 27 diff changeset	118
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	119 Symbolic repository names:
161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	120
327 a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	121 Mercurial uses an options file called ~/.hgrc. To track locations
a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	122 symbolically, add a section to it like this:
204 161cef501e8d README: integrate various changes and suggestions from Rafael Villar Burke mpm@selenic.com parents: 182 diff changeset	123
327 a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	124 [paths]
a9ad98a9c9bc Tweak README for branch, push, and .hgrc mpm@selenic.com parents: 261 diff changeset	125 main = http://selenic.com/hg
445 fe48ffa3665f README tidy-up mpm@selenic.com parents: 330 diff changeset	126 linux = http://www.kernel.org/hg/

Mercurial > hg > pyhgsh

annotate README @ 631:a287f6cd9c6b