Mercurial > irccd
annotate CONTRIBUTE.md @ 680:900ca2f95838
Irccd: do not allow multiple server with same name
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 12 Apr 2018 20:45:02 +0200 |
parents | c363c09e1f44 |
children | 8c44bbcbbab9 |
rev | line source |
---|---|
409
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 IRC Client Daemon CONTRIBUTING GUIDE |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 ==================================== |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 Read this guide if you want to contribute to irccd. The purpose of this document |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 is to describe the steps to submit a patch. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 You may submit a patch when: |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 - You want to fix a bug / typo, |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 - You want to add a new feature, |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 - You want to change something. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 There a lot of steps before submitting a patch. First, be sure to respect the |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 style defined in the STYLE.md file. We never accept patches that do not match |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 the rules. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 Subscribe to the mailing list |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 ----------------------------- |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 Discussion and patches are sent to the *irccd (at) malikania (dot) fr* mailing |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 list. You need to subscribe by dropping a mail to |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 *irccd+subscribe (at) malikania (dot) fr* first. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 Create your patch |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 ----------------- |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 Usually, when you create a patch, you should have your own copy of irccd in your |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 directory. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 The following steps assumes that you have already cloned the irccd repository |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 somewhere. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 **Note**: the recommended way is to create one unique revision. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
35 ### Quick way |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
36 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
37 If you plan to create a very small patch that consists of several lines, you can |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
38 use the following way by disabling the @ bookmark to avoid moving it. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
39 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
40 $ hg pull # fetch last changesets |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
41 $ hg up @ # update to the last revision |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
42 $ hg book -i @ # disable the @ bookmark (optional but recommended) |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
43 (edit some files) |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
44 $ hg commit # create a unique revision |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
45 $ hg email -r . # send a mail about the current revision (interactive) |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
46 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
47 ### Bookmark way |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
48 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
49 We use Mercurial bookmarks as our workflow but we do share only @ bookmark |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
50 except when a long feature is being developed in parallel. Otherwise bookmarks |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
51 stay locally most of the time. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
52 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
53 When you start working on a new feature, you **must** always start from the @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
54 bookmark. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
55 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 You can use this workflow if you plan to create a patch that consists of |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
57 multiple revisions. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
58 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 Example: |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
60 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
61 $ hg pull |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 $ hg up @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
63 $ hg book feature-xyz |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 (work) |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 $ hg commit |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
66 (work) |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 $ hg commit |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
68 $ hg email -r first:last |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
69 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 Here, you must specify **first** and **last** as the initial and last revisions |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
71 respectively. You can check these revisions using `hg log` (also try `hg log -G` |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 or the nice TortoiseHg interface). |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
73 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 Example, I've started to work on an a feature named **feature-xyz**, the log |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
75 looks like this: |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
76 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
77 changeset: 22:3fb15d8fc454 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
78 bookmark: feature-xyz |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 tag: tip |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
80 user: François Jean <fj@gmail.com> |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
81 date: Thu Dec 08 16:08:40 2016 +0100 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
82 summary: Irccdctl: do the same for irccdctl |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
83 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
84 changeset: 21:f27e577c5504 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
85 user: François Jean <fj@gmail.com> |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
86 date: Thu Dec 08 16:03:06 2016 +0100 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
87 summary: Irccd: added initial support for multiple connections |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
88 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
89 changeset: 20:777023816ff9 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
90 bookmark: @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
91 user: David Demelier <markand@malikania.fr> |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
92 date: Thu Dec 08 16:02:26 2016 +0100 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
93 summary: Misc: fix a bug |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
94 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
95 The two revisions I want to export are 21 and 22, so I use `hg email -r 21:22`, |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
96 once done, see the section below. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
97 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
98 Additional topics |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
99 ----------------- |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
100 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
101 ### Your patch is accepted |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
102 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
103 The safest choice is to just pull from the central repository and update to the |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
104 @ bookmark. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
105 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
106 $ hg pull |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
107 $ hg up @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
108 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
109 You can also call `hg rebase` (from rebase extension) to move your revisions on |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
110 top of upstream. If the patches were incorporated verbatim, they will be safely |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
111 discarded automatically. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
112 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
113 $ hg pull |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
114 $ hg up @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
115 $ hg rebase -b feature-xyz -d @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
116 $ hg book -d feature-xyz |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
117 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
118 If you didn't created a bookmark replace **feature-xyz** with your revision |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
119 number. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
120 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
121 Finally, if you prefer to remove the revisions you have created, use `hg strip` |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
122 like explained in the see section below. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
123 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
124 ### Your patch is discarded |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
125 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
126 For some reasons, your patch can not be integrated within the official |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
127 repository, you can remove the revisions you have commited or keep them. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
128 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
129 If you want to remove the revisions, you can use the `hg strip` command (from |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
130 the strip extension. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
131 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
132 **Warning**: it will **remove** the revisions from history so use with care. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
133 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
134 $ hg strip -r 21:22 # using the example above |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
135 $ hg book -d feature-xyz # delete the bookmark |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
136 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
137 You can just go back on the @ bookmark as it's the safest choice. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
138 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
139 $ hg pull # fetch changesets |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
140 $ hg up @ # update to @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
141 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
142 ### How to merge upstream code to continue my patch |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
143 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
144 Sometimes when you started working on a topic, you may need to pull changes from |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
145 the repository. The idea is to pull the changes and rebase your work on top of |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
146 it. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
147 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
148 You must run these commands while your bookmark is active |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
149 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
150 $ hg up feature-xyz |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
151 $ hg pull -B @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
152 $ hg rebase -b feature-xyz -d @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
153 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
154 ### I forgot to create a bookmark and accidentally moved the @ bookmark |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
155 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
156 If you forgot to create a custom bookmark or disable @ before committing, you |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
157 may have moved the @ bookmark in your repository. The `hg pull` command can |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
158 recover it. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
159 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
160 First, we create it now to point at your local revisions (optional). |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
161 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
162 $ hg book feature-xyz |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
163 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
164 Then, put it where it should be. |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
165 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
166 $ hg pull -B @ |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
167 |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
168 Now @ will be placed to the same revision as the central repository. If some |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
169 changesets have been pulled, you may look at the previous topic to rebase your |
c363c09e1f44
Misc: add CONTRIBUTE.md and STYLE.md
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
170 work on top of it. |