Proc-errata » History » Version 1
David Demelier, 02/13/2017 01:00 PM
1 | 1 | David Demelier | h1. Proc-errata |
---|---|---|---|
2 | |||
3 | An errata has to be written when a bug is found in a release. |
||
4 | |||
5 | h2. Create a task |
||
6 | |||
7 | Create a task with *Bug* as tracker, mark it as *Urgent* and specify the current release branch in the custom field. |
||
8 | |||
9 | h2. Write the fix |
||
10 | |||
11 | Update to the current release branch: |
||
12 | |||
13 | <pre> |
||
14 | $ hg up release-x.y |
||
15 | </pre> |
||
16 | |||
17 | Write a unique revision and use the following commit template. |
||
18 | |||
19 | h2. Template |
||
20 | |||
21 | <pre> |
||
22 | h1. Errata YYYYMMDD |
||
23 | |||
24 | *Topic*: |
||
25 | *Category*: As specified in tasks |
||
26 | *Corrected*: [[Version-x-y-z|x.y.z]] (or revision r???) |
||
27 | *Affected versions*: [[Version-x-y-z|x.y.z]] |
||
28 | *Task*: #??? |
||
29 | |||
30 | h1. Background |
||
31 | |||
32 | Short explanation about the feature/context. |
||
33 | |||
34 | h1. Problem |
||
35 | |||
36 | Short description about the problem. |
||
37 | |||
38 | h1. Solution |
||
39 | |||
40 | Upgrade to a newer version if applicable or apply one of the following fixes: |
||
41 | |||
42 | h2. Using Mercurial |
||
43 | |||
44 | If you don't have a local copy: |
||
45 | |||
46 | <pre> |
||
47 | hg clone -u release-x.y http://hg.malikania.fr/irccd |
||
48 | </pre> |
||
49 | |||
50 | If you already have a local copy: |
||
51 | |||
52 | <pre> |
||
53 | cd /path/to/irccd |
||
54 | hg pull |
||
55 | hg up release-x.y |
||
56 | </pre> |
||
57 | |||
58 | And install new version of irccd. |
||
59 | |||
60 | h2. Using patch |
||
61 | |||
62 | Download the following patch: |
||
63 | |||
64 | * http://releases.malikania.fr/irccd/errata/YYYYMMDD.patch |
||
65 | * http://releases.malikania.fr/irccd/errata/YYYYMMDD.patch.asc |
||
66 | |||
67 | Apply it: |
||
68 | |||
69 | <pre> |
||
70 | cd /path/to/irccd/ |
||
71 | patch -p1 < /path/to/YYYYMMDD.patch |
||
72 | </pre> |
||
73 | </pre> |