summaryrefslogtreecommitdiff
path: root/user/tlecarrour/patch_life_cycle.mdwn
blob: 574317af1e7872b03d15f0e422a7faacf5b9765b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
[[!meta copyright="Copyright © 2010 Free Software Foundation, Inc."]]

[[!meta license="""[[!toggle id="license" text="GFDL 1.2+"]][[!toggleable
id="license" text="Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
is included in the section entitled [[GNU Free Documentation
License|/fdl]]."]]"""]]


Patch Life Cycle
================

[[!toc startlevel=2]]


* * *


Start
-----

Follow the steps listed on the [[package porting page|porting_guide_for_dummies]].


Discuss
-------

Send the patch for review to [debian-hurd@lists.debian.org](mailto:debian-hurd@lists.debian.org).  
**Before** sending the patch, make sure that you've solved all the known problems listed in the [[package porting general introduction|hurd/porting/guidelines]] 
and the [[porting guide for dummies|porting_guide_for_dummies]].


Submit Draft
------------

When the patch is good enough, you can write the draft of the official bug report.  
This draft should first be sent for review to [debian-hurd@lists.debian.org](mailto:debian-hurd@lists.debian.org) with the patch attached.

Here is an example for memstat:

    Source: memstat
    Version: 0.9
    Severity: important
    Tags: patch
    User: debian-hurd@lists.debian.org
    Usertags: hurd
    X-DebBugs-CC: debian-hurd@lists.debian.org

    Hi,

    This patch solves the build problems for GNU/Hurd due to PATH_MAX
    issues. The solution is to make dynamic string allocations instead of
    using fixed length buffers. The patch involves one file, and is
    trivial. Parts of the the code has been reviewed by GNU/Hurd developers
    and Debian GNU/Hurd developers and maintainers.

    FIXME:
    Is it really useful to check if BUFSIZ is defined?

    TODO:
    Should the "whole package" be tested with valgrind on GNU/Linux?!
    If yes, is there a standard procedure to do it?!

    Thanks! 
    Special thanks to Jérémie and Richard for their comments!

    (Not submitted yet, comments are welcome.)

Once it's been approved, you can proceed to the submission.


Submit
------

The bug report is the same as above, with all the **FIXME**, **TODO** and final comment removed.  
Attach the patch and send it to [submit@bugs.debian.org](mailto:submit@bugs.debian.org).  
Convention for the attachment name is: `fix_FTBFS4Hurd.patch`


Accept
------

Once the patch has been accepted, update your patch page!  
**Congratulations!**