annotate hgscm/templates/workflow_guide.html @ 143:fc5a9f3e5479

Converted the workflow guide into html, added links and polished it.
author Arne Babenhauserheide <bab@draketo.de>
date Tue, 12 May 2009 06:20:17 +0200
parents text/learning_mercurial_in_workflows.txt@cf102ae37ad9
children 730b34064342
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
1 {% extends "base.html" %}
97
991719e0dbf5 Begun a workflow text.
Arne Babenhauserheide <bab@draketo.de>
parents:
diff changeset
2
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
3 {% load extras %}
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
4 {% block content %}
97
991719e0dbf5 Begun a workflow text.
Arne Babenhauserheide <bab@draketo.de>
parents:
diff changeset
5
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
6 <div class="row">
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
7 <div class="col big">
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
8
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
9
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
10 <h1>Learning Mercurial in Workflows</h1>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
11
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
12 <p>With Mercurial you can use a multitude of different workflows. This page shows some of them, including their use cases. It is intended to make it easy for Beginners of Version tracking to get going instantly and learn completely incrementally. It doesn't explain the concepts used, because there are already many other great resources doing that, for example <a title="Understanding Mercurial" href="http://www.selenic.com/mercurial/wiki/UnderstandingMercurial">the wiki</a> and <a title="Behind the Scenes" href="http://hgbook.red-bean.com/read/behind-the-scenes.html">the hgbook</a>.</p>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
13
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
14 <p>If you want a more exhaustive tutorial with the basics, please have a look at the <a title="Mercurial Tutorial" href="http://www.selenic.com/mercurial/wiki/Tutorial">Tutorial in the Mercurial Wiki</a>. For a really detailed and very nice to read description of Mercurial, please have a look at <a title="Mercurial: The definitive Guide" href="http://hgbook.red-bean.com/">Mercurial: The definitive Guide</a>.</p>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
15
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
16 <h2>Basic workflows</h2>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
17
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
18 <h3>Log keeping</h3>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
19
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
20 <h4>Use Case</h4>
101
7bcdd8b947fe workflows: small fixes.
Arne Babenhauserheide <bab@draketo.de>
parents: 100
diff changeset
21
128
98ba6ac8ac93 learning in workflows: renamed sysadmin workflow to 'log keeping'
Arne Babenhauserheide <bab@draketo.de>
parents: 126
diff changeset
22 The first workflow is also the easiest one: You want to use Mercurial to be able to look back when you did which changes.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
23
128
98ba6ac8ac93 learning in workflows: renamed sysadmin workflow to 'log keeping'
Arne Babenhauserheide <bab@draketo.de>
parents: 126
diff changeset
24 This workflow only requires an installed Mercurial and write access to some file storage (you almost definitely have that :) ). It shows the basic techniques for more complex workflows.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
25
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
26 <h4>Workflow</h4>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
27
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
28 <h5>Prepare MercuriaL</h5>
129
177b4120c26b learning in workflows: Added info how to set the username.
Arne Babenhauserheide <bab@draketo.de>
parents: 128
diff changeset
29
177b4120c26b learning in workflows: Added info how to set the username.
Arne Babenhauserheide <bab@draketo.de>
parents: 128
diff changeset
30 As first step, you should teach Mercurial your name. For that you open the file ~/.hgrc with a text-editor and add the ui section (user interaction) with your username:
177b4120c26b learning in workflows: Added info how to set the username.
Arne Babenhauserheide <bab@draketo.de>
parents: 128
diff changeset
31
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
32 <pre>[ui]
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
33 username = Mr. Johnson <johnson@smith.com></pre>
129
177b4120c26b learning in workflows: Added info how to set the username.
Arne Babenhauserheide <bab@draketo.de>
parents: 128
diff changeset
34
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
35 <h5>Initialize the project</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
36
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
37 <pre>$ hg init project</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
38
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
39 <h5>Add files and track them</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
40
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
41 <pre>$ cd project
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
42 $ (add files)
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
43 $ hg add </pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
44
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
45 Note: You can also go into an existing directory with files and init the repository there.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
46
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
47 <pre>$ cd project
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
48 $ hg init</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
49
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
50 Alternatively you can add only specific files instead of all files in the directory. Mercurial will then track only these files and won't know about the others. The following tells mercurial to track all files whose names begin with "file0" as well as file10, file11 and file12.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
51
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
52 <pre>$ hg add file0* file10 file11 file12</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
53
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
54 <h5>Save changes</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
55
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
56 <pre>$ (do some changes)</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
57
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
58 see which files changed, which have been added or removed, and which aren't tracked yet.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
59
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
60 <pre>$ hg status</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
61
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
62 see the exact changes.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
63
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
64 <pre>$ hg diff</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
65
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
66 commit the changes.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
67
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
68 <pre>$ hg commit</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
69
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
70 now an editor pops up and asks you for a commit message. Upon saving and closing the editor, your changes have been stored by Mercurial.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
71
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
72 Note: You can also supply the commit message directly via <hg>hg commit -m 'MESSAGE'</hg>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
73
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
74 <h5>Check your history</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
75
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
76 <pre>$ hg log</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
77
130
77b10482cc47 learning in workflows: How to see a specific patch.
Arne Babenhauserheide <bab@draketo.de>
parents: 129
diff changeset
78 This prints a list of changesets along with their date, the user who committed them (you) and their commit message.
77b10482cc47 learning in workflows: How to see a specific patch.
Arne Babenhauserheide <bab@draketo.de>
parents: 129
diff changeset
79
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
80 To see a certain diff, you can use the <hg>-p</hg> switch (--patch)
130
77b10482cc47 learning in workflows: How to see a specific patch.
Arne Babenhauserheide <bab@draketo.de>
parents: 129
diff changeset
81
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
82 <pre>$ hg log -p -r 3</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
83
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
84 <h3>Lone developer with linear history</h3>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
85
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
86 <h4>Use case</h4>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
87
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
88 The second workflow is still very easy: You're a lone developer and you want to use Mercurial to keep track of your own changes.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
89
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
90 It works just like the sysadmin workflow, with the difference that you go back to earlied changes at times.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
91
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
92 To start a new project, you initialize a repository, add your files and commit whenever you finished a part of your work.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
93
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
94 Also you check your history from time to time, so see how you progressed.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
95
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
96 <h4>Workflow</h4>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
97
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
98 <h5>Basics from log keeping</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
100 Init your project, add files, see changes and commit them.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
101
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
102 <pre>$ hg init project
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
103 $ cd project
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
104 $ (add files)
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
105 $ hg add # tell Mercurial to track all files
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
106 $ (do some changes)
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
107 $ hg diff # see changes
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
108 $ hg commit # save changes
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
109 $ hg log # see history</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
110
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
111 <h5>Seeing an earlier revision</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
112
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
113 Different from the sysadmin workflow, you'll want to go back in history at times and undo some changes, for example because it introduced a bug.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
114
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
115 To look at a previous version of your code, you can use update. Let's assume that you want to see revision 3.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
116
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
117 <pre>$ hg update 3</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
118
136
0364cfc00295 learning in workflows: Added identify and update to 'null'
Arne Babenhauserheide <bab@draketo.de>
parents: 135
diff changeset
119 Now your code is back at revision 3, the fourth commit (Mercurial starts counting at 0).
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
120 To check if you're really at that revision, you can use <hg>identify -n</hg>.
136
0364cfc00295 learning in workflows: Added identify and update to 'null'
Arne Babenhauserheide <bab@draketo.de>
parents: 135
diff changeset
121
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
122 <pre>$ hg identify -n</pre>
136
0364cfc00295 learning in workflows: Added identify and update to 'null'
Arne Babenhauserheide <bab@draketo.de>
parents: 135
diff changeset
123
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
124 Note: <hg>identify</hg> without options gives you the short form of a unique revision ID. That ID is what Mercurial uses internally. If you tell someone about the version you updated to, you should use that ID, since the numbers can be different for other people. If you want to know the reasons behind that, please read up Mercurials [basic concepts](). When you're at the most recent revision, <hg>hg identify -n</hg> will return "-1".
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
125
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
126 To update to the most recent revision, you can use "tip" as revision name.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
127
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
128 <pre>$ hg update tip</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
129
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
130 Note: If at any place any command complains, your best bet is to read what it tells you and follow that advice.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
131
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
132 Note: Instead of <hg>hg update</hg> you can also use the shorthand <hg>hg up</hg>. Similarly you can abbreviate <hg>hg commit</hg> to <hg>hg ci</hg>.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
133
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
134 Note: To get a revision devoid of files, just <hg>update</hg> to "null" via <hg>hg update null</hg>. That's the revision before any files were added.
136
0364cfc00295 learning in workflows: Added identify and update to 'null'
Arne Babenhauserheide <bab@draketo.de>
parents: 135
diff changeset
135
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
136 <h5>Fixing errors in earlier revisions</h5>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
137
137
defbaee4011c learning in workflows: two minor fixes.
Arne Babenhauserheide <bab@draketo.de>
parents: 136
diff changeset
138 When you find a bug in some earlier revision you have two options: either you can fix it in the current code, or you can go back in history and fix the code exactly where you did it, which creates a cleaner history.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
139
138
741911a6f770 learning in workflows: A bit of polishing.
Arne Babenhauserheide <bab@draketo.de>
parents: 137
diff changeset
140 To do it the cleaner way, you first update to the old revision, fix the bug and commit it. Afterwards you merge this revision and commit the merge. Don't worry, though: Merging in mercurial is fast and painless, as you'll see in an instant.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
141
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
142 Let's assume the bug was introduced in revision 3.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
143
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
144 <pre>$ hg update 3
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
145 $ (fix the bug)
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
146 $ hg commit</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
147
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
148 Now the fix is already stored in history. We just need to merge it with the current version of your code.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
149
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
150 <pre>$ hg merge</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
151
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
152 If there are conflicts use <hg>hg resolve</hg> - that's also what merge tells you to do in case of conflicts.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
153
133
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
154 First list the files with conflicts:
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
155
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
156 <pre>$ hg resolve --list</pre>
133
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
157
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
158 Then resolve them one by one. <hg>resolve</hg> attempts the merge again:
133
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
159
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
160 <pre>$ hg resolve conflicting_file
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
161 (fix it by hand, if necessary)</pre>
133
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
162
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
163 Mark the fixed file as resolved:
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
164
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
165 <pre>$ hg resolve --mark conflicting_file</pre>
133
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
166
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
167 Commit the merge, as soon as you resolved all conflicts. This step is also necessary if there were no conflicts!
5e1cff189630 learning in workflows: Fix: Moved the resolve explanation to the first mention of resolve.
Arne Babenhauserheide <bab@draketo.de>
parents: 132
diff changeset
168
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
169 <pre>$ hg commit</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
170
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
171 At this point, your fix is merged with all your other work, and you can just go on coding. Additionally the history shows clearly where you fixed the bug, so you'll always be able to check where the bug was.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
172
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
173 Note: Most merges will just work. You only need <hg>resolve</hg>, when <hg>merge</hg> complains.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
174
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
175 So now you can initialize repositories, save changes, update to previous changes and develop in a nonlinear history by committing in earlier changesets and merging the changes into the current code.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
176
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
177 <h3>Seperate features</h3>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
178
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
179 <h4>Use Case</h4>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
180
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
181 At times you'll be working on several features in parallel. If you want to avoid mixing incomplete code versions, you can create clones of your local repository and work on each feature in its own code directory.
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
182
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
183 After finishing your feature you then <hg>pull</hg> it back into your main directory and <hg>merge</hg> the changes.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
184
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
185 <h4>Workflow</h4>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
186
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
187 First create the feature clone and do some changes
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
188
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
189 <pre>$ hg clone project feature1
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
190 $ cd feature1
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
191 $ (do some changes and commits)</pre>
131
59b5985db58a learning in workflows: added 'incoming'
Arne Babenhauserheide <bab@draketo.de>
parents: 130
diff changeset
192
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
193 Now check what will come in when you <hg>pull</hg> from feature1, just like you can use <hg>diff</hg> before committing. The respective command for pulling is <hg>incoming</hg>
131
59b5985db58a learning in workflows: added 'incoming'
Arne Babenhauserheide <bab@draketo.de>
parents: 130
diff changeset
194
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
195 <pre>$ cd ../project
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
196 $ hg incoming ../feature1</pre>
131
59b5985db58a learning in workflows: added 'incoming'
Arne Babenhauserheide <bab@draketo.de>
parents: 130
diff changeset
197
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
198 Note: If you want to see the diffs, you can use <hg>hg incoming --patch</hg> just as you can do with <hg>hg log --patch</hg> for the changes in the repository.
131
59b5985db58a learning in workflows: added 'incoming'
Arne Babenhauserheide <bab@draketo.de>
parents: 130
diff changeset
199
59b5985db58a learning in workflows: added 'incoming'
Arne Babenhauserheide <bab@draketo.de>
parents: 130
diff changeset
200 If you like the changes, you pull them into the project
59b5985db58a learning in workflows: added 'incoming'
Arne Babenhauserheide <bab@draketo.de>
parents: 130
diff changeset
201
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
202 <pre>$ hg pull ../feature1</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
203
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
204 Now you have the history of feature1 inside your project, but the changes aren't yet visible. Instead they are only stored inside a ".hg" directory of the project (<a title="Behind the Scenes" href="http://hgbook.red-bean.com/read/behind-the-scenes.html">more information on the store</a>).
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
205
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
206 Note: From now on we'll use the name "repository" for a directory which has a .hg directory with Mercurial history.
101
7bcdd8b947fe workflows: small fixes.
Arne Babenhauserheide <bab@draketo.de>
parents: 100
diff changeset
207
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
208 If you didn't do any changes in the project, while you were working on feature1, you can just update to tip (<hg>hg update tip</hg>), but it is more likely that you'll have done some other changes in between changes. In that case, it's time for merging.
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
209
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
210 Merge feature1 into the project code:
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
211
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
212 <pre>$ hg merge</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
213
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
214 If there are conflicts use <hg>hg resolve</hg> - that's also what merge tells you to do in case of conflicts. After you <hg>merge</hg>, you have to <hg>commit</hg> explicitely to make your <hg>merge</hg> final
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
215
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
216 <pre>$ hg commit
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
217 (enter commit message, for example "merged feature1")</pre>
99
71ff3b94b20d Added workflows sysadmin, lone developer and seperate features.
Arne Babenhauserheide <bab@draketo.de>
parents: 97
diff changeset
218
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
219 You can create an arbitrary number of clones and also carry them around on USB sticks. Also you can use them to synchronize your files at home and at work, or between your desktop and your laptop.
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
220
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
221 Note: You also have to commit after a merge when there are no conflicts, because merging creates new history and you might want to attach a specific message to the merge (like "merge feature1").
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
222
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
223 <h3>Sharing changes</h3>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
224
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
225 <h4>Use Case</h4>
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
226
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
227 Now we go one step further: You are no longer alone, and you want to share your changes with others and include their changes.
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
228
104
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
229 The basic requirement for that is that you have to be able to see the changes of others.
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
230
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
231 Mercurial allows you to do that very easily by including a simple webserver from which you can <hg>pull</hg> changes just as you can pull changes from local clones.
104
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
232
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
233 Note: There are a few other ways to share changes, though. Instead of using the builtin webserver, you can also send the changes by email or setup a shared repository, to where you <hg>push</hg> changes instead of pulling them. We'll cover one of those later.
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
234
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
235 <h4>Workflow</h4>
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
236
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
237 <h5>Using the builtin webserver</h5>
104
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
238
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
239 This is the easiest way to quickly share changes.
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
240
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
241 First the one who wants to share his changes creates the webserver
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
242
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
243 <pre>$ hg serve</pre>
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
244
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
245 Now all others can point their browsers to his IP address (for example 192.168.178.100) at port 8000. They will then see all his history there and can sdecide if they want to pull his changes.
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
246
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
247 <pre>$ firefox http://192.168.178.100:8000</pre>
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
248
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
249 If they decide to include the changes, they just pull from the same URL
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
250
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
251 <pre>$ hg pull http://192.168.178.100:8000</pre>
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
252
106
cdcc94ca41e7 workflows: just polishing.
Arne Babenhauserheide <bab@draketo.de>
parents: 104
diff changeset
253 At this point you all can work as if you had pulled from a local repository. All the data is now in your individual repositories and you can merge the changes and work with them without needing any connection to the served repository.
100
6e29cdea7b3a Workflows: Added basic sharing of changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 99
diff changeset
254
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
255 <h5>Sending changes by email</h5>
104
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
256
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
257 Often you won't have direct access to the repository of someone else, be it because he's behind a restrictive firewall, or because you live in different timezones. You might also want to keep your changes confidential and prefer internal email (if you want additional protection, you can also encrypt the emails, for example with <a href="http://gnupg.org" title="GnuPG">GnuPG</a>).
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
258
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
259 In that case, you can easily export your changes as patches and send them by email.
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
260
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
261 Another reason to send them by email can be that your policy requires manual review of the changes when the other developers are used to reading diffs in emails. I'm sure you can think of more reasons.
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
262
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
263 Sending the changes via email is pretty straightforward with Mercurial. You just <hg>export</hg> your changes and attach (or copy paste) it in your email. Your collegues can then just <hg>import</hg> them.
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
264
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
265 First check which changes you want to export
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
266
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
267 <pre>$ cd project
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
268 $ hg log</pre>
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
269
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
270 We assume that you want to export changeset 3 and 4:
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
271
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
272 <pre>$ hg export 3 > change3.diff
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
273 $ hg export 4 > change4.diff</pre>
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
274
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
275 Now attach them to an email and your collegues can just run <hg>import</hg> on both diffs to get your full changes, including your user information.
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
276
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
277 To be careful, they first <hg>clone</hg> their repository to have an integration directory as sandbox
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
278
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
279 <pre>$ hg clone project integration
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
280 $ cd integration
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
281 $ hg import change3.diff
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
282 $ hg import change4.diff</pre>
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
283
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
284 That's it. They can now test your changes in feature clones. If they accept them, they <hg>pull</hg> the changes into the main repository
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
285
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
286 <pre>$ cd ../project
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
287 $ hg pull ../integration</pre>
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
288
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
289 Note: The <em>patchbomb</em> extension automates the email-sending, but you don't need it for this workflow.
108
ed683ad3947f learning in workflows: Send changes by email.
Arne Babenhauserheide <bab@draketo.de>
parents: 107
diff changeset
290
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
291 Note 2: You can also send around bundles, which are snippets of your actual history. Just create them via
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
292 <pre>$ hg bundle --base FIRST_REVISION_TO_BUNDLE changes.bundle</pre>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
293 Others can then get your changes by simply pulling them, as if your bundle were an actual repository
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
294 <pre>$ hg pull path/to/changes.bundle</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
295
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
296 <h5>Using a shared repository</h5>
104
03591004ed44 workflows: Added plan for sharing via email and via shared repo (bitbucket).
Arne Babenhauserheide <bab@draketo.de>
parents: 103
diff changeset
297
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
298 Sending changes by email might be the easiest way to reach people when you aren't yet part of the regular development team, but it creates additional workload: You have to <hg>bundle</hg> the changes, send mails and then <hg>import</hg> the bundles manually. Luckily there's an easier way which works quite well: The shared push repository.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
299
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
300 Till now we transferred all changes either via email or via <hg>pull</hg>. Now we use another otion: pushing. As the name suggests it's just the opposite of pulling: You <hg>push</hg> your changes into another repository.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
301
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
302 But to make use of it, we first need something we can push to.
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
303
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
304 By default <hg>hg serve</hg> doesn't allow pushing, since that would be a major security hole. You can allow pushing in the server, but that's no solution when you live in different timezones, so we'll go with another approach here: Using a shared repository, either on an existing shared server or on a service like <a title="BitBucket" href="http://bitbucket.org">BitBucket</a>. Doing so has a bit higher starting cost and takes a bit longer to explain, but it's well worth the effort spent.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
305
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
306 If you want to use an existing shared server, you can use <hg>serve</hg> there and <a title="How to allow pushing for hg serve" href="http://www.selenic.com/mercurial/wiki/HgWebDirStepByStep#head-746ca383e3a62df34279ec2fca888113497da022">allow pushing</a>. Also there are some other nice ways to <a title="Multiple Committers" href="http://www.selenic.com/mercurial/wiki/MultipleCommitters">allow pushing to a Mercurial repository</a>, including simple <a title="Setting up a shared Mercurial repository using SSH" href="http://www.selenic.com/mercurial/wiki/SharedSSH">access via SSH</a>.
135
8d069bba8cce learning in workflows: shared server now contains a bit more information for people with existing servers.
Arne Babenhauserheide <bab@draketo.de>
parents: 134
diff changeset
307
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
308 Otherwise you first need to setup a BitBucket Account. Just signup at <a title="BitBucket" href="http://bitbucket.org">BitBucket</a>. After signing up (and login) hover your mouse over "Repositories". There click the item at the bottom of the opening dialog which say "Create new".
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
309
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
310 Give it a name and a description. If you want to keep it hidden from the public, select "private".
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
311
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
312 <pre>$ firefox http://bitbucket.org</pre>
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
313
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
314 Now your repository is created and you see instructions for <hg>push</hg>ing to it. for that you'll use a command similar to the following (just with a different URL):
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
315
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
316 <pre>$ hg push https://bitbucket.org/ArneBab/hello/</pre>
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
317
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
318 (Replace the URL with the URL of your created repository. If your username is "Foo" and your repository is named "bar", the URL will be https://bitbucket.org/Foo/bar/)
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
319
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
320 Mercurial will ask for your BitBucket password, then <hg>push</hg> your code.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
321
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
322 Voilà, your code is online.
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
323
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
324 Note: You can also <a title="use SSH for pushing to BitBucket" href="http://bitbucket.org/help/UsingSSH">use SSH for pushing to BitBucket</a>.
135
8d069bba8cce learning in workflows: shared server now contains a bit more information for people with existing servers.
Arne Babenhauserheide <bab@draketo.de>
parents: 134
diff changeset
325
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
326 Now it's time to tell all your collegues to sign up at BitBucket, too.
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
327
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
328 After that you can click the "Admin" tab of your created repository and add the usernames of your collegues on the right side under "Permission: Writers". Now they are allowed to <hg>push</hg> code to the repository.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
329
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
330 (If you chose to make the repository private, you'll need to add them to "Permission: Readers", too)
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
331
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
332 If one of you now wants to publish changes, he'll simply <hg>push</hg> them to the repository, and all others get them by <hg>pull</hg>ing.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
333
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
334 Publish your changes:
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
335
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
336 <pre>$ hg push https://bitbucket.org/ArneBab/hello/</pre>
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
337
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
338 Pull others changes into your local repository:
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
339
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
340 <pre>$ hg pull https://bitbucket.org/ArneBab/hello/</pre>
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
341
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
342 People who join you in development can also just <hg>clone</hg> this repository, as if one of you were using <hg>hg serve</hg>:
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
343
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
344 <pre>$ hg clone https://bitbucket.org/ArneBab/hello/ hello</pre>
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
345
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
346 That local repository will automatically be configured to pull/push from/to the online repository, so new contributors can just use <hg>hg push</hg> and <hg>hg pull</hg> without an URL.
110
8c8c8aaaaad7 learning in workflows: added sharing changes.
Arne Babenhauserheide <bab@draketo.de>
parents: 108
diff changeset
347
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
348 Note: To make this workflow more scaleable, each one of you can have his own BitBucket repository and you can simply <hg>pull</hg> from the others repositories. That way you can easily establish workflows in which certain people act as integrators and finally <hg>push</hg> checked code to a shared pull repository from which all others pull.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
349
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
350 Note: You can also use this workflow with a shared server instead of BitBucket, either via SSH or via a shared directory. An example for an SSH URL with Mercurial is be ssh://hg@bitbucket.org/ArneBab/hello (for a shared server you'd replace the "hg" in the given URL with your username). When using a shared directory you just push as if the repository in the shared directory were on your local drive.
141
cf102ae37ad9 Added a note about using shared servers instead of bitbucket.org
Arne Babenhauserheide <bab@draketo.de>
parents: 140
diff changeset
351
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
352 <h3>Summary</h3>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
353
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
354 Now let's take a step back and look where we are.
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
355
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
356 With the commands you already know, a bit reading of <hg>hg help &lt;command&gt;</hg> and some evil script-fu you can already do almost everything you'll ever need to do when working with source code history. So from now on almost everything is convenience, and that's a good thing.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
357
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
358 First this is good, because it means, that you can now use most of the concepts which are utilized in more complex workflows.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
359
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
360 Second it aids you, because convenience lets you focus on your task instead of focussing on your tool. It helps you concentrate on the coding itself. Still you can always go back to the basics, if you want to.
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
361
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
362 A short summary of what you can do which can also act as a short check, if you still remember the meaning of the commands:
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
363
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
364 <h4>create a project</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
365
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
366 <pre>$ hg init project
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
367 $ cd project
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
368 $ (add some files)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
369 $ hg add
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
370 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
371 (enter the commit message)</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
372
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
373 <h4>do nonlinear development</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
374
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
375 <pre>$ (do some changes)
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
376 $ hg commit
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
377 (enter the commit message)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
378 $ hg update 0
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
379 $ (do some changes)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
380 $ hg commit
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
381 (enter the commit message)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
382 $ hg merge
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
383 $ (optionally hg resolve)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
384 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
385 (enter the commit message)</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
386
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
387 <h4>use feature clones</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
388
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
389 <pre>$ cd ..
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
390 $ hg clone project feature1
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
391 $ cd feature1
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
392 $ (do some changes)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
393 $ hg commit
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
394 (enter the commit message)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
395 $ cd ../project
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
396 $ hg pull ../feature1</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
397
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
398 <h4>share your repository via the integrated webserver</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
399
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
400 <pre>$ hg serve &amp;
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
401 $ cd ..
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
402 $ hg clone http://127.0.0.1:8000 project-clone</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
403
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
404 <h4>export changes to files</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
405
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
406 <pre>$ cd project-clone
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
407 $ (do some changes)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
408 $ hg commit
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
409 (enter the commit message)
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
410 $ hg export tip > ../changes.diff</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
411
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
412 <h4>import changes from files</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
413
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
414 <pre>$ cd ../project
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
415 $ hg import ../changes.diff</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
416
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
417 <h4>pull changes from a served repository (hg serve still runs on project)</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
418
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
419 <pre>$ cd ../feature1
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
420 $ hg pull http://127.0.0.1:8000</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
421
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
422 <h4>Use shared repositories on BitBucket</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
423
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
424 <pre>$ (setup bitbucket repo)
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
425 $ hg push https://bitbucket.org/USER/REPO
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
426 (enter name and password in the prompt)
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
427 $ hg pull https://bitbucket.org/USER/REPO</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
428
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
429
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
430 Let's move on towards useful features and a bit more advanced workflows.
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
431
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
432 <h3>Backing out bad revisions</h3>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
433
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
434 <h4>Use Case</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
435
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
436 When you routinely pull code from others, it can happen that you overlook some bad change. As soon as others pull that change from you, you have little chance to get completely rid of it.
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
437
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
438 To resolve that problem, Mercurial offers you the <hg>backout</hg> command. Backing out a change means, that you tell Mercurial to create a commit which reverses the bad change. That way you don't get rid of the bad code in history, but you can remove it from new revisions.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
439
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
440 Note: The basic commands don't directly rewrite history. If you want to do that, you need to activate some of the extensions which are shipped with mercurial. We'll come to that later on.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
441
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
442 <h4>Workflow</h4>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
443
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
444 Let's assume the bad change was revision 3, and we already have one more revision in our repository. To remove the bad code, we just <hg>backout</hg> of it. This creates a new change which reverses the bad change. After backing out, we merge that new change into the current code.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
445
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
446 <pre>$ hg backout 3
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
447 $ hg merge
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
448 (potentially resolve conflicts)
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
449 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
450 (enter commit message. For example: "merged backout")</pre>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
451
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
452 That's it. You reversed the bad change. It's still recorded that it was once there (following the principle "don't rewrite history, if it's not really necessary"), but it doesn't affect future code anymore.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
453
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
454 <h3>Collaborative feature development</h3>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
455
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
456 Now that we can share changes and reverse them if necessary, we go one step further: Using Mercurial to help in coordinating the coding.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
457
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
458 The first part is an easy way to develop features together, without requiring every developer to keep track of several feature clones.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
459
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
460 <h4>Use Case</h4>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
461
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
462 When you want to split your development into several features, you need to keep track of who works on which feature and where to get which changes.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
463
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
464 Mercurial makes this easy for you by providing named branches. They are a part of the main repository, so they are available to everyone involved. At the same time, changes committed on a certain branch don't get mixed with the changes in the default branch, so features are kept separate, until they get merged into the default branch.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
465
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
466 Note: Cloning a repository always puts you onto the default branch at first.
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
467
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
468 <h4>Workflow</h4>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
469
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
470 When someone in your group wants to start coding on a feature without disturbing the others, he can create a named branch and commit there. When someone else wants to join in, he just updates to the branch and commits away. As soon as the feature is finished, someone merges the named branch into the default branch.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
471
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
472 <h5>Working in a named branch</h5>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
473
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
474 Create the branch:
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
475
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
476 <pre>$ hg branch feature1
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
477 (do some changes)
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
478 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
479 (write commit message)</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
480
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
481 Update into the branch and work in it:
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
482
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
483 <pre>$ hg update feature1
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
484 (do some changes)
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
485 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
486 (write commit message)</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
487
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
488 Now you can <hg>commit</hg>, <hg>pull</hg>, <hg>push</hg> and <hg>merge</hg> (and anything else) as if you were working in a separate repository. If the history of the named branch is linear and you call "hg merge", Mercurial asks you to specify an explicit revision, since the branch in which you work doesn't have anything to merge.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
489
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
490 <h5>Merge the named branch</h5>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
491
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
492 When you finished the feature, you <hg>merge</hg> the branch back into the default branch.
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
493
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
494 <pre>$ hg update default
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
495 $ hg merge feature1
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
496 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
497 (write commit message)</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
498
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
499 And that's it. Now you can easily keep features separate without unnecessary bookkeeping.
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
500
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
501 Note: Named branches stay in history as permanent record after you finished your work. If you don't like having that record in your history, please have a look at some of the advanced <a title="Mercurial Workflows" href="http://www.selenic.com/mercurial/wiki/Workflows">workflows</a>.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
502
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
503 <h3>Marking revisions: tag and sign</h3>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
504
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
505 <h4>Use Case</h4>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
506
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
507 Since you can now code separate features more easily, you might want to mark certain revisions as fit for consumption (or similar). For example you might want to mark releases, or just mark off revisions as reviewed.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
508
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
509 For this Mercurial offers tags. Tags add a name to a revision and are part of the history. You can tag a change years after it was committed. The tag includes the information when it was added, and tags can be pulled, pushed and merged just like any other committed change.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
510
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
511 Note: A tag must not contain the char ":", since that char is used for specifying multiple reivions - see "hg help revisions".
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
512
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
513 Note: To securely mark a revision, you can use the <a title="Using GnuPG to securely sign revisions in Mercurial" href="http://www.selenic.com/mercurial/wiki/GpgExtension">gpg extension</a> to sign the tag.
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
514
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
515 <h4>Workflow</h4>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
516
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
517 Let's assume you want to give revision 3 the name "v0.1".
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
518
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
519 Add the tag:
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
520
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
521 <pre>$ hg tag -r 3 v0.1</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
522
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
523 See all tags:
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
524
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
525 <pre>$ hg tags</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
526
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
527 When you look at the log you'll now see a line in changeset 3 which marks the Tag. If someone wants to <hg>update</hg> to the tagged revision, he can just use the name of your tag:
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
528
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
529 <pre>$ hg update v0.1</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
530
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
531 Now he'll be at the tagged revision and can work from there.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
532
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
533
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
534 <h3>Removing history</h3>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
535
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
536 <h4>Use Case</h4>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
537
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
538 At times you will have changes in your repository, which you really don't want in it.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
539
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
540 There are many advanced options for removing these, and most of them use great extensions (<a title="Mercurial Queues Extension" href="http://www.selenic.com/mercurial/wiki/MqExtension">Mercurial Queues</a> is the most often used one), but in this basic guide, we'll solve the problem with just the commands we already learned. But we'll use an option to clone which we didn't yet use.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
541
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
542 This workflow becomes inconvenient when you need to remove changes, which are buried below many new changes. If you spot the bad changes early enough, you can get rid of them without too much effort, though.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
543
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
544 <h4>Workflow</h4>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
545
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
546 Let's assume you want to get rid of revision 2 and the highest revision is 3.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
547
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
548 The first step is to use the "--rev" option to <hg>clone</hg>: Create a clone which only contains the changes up to the specified revision. Since you want to keep revision 1, you only clone up to that.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
549
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
550 $ hg clone -r 1 project stripped
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
551
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
552 Now you can <hg>export</hg> the change 3 from the original repository (project) and <hg>import</hg> it into the stripped one.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
553
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
554 <pre>$ cd project
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
555 $ hg export 3 > ../changes.diff
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
556 $ cd ../stripped
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
557 $ hg import ../changes.diff</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
558
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
559 If a part of the changes couldn't be applied, you'll see that part in *.rej files. If you have *.rej files, you'll have to include or discard changes by hand.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
560
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
561 <pre>$ cat *.rej
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
562 (apply changes by hand)
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
563 $ hg commit
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
564 (write commit message)</pre>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
565
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
566 That's it. <hg>hg export</hg> also includes the commit message, date, committer and similar metadata, so you are already done.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
567
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
568 Note: removing history will change the revision IDs of revisions after the removed one, and if you pull from someone else who still has the revision you removed, you will pull the removed parts again. That's why rewriting history should most times only be done for changes which you didn't yet publicise.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
569
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
570 <h3>Summary</h3>
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
571
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
572 So now you can work with Mercurial in private, and also share your changes in a multitude of ways.
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
573
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
574 Additionally you can also remove bad changes, either by creating a change in the repository which reverses the original change, or by really rewriting history, so it looks like the change never occured.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
575
132
a7fb926c69f6 learning in workflows: fixed soem typos and did some clarifications.
Arne Babenhauserheide <bab@draketo.de>
parents: 131
diff changeset
576 And you can separate the work on features in a single repository by using named branches and add tags to revisions which are visible markers for others and can be used to update to the tagged revisions.
124
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
577
0bee8982f334 learning in workflows mostly finished - I hope :) .
Arne Babenhauserheide <bab@draketo.de>
parents: 115
diff changeset
578 With this we can conclude our practical guide.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
579
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
580 <h2>More Complex Workflows</h2>
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
581
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
582 If you now want to check some more complex workflows, please have a look at the general <a title="Mercurial Workflows" href="http://selenic.com/mercurial/wiki/Workflows">workflows wikipage</a>.
139
2fcd14a3b9f9 learning in workflows: Added a link to the (not yet written) basic concept overview for understanding.
Arne Babenhauserheide <bab@draketo.de>
parents: 138
diff changeset
583
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
584 To deepen your understanding, you should also check the <a title="Overview of the basic concepts of Mercurial" href="quick_start_concepts">basic concept overview</a>.
111
8b51ceb2d36b learning in workflows: Added backout.
Arne Babenhauserheide <bab@draketo.de>
parents: 110
diff changeset
585
140
67b0602c837b Added correct URL to the general workflows wikipage.
Arne Babenhauserheide <bab@draketo.de>
parents: 139
diff changeset
586 Have fun with Mercurial!
143
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
587
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
588
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
589
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
590 <div class="col">
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
591 {% download_button %}
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
592 {% mercurial_tricks %}
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
593 </div>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
594 </div>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
595
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
596 </div>
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
597
fc5a9f3e5479 Converted the workflow guide into html, added links and polished it.
Arne Babenhauserheide <bab@draketo.de>
parents: 141
diff changeset
598 {% endblock %}