Mercurial > web-octave
annotate pages/menu/bugs.md @ 246:41e6507acab4
Improve bug reporting section.
author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
---|---|
date | Sat, 27 Mar 2021 21:04:29 +0900 |
parents | 598d7f098082 |
children | e493534d00e8 |
rev | line source |
---|---|
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
1 --- |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
2 layout: page |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
3 title: Bugs |
241
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
4 icon: <i class="fas fa-bug"></i> |
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
5 menu: true |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
6 permalink: bugs |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
7 --- |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
8 |
241
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
9 GNU Octave uses the bug tracker at [GNU Savannah]({{ site.bugs_url }}). |
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
10 There you can |
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
11 [<i class="far fa-plus-square"></i> report a new bug](https://savannah.gnu.org/bugs/?group=octave&func=additem), |
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
12 [<i class="far fa-list-alt"></i> browse recent bugs]({{ site.bugs_url }}), |
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
13 or [<i class="fas fa-search"></i> search for bugs](https://savannah.gnu.org/bugs/?group=octave&func=search). |
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
14 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
15 ### Guidelines for reporting a new bug |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
16 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
17 1. **Is the bug already known?** |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
18 |
241
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
19 [<i class="fas fa-search"></i> Search for already reported bugs](https://savannah.gnu.org/bugs/?group=octave&func=search) |
598d7f098082
Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
233
diff
changeset
|
20 at the bug tracker first. |
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
21 If you your problem **does not appear** to be known, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
22 then you should report the problem. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
23 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
24 2. **Is it really a bug?** |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
25 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
26 - If Octave **crashes**, for any input whatever, that is a bug. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
27 Reliable interpreters never crash. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
28 - If Octave produces **incorrect results**, for any input whatever, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
29 that is a bug. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
30 - If Octave produces an **error message** for **valid input**, that is a bug. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
31 - If Octave produces **no error message** for **invalid input**, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
32 that is a bug. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
33 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
34 <p></p> |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
35 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
36 3. **Missing function in Octave** |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
37 |
246
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
38 If a function exists in Matlab, but not in Octave, this is **not** a bug. |
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
39 |
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
40 - The function might already be |
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
41 [part of an Octave package]({{ site.sourceforge_url }}/functions_by_alpha.php). |
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
42 - You may file a **feature request** for it on the bug tracker. |
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
43 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
44 <p></p> |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
45 |
246
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
46 Please be aware that it might take **several months** |
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
47 until for new features become part of Octave. |
41e6507acab4
Improve bug reporting section.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
241
diff
changeset
|
48 Consider [<i class="fas fa-comment-dollar"></i> commercial support]({{ "commercial-support.html" | relative_url }}) |
233
89b5fed6fc99
* pages/menu/bugs.md: fix small typos
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
227
diff
changeset
|
49 if you don't want to wait that long. |
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
50 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
51 4. **Make your bug report count** |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
52 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
53 - **Report all the facts:**<br> |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
54 Include all information that make it possible to fix the bug. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
55 If you are not sure whether to state a fact or leave it out, state it. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
56 This information includes your **operating system**, **Octave version**, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
57 **exact error message** or **exact output**. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
58 - **Give a short, specific, complete example:**<br> |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
59 Avoid: pseudocode, uninitialized variables, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
60 calls to unattached scripts or functions. |
233
89b5fed6fc99
* pages/menu/bugs.md: fix small typos
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
227
diff
changeset
|
61 - **Justify your expectations briefly:**<br> |
217
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
62 Although it might seem obvious to you, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
63 someone examining the problem might not know what result you consider |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
64 correct. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
65 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
66 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
67 ### Sending Patches for Octave |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
68 |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
69 If you have a suggested fix for a bug, |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
70 please attach it to your report in the tracker. |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
71 Your patch is more likely to be reviewed if you follow the guidelines from the |
6de5c7dcc43f
maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff
changeset
|
72 Octave Wiki about the [creation of changesets]({{ site.wiki_url }}/Mercurial). |