Mercurial > web-octave

annotate bugs.md @ 210:d402a202c57e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* _layouts/default.html: add "lang" attribute.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Fri, 10 Jul 2020 00:40:57 +0900
parents 9d652d8ece7c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
1 ---
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
2 layout: page
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
3 title: Bugs
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
4 menu: true
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
5 ---
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
6
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
7 GNU Octave uses the bug tracker at [Savannah]({{ site.bugs_url }}).
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
8 There you can [report a new bug]({{ site.bugs_url }}&func=additem),
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
9 [browse recent bugs]({{ site.bugs_url }}),
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
10 or [search for bugs]({{ site.bugs_url }}&func=search).
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 92
diff changeset
11
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
12 ### Guidelines for reporting a new bug
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
13
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
14 1. **Is the bug already known?**
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 92
diff changeset
15
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
16 - [Search for already reported bugs at the bug tracker]({{ site.bugs_url }}&func=search),
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
17 - look at the
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
18 [list of known causes of trouble]({{ site.docs_url }}/Trouble.html)
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
19 in the Octave manual.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
20
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
21 <p></p>
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
22
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
23 If you your problem **does not appear** to be known,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
24 then you should report the problem.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
25
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
26 2. **Is it really a bug?**
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 92
diff changeset
27
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
28 - If Octave **crashes**, for any input whatever, that is a bug.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
29 Reliable interpreters never crash.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
30 - If Octave produces **incorrect results**, for any input whatever,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
31 that is a bug.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
32 - If Octave produces an **error message** for **valid input**, that is a bug.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
33 - If Octave produces **no error message** for **invalid input**,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
34 that is a bug.
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 92
diff changeset
35
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
36 <p></p>
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 92
diff changeset
37
197
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
38 3. **Missing function in Octave**
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
39
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
40 - If the function is
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
41 [part of some Octave Forge package]({{ site.sourceforge_url }}/functions_by_alpha.php),
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
42 this is **not** a bug.
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
43 - If the function **exists in Matlab**,
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
44 but **not in core Octave** and **not in Octave Forge packages**,
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
45 that is a bug.
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
46
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
47 <p></p>
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
48
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
49 It might take several months or years until for new features to become part
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
50 of Octave, consider
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
51 [commercial support]({{ "commercial-support.html" | relative_url }})
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
52 if you don't want to wait that long).
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
53
9d652d8ece7c * bugs.md: Mention unimplemented functions and Octave Forge.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 193
diff changeset
54 4. **Make your bug report count**
94
e8fc61e077fc Merged closed branch "kai" into default.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 92
diff changeset
55
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
56 - **Report all the facts:**<br>
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
57 Include all information that make it possible to fix the bug.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
58 If you are not sure whether to state a fact or leave it out, state it.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
59 This information includes your **operating system**, **Octave version**,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
60 **exact error message** or **exact output**.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
61 - **Give a short, specific, complete example:**<br>
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
62 Avoid: pseudocode, uninitialized variables,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
63 calls to unattached scripts or functions.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
64 - **Justify your exectations briefly:**<br>
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
65 Although it might seem obvious to you,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
66 someone examining the problem might not know what result you consider
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
67 correct.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
68
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
69
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
70 ### Sending Patches for Octave
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
71
193
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
72 If you have a suggested fix for a bug,
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
73 please attach it to your report in the tracker.
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
74 Your patch is more likely to be reviewed if you follow the guidelines from the
8ec5df986ad3 * bugs.md: Overhaul page.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 123
diff changeset
75 Octave Wiki about the [creation of changesets]({{ site.wiki_url }}/Mercurial).