Mercurial > web-octave

annotate pages/menu/bugs.md @ 233:89b5fed6fc99

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* pages/menu/bugs.md: fix small typos
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Mon, 30 Nov 2020 13:14:04 +0900
parents 9057b6832c9a
children 598d7f098082
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
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
4 menu: true
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
5 permalink: bugs
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
6 ---
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 GNU Octave uses the bug tracker at [Savannah]({{ site.bugs_url }}).
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
9 There you can [report a new bug]({{ site.bugs_url }}&func=additem),
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
10 [browse recent bugs]({{ site.bugs_url }}),
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
11 or [search for bugs]({{ site.bugs_url }}&func=search).
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
12
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
13 ### 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
14
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
15 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
16
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
17 - [Search for already reported bugs at the bug tracker]({{ site.bugs_url }}&func=search),
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
18 - look at the
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
19 [list of known causes of trouble]({{ site.docs_url }}/Trouble.html)
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
20 in the Octave manual.
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
21
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
22 <p></p>
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 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
25 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
26
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
27 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
28
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
29 - 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
30 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
31 - 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
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 - 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
34 - 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
35 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
36
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
37 <p></p>
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
38
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
39 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
40
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 is
227
9057b6832c9a Improve syntax highlight with fenced markup.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 217
diff changeset
42 [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
43 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
44 - 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
45 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
46 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
47
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
48 <p></p>
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
49
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
50 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
51 of Octave, consider
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
52 [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
53 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
54
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
55 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
56
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
57 - **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
58 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
59 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
60 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
61 **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
62 - **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
63 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
64 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
65 - **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
66 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
67 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
68 correct.
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
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
71 ### 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
72
6de5c7dcc43f maint: add "pages/menu" subfolder to get a better overview.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
diff changeset
73 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
74 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
75 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
76 Octave Wiki about the [creation of changesets]({{ site.wiki_url }}/Mercurial).