~ubuntu-branches/ubuntu/wily/curl/wily

« back to all changes in this revision

Viewing changes to docs/BUGS

  • Committer: Package Import Robot
  • Author(s): Timo Aaltonen
  • Date: 2011-11-25 17:30:45 UTC
  • mfrom: (3.4.23 sid)
  • Revision ID: package-import@ubuntu.com-20111125173045-2l3ni88jv16kath0
Tags: 7.22.0-3ubuntu1
* Merge from Debian unstable, remaining changes:
  - Drop dependencies not in main:
    + Build-Depends: Drop stunnel4 and libssh2-1-dev.
    + Drop libssh2-1-dev from libcurl4-openssl-dev's Depends.
  - Add new libcurl3-udeb package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
 
7
7
BUGS
8
8
 
 
9
 1. Bugs
 
10
  1.1 There are still bugs
 
11
  1.2 Where to report
 
12
  1.3 What to report
 
13
  1.4 libcurl problems
 
14
  1.5 Who will fix the problems
 
15
  1.6 How to get a stack trace
 
16
  1.7 Bugs in libcurl bindings
 
17
 
 
18
==============================================================================
 
19
 
 
20
1.1 There are still bugs
 
21
 
9
22
  Curl and libcurl have grown substantially since the beginning. At the time
10
 
  of writing (July 2007), there are about 47000 lines of source code, and by
11
 
  the time you read this it has probably grown even more.
 
23
  of writing (September 2011), there are about 66000 lines of source code, and
 
24
  by the time you read this it has probably grown even more.
12
25
 
13
26
  Of course there are lots of bugs left. And lots of misfeatures.
14
27
 
15
28
  To help us make curl the stable and solid product we want it to be, we need
16
29
  bug reports and bug fixes.
17
30
 
18
 
WHERE TO REPORT
 
31
1.2 Where to report
19
32
 
20
33
  If you can't fix a bug yourself and submit a fix for it, try to report an as
21
34
  detailed report as possible to a curl mailing list to allow one of us to
22
 
  have a go at a solution. You should also post your bug/problem at curl's bug
23
 
  tracking system over at
 
35
  have a go at a solution. You can optionally also post your bug/problem at
 
36
  curl's bug tracking system over at
24
37
 
25
38
        http://sourceforge.net/bugs/?group_id=976
26
39
 
29
42
  If you feel you need to ask around first, find a suitable mailing list and
30
43
  post there. The lists are available on http://curl.haxx.se/mail/
31
44
 
32
 
WHAT TO REPORT
 
45
1.3 What to report
33
46
 
34
47
  When reporting a bug, you should include all information that will help us
35
48
  understand what's wrong, what you expected to happen and how to repeat the
36
49
  bad behavior. You therefore need to tell us:
37
50
 
38
 
   - your operating system's name and version number (uname -a under a unix
39
 
     is fine)
 
51
   - your operating system's name and version number
 
52
 
40
53
   - what version of curl you're using (curl -V is fine)
 
54
 
41
55
   - versions of the used libraries that libcurl is built to use
 
56
 
42
57
   - what URL you were working with (if possible), at least which protocol
43
58
 
44
59
  and anything and everything else you think matters. Tell us what you
59
74
  The address and how to subscribe to the mailing lists are detailed in the
60
75
  MANUAL file.
61
76
 
62
 
HOW TO GET A STACK TRACE
 
77
1.4 libcurl problems
 
78
 
 
79
  First, post all libcurl problems on the curl-library mailing list.
 
80
 
 
81
  When you've written your own application with libcurl to perform transfers,
 
82
  it is even more important to be specific and detailed when reporting bugs.
 
83
 
 
84
  Tell us the libcurl version and your operating system. Tell us the name and
 
85
  version of all relevant sub-components like for example the SSL library
 
86
  you're using and what name resolving your libcurl uses. If you use SFTP or
 
87
  SCP, the libssh2 version is relevant etc.
 
88
 
 
89
  Showing us a real source code example repeating your problem is the best way
 
90
  to get our attention and it will greatly increase our chances to understand
 
91
  your problem and to work on a fix (if we agree it truly is a problem).
 
92
 
 
93
  Lots of problems that appear to be libcurl problems are actually just abuses
 
94
  of the libcurl API or other malfunctions in your applications. It is adviced
 
95
  that you run your problematic program using a memory debug tool like
 
96
  valgrind or similar before you post memory-related or "crashing" problems to
 
97
  us.
 
98
 
 
99
1.5 Who will fix the problems
 
100
 
 
101
  If the problems or bugs you describe are considered to be bugs, we want to
 
102
  have the problems fixed.
 
103
 
 
104
  There are no developers in the curl project that are paid to work on bugs.
 
105
  All developers that take on reported bugs do this on a voluntary basis. We
 
106
  do it out of an ambition to keep curl and libcurl excellent products and out
 
107
  of pride.
 
108
 
 
109
  But please do not assume that you can just lump over something to us and it
 
110
  will then magically be fixed after some given time. Most often we need
 
111
  feedback and help to understand what you've experienced and how to repeat a
 
112
  problem. Then we may only be able to assist YOU to debug the problem and to
 
113
  track down the proper fix.
 
114
 
 
115
  We get reports from many people every month and each report can take a
 
116
  considerable amount of time to really go to the bottom with.
 
117
 
 
118
1.6 How to get a stack trace
63
119
 
64
120
  First, you must make sure that you compile all sources with -g and that you
65
121
  don't 'strip' the final executable. Try to avoid optimizing the code as
79
135
  crashed. Include the stack trace with your detailed bug report. It'll help a
80
136
  lot.
81
137
 
 
138
1.7 Bugs in libcurl bindings
 
139
 
 
140
  There will of course pop up bugs in libcurl bindings. You should then
 
141
  primarily approach the team that works on that particular binding and see
 
142
  what you can do to help them fix the problem.
 
143
 
 
144
  If you suspect that the problem exists in the underlying libcurl, then
 
145
  please convert your program over to plain C and follow the steps outlined
 
146
  above.