Kiln » TortoiseHg » TortoiseHg
Clone URL:  
Pushed to one repository · View In Graph Contained in 0.9, 0.9.1, and 0.9.1.1

stable doc: add an extensions page describing bundled extensions

Changeset 05f388ae49eb…

Parent b870b8f1eaa9…

by Steve Borho

Changes to 3 files · Browse files at 05f388ae49eb Showing diff from parent b870b8f1eaa9 Diff from another changeset...

Change 1 of 1 Show Entire File doc/​source/​extensions.txt Stacked
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
@@ -0,0 +1,110 @@
+********** +Extensions +********** + +.. module:: extensions + :synopsis: Describe extensions bundled with TortoiseHg binary packages + +This chapter describes Mercurial extensions that are shipped with +TortoiseHg binary packages for Windows. These external extensions are +included as a convenience to users, so they can be easily enabled as +soon as they are needed. + +Hgfold +====== + +`hgfold <http://mercurial.selenic.com/wiki/CaseFoldExtension>`_ is a +Mercurial extension that helps Windows users deal with filename case +collisions on VFAT and NTFS. + +It adds options to the following Mercurial commands. Type +:command:`hg help <command>` for more information:: + + up - allows you to update to a revision with filename collisions + merge - allows you to merge with a changeset that would create filename collisions + +The extension does not currently do anything to prevent filename +collisions. See discussion on the Mercurial Wiki + +**Installation** + +To test the use of this plugin, you can specify it on the Mercurial +command line like this:: + + hg --config "extensions.fold=" status + +You may want to add it to your Mercurial.ini or a repository's hgrc like this:: + + [extensions] + fold= + +If you do this, you can omit the --config command-line option. + +**Warnings** + +Like all merge operations, fold.py has to change the parents of the +working directory. It is still in early testing, so use with caution. + +If you get an error about an unknown changeset after running +:command:`hg recover` try +:command:`hg debugsetparents <number of tip revision>`. +You can find the number of the tip revision by running :command:`hg log -l 2`. + +Hgcr-gui +======== + +CodeReview management tool + +* This extension allows you to manage reviews for your code in any project you like. +* It helps to keep the review management inside the mercurial. +* One can add files to the review, remove them and notify reviewr that files are ready for review. +* The reviewer can mark the code as 'completed' review cycle and return the message to the developer. +* The project manager can check the review status - which files are reviewd and which are not yet. +* The extension will automatically spot the files that were changed since their last review and notify about that. +* This extension uses GUI from TortoiseHg but also implements command line interface. +* Code review database is stored in .code-review file in your repository root directory as a map of file and revision when review was done. + +**Usage**:: + + hg cr [OPTIONS] [FILES] + + Code Review Plugin (requires Mercurial 1.3.x and TortoiseHg 0.9) + + options: + + -c --complete Mark CR as complete + -a --add Add files to CR list + -r --remove Remove files from CR list + -l --list Print files in CR list + + use "hg -v help cr" to show global options + +.. note:: + To start GUI don't give any options. + +**More Details** + +* I've implemented the review around files and not changesets, because at the end, + I want to be able to tell for the specific project if all the files went through + code review process or not - the project status. +* Suppose you have some project that you are in charge and many developers do + write code for it. And there is a group of reviewrs that review the developers code. +* Is is very difficult to keep track of changes developers do, but simple to find + out what files have already been reviewd (by reviewers) and what were not. +* Using this extension, Developer can mark his files (when finished development + process) as "Ready for review" and send notice to reviewer. +* Reviewer will pick up the changeset (because changesets are stored in the code + review database) and perform code review (put notes inside the developer's code). +* Afterwards Reviewr will mark the files as "Review Completed" and return the + notice to the developer. +* The project manager can follow every time what is going on with his/her project. + +**Installation** + +You may want to add it to your Mercurial.ini or a repository's hgrc like this:: + + [extensions] + hgcr-gui= + + +.. vim: noet ts=4
Change 1 of 1 Show Entire File doc/​source/​index.txt Stacked
 
18
19
20
 
21
22
23
 
18
19
20
21
22
23
24
@@ -18,6 +18,7 @@
  daily   settings   recovery + extensions   faq   debugging  
Change 1 of 1 Show Entire File doc/​source/​intro.txt Stacked
 
7
8
9
10
 
11
12
13
 
7
8
9
 
10
11
12
13
@@ -7,7 +7,7 @@
   What is TortoiseHg?  =================== - +  TortoiseHg is a set of graphical tools and a shell extension for the  `Mercurial <http://mercurial.selenic.com/wiki/>`_ distributed revision control  system.