Mercurial > web-octave

annotate pages/menu/bugs.md @ 241:598d7f098082

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Overhaul website, less JavaScript, more FontAwesome.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Thu, 18 Mar 2021 15:59:24 +0900
parents 89b5fed6fc99
children 41e6507acab4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
38 - If the function is
227
9057b6832c9a Improve syntax highlight with fenced markup.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 217
diff changeset
39 [part of an Octave package]({{ site.sourceforge_url }}/functions_by_alpha.php),
217
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
40 this is **not** a bug.
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
41 - If the function **exists in Matlab**,
227
9057b6832c9a Improve syntax highlight with fenced markup.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 217
diff changeset
42 but **not in core Octave** and **not in an Octave package**,
217
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
43 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
44
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
45 <p></p>
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
46
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
47 It might take several months or years until for new features to become part
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
48 of Octave, consider
241
598d7f098082 Overhaul website, less JavaScript, more FontAwesome.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 233
diff changeset
49 [<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
50 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
51
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
52 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
53
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
54 - **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
55 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
56 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
57 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
58 **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
59 - **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
60 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
61 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
62 - **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
63 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
64 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
65 correct.
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
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
68 ### 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
69
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
70 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
71 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
72 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
73 Octave Wiki about the [creation of changesets]({{ site.wiki_url }}/Mercurial).