Mercurial > web-octave

comparison bugs.md @ 66:a7952259f5d3 kai

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Markdownify more pages, make better use of SVG and CSS.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Wed, 12 Oct 2016 01:48:26 +0200
parents 171ca967fcc9
children 5e297505996c
comparison
equal deleted inserted replaced
65:acfd3d7e2f92 66:a7952259f5d3
2 layout: default 2 layout: default
3 title: Bugs 3 title: Bugs
4 menu: true 4 menu: true
5 --- 5 ---
6 6
7 <ul class="button-group"> 7 GNU Octave uses the bug tracker at [Savannah][1].
8 <li><a href="http://savannah.gnu.org/bugs/?func=additem&group=octave" class="button">Report</a></li> 8 There you can [report a new bug][2], [browse recent bugs][1],
9 <li><a href="http://savannah.gnu.org/bugs/?func=search&group=octave" class="button">Search</a></li> 9 or [search for bugs][3].
10 <li><a href="http://savannah.gnu.org/bugs/?group=octave" class="button">Browse</a></li>
11 </ul>
12 10
13 Your bug reports play an essential role in making Octave reliable. 11 [1]: https://savannah.gnu.org/bugs/?group=octave
14 You can make fixing problems easier by following the guidelines below. 12 [2]: https://savannah.gnu.org/bugs/?func=additem&group=octave
13 [3]: https://savannah.gnu.org/bugs/?func=search&group=octave
14
15 <p>
16 <div class="alert">
17 {% octicon stop class:"octicon-stop-octave" %}
18 Please do <strong>not</strong> send bug reports to the
19 <samp>help-octave@gnu.org</samp> mailing list.
20 Most users of Octave do not want to receive bug reports.
21 </div>
22 </p>
23
24 <p>
25 <div class="alert">
26 {% octicon stop class:"octicon-stop-octave" %}
27 <strong>Before</strong> reporting a new bug, read the guidelines below.
28 </div>
29 </p>
15 30
16 31
17 ## Where and How to Send Bug Reports
18 32
19 To report a bug in Octave, 33 # Is the bug already known?
20 <a href="http://savannah.gnu.org/bugs/?func=additem&group=octave">submit
21 a bug report</a> using the bug tracker.
22 34
23 Please do <strong>not</strong> send bug reports to the 35 When you encounter a problem,
24 <samp>help-octave</samp> mailing list. Most users of Octave do not 36 the first thing to do is to see if it is already known.
25 want to receive bug reports. 37 Therefore,
26 38
27 When you encounter a problem, the first thing to do is to see if it 39 - [search for already reported bugs at the bug tracker][3],
28 is already known. The best place to look for reported problems is
29 <a href="http://savannah.gnu.org/bugs/?group=octave">the Octave bug tracker</a>.
30 40
31 The <a href="doc/interpreter/Trouble.html#Trouble">Octave 41 - look at the list of known causes of trouble in the
32 reference manual</a> also contains a list of known causes of 42 [Octave reference manual][4].
33 trouble.
34 43
35 If you your problem does not appear to be known, then you should 44 If you your problem does not appear to be known,
36 report the problem. 45 then you should report the problem.
37 46
38 Reporting a bug may help you by bringing a solution to your problem, 47 Reporting a bug may help you by bringing a solution to your problem,
39 or it may not. In any case, the principal function of a bug report is 48 or it may not. In any case, the principal function of a bug report is
40 to help the entire community by making the next version of Octave work 49 to help the entire community by making the next version of Octave work
41 better, so you can contribute to the maintenance of Octave. 50 better, so you can contribute to the maintenance of Octave.
42 51
52 [4]: {{site.docs_url}}/Trouble.html#Trouble
43 53
44 ## Have You Found a Bug? 54
55
56 # Is it really a bug?
45 57
46 If you are not sure whether you have found a bug, here are some guidelines: 58 If you are not sure whether you have found a bug, here are some guidelines:
47 59
48 <ul> 60 - If Octave gets a fatal signal, for any input whatever, that is a bug.
49 <li> 61 Reliable interpreters never crash.
50 If Octave gets a fatal signal, for any input whatever, that is a bug.
51 Reliable interpreters never crash.
52 </li>
53 62
54 <li> 63 - If Octave produces incorrect results, for any input whatever, that is a bug.
55 If Octave produces incorrect results, for any input whatever,
56 that is a bug.
57 </li>
58 64
59 <li> 65 - Some output may appear to be incorrect when it is in fact due to a
60 Some output may appear to be incorrect when it is in fact due to a 66 program whose behavior is undefined, which happened by chance to give
61 program whose behavior is undefined, which happened by chance to give 67 the desired results on another system. For example, trigonometric
62 the desired results on another system. For example, 68 functions may produce different results because of differences in the
63 trigonometric functions may produce different results because of 69 math library or the way floating point arithmetic is handled on various
64 differences in the math library or the way floating point 70 systems.
65 arithmetic is handled on various systems.
66 </li>
67 71
68 <li> 72 - If Octave produces an error message for valid input, that is a bug.
69 If Octave produces an error message for valid input, that is a
70 bug.
71 </li>
72 73
73 <li> 74 - If Octave does not produce an error message for invalid input, that is
74 If Octave does not produce an error message for invalid input, that is 75 a bug. However, you should note that your idea of "invalid input"
75 a bug. However, you should note that your idea of "invalid input" 76 might be my idea of "an extension" or "support for traditional practice".
76 might be my idea of "an extension" or "support for traditional
77 practice".
78 </li>
79 77
80 <li> 78 - If you are an experienced user of programs like Octave, your
81 If you are an experienced user of programs like Octave, your 79 suggestions for improvement are welcome in any case.
82 suggestions for improvement are welcome in any case.
83 </li>
84 </ul>
85 80
86 81
87 ## Making Your Bug Report Count 82
83 # Make your bug report count
88 84
89 In order for a bug report to serve its purpose, you must include the 85 In order for a bug report to serve its purpose, you must include the
90 information that makes it possible to fix the bug. 86 information that makes it possible to fix the bug.
91 87
92 The fundamental principle of reporting bugs usefully is this: 88 The fundamental principle of reporting bugs usefully is this:
93 <strong>report all the facts</strong>. If you are not sure whether to 89 **report all the facts**. If you are not sure whether to
94 state a fact or leave it out, state it. 90 state a fact or leave it out, state it.
95 91
96 Often people omit facts because they think they know what causes the 92 Often people omit facts because they think they know what causes the
97 problem and they conclude that some details don't matter. Thus, you 93 problem and they conclude that some details don't matter. Thus, you
98 might assume that the name of the variable you use in an example does 94 might assume that the name of the variable you use in an example does
118 The bug tracker will prompt you for some basic information like 114 The bug tracker will prompt you for some basic information like
119 the version of Octave and the operating system you are using. You 115 the version of Octave and the operating system you are using. You
120 also need to include the following to enable someone to 116 also need to include the following to enable someone to
121 investigate the bug: 117 investigate the bug:
122 118
123 <ul> 119 - A complete input file that will reproduce the bug.
124 <li>
125 A complete input file that will reproduce the bug.
126 120
127 A single statement may not be enough of an example--the bug might 121 A single statement may not be enough of an example--the bug might
128 depend on other details that are missing from the single statement where 122 depend on other details that are missing from the single statement where
129 the error finally occurs. 123 the error finally occurs.
130 </li>
131 124
132 <li> 125 - The command arguments you gave Octave to execute that example
133 The command arguments you gave Octave to execute that example 126 and observe the bug. To guarantee you won't omit something important,
134 and observe the bug. To guarantee you won't omit something important, 127 list all the options.
135 list all the options.
136 128
137 If we were to try to guess the arguments, we would probably guess wrong 129 If we were to try to guess the arguments, we would probably guess wrong
138 and then we would not encounter the bug. 130 and then we would not encounter the bug.
139 </li>
140 131
141 <li> 132 - A description of what behavior you observe that you believe is incorrect.
142 A description of what behavior you observe that you believe is 133 For example, "The interpreter gets a fatal signal," or, "The output produced
143 incorrect. For example, "The interpreter gets a fatal signal," or, "The 134 at line 208 is incorrect."
144 output produced at line 208 is incorrect."
145 </li>
146 135
147 <li> 136 - The output you expected to see. Although it might seem obvious to you,
148 The output you expected to see. Although it might seem obvious 137 someone examining the problem might not know what result you consider
149 to you, someone examining the problem might not know what result 138 correct.
150 you consider correct.
151 </li>
152 139
153 <li> 140 - If you wish to suggest changes to the Octave source, send them as context
154 If you wish to suggest changes to the Octave source, send them 141 diffs. If you discuss something in the Octave source, refer to it by
155 as context diffs. If you discuss something in the Octave 142 context, not by line number, because the line numbers in the development
156 source, refer to it by context, not by line number, because the 143 sources probably won't match those in your sources.
157 line numbers in the development sources probably won't match
158 those in your sources.
159 </li>
160 </ul>
161 144
162 145
163 ## Sending Patches for Octave
164 146
165 If you have a suggested fix for a bug, please attach it to your 147 # Sending Patches for Octave
166 report in the tracker. Your patch is more likely to be reviewed 148
167 if you follow the guidelines in the Octave manual about to 149 If you have a suggested fix for a bug, please attach it to your report in
168 <a href="doc/interpreter/Basics-of-Generating-a-Changeset.html#Basics-of-Generating-a-Changeset">generate a changeset</a> 150 the tracker. Your patch is more likely to be reviewed if you follow the
151 guidelines in the Octave manual about to [generate a changeset][5]
169 and submit patches for Octave. 152 and submit patches for Octave.
153
154 [5]: {{site.docs_url}}/Basics-of-Generating-a-Changeset.html#Basics-of-Generating-a-Changeset