Mercurial > web-octave

annotate bugs.md @ 92:7609e2a6faef

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Tue, 01 Nov 2016 00:28:55 +0100
parents a1cb50997055
children e8fc61e077fc
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
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
4 permalink: /bugs/
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
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
7
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
8
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
9 <ul class="button-group">
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
10 <li><a href="http://savannah.gnu.org/bugs/?func=additem&group=octave" class="button">Report</a></li>
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
11 <li><a href="http://savannah.gnu.org/bugs/?func=search&group=octave" class="button">Search</a></li>
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
12 <li><a href="http://savannah.gnu.org/bugs/?group=octave" class="button">Browse</a></li>
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
13 </ul>
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
14
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
15 Your bug reports play an essential role in making Octave reliable. You can make fixing problems easier by following the guidelines below.
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
16
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
17 ### Where and How to Send Bug Reports
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
18
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
19 To report a bug in Octave, [submit](http://savannah.gnu.org/bugs/?func=additem&group=octave) a bug report using the [bug tracker](http://savannah.gnu.org/bugs/?group=octave).
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
20
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
21 <div class="panel">
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
22 Please do not send bug reports to the help-octave mailing list. Most users of Octave do not want to receive bug reports.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
23 </div>
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
24
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
25 When you encounter a problem, the first thing to do is to see if it is already known. The best place to look for reported problems is the Octave [bug tracker](http://savannah.gnu.org/bugs/?group=octave).
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
26
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
27 The Octave reference manual also contains a list of [known causes of trouble](http://www.gnu.org/software/octave/doc/interpreter/Trouble.html#Trouble).
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
28
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
29 If you your problem does not appear to be known, then you should report the problem.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
30
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
31 Reporting a bug may help you by bringing a solution to your problem, or it may not. In any case, the principal function of a bug report is to help the entire community by making the next version of Octave work better, so you can contribute to the maintenance of Octave.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
32
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
33 ### Have You Found a Bug?
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
34
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
35 If you are not sure whether you have found a bug, here are some guidelines:
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
36
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
37 - If Octave gets a fatal signal, for any input whatever, that is a bug. Reliable interpreters never crash.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
38 - If Octave produces incorrect results, for any input whatever, that is a bug.
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
39 - Some output may appear to be incorrect when it is in fact due to a program whose behavior is undefined, which happened by chance to give the desired results on another system. For example, trigonometric functions may produce different results because of differences in the math library or the way floating point arithmetic is handled on various systems.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
40 - If Octave produces an error message for valid input, that is a bug.
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
41 - If Octave does not produce an error message for invalid input, that is a bug. However, you should note that your idea of "invalid input" might be my idea of "an extension" or "support for traditional practice".
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
42 - If you are an experienced user of programs like Octave, your suggestions for improvement are welcome in any case.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
43
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
44 ### Making Your Bug Report Count
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
45
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
46 In order for a bug report to serve its purpose, you must include the information that makes it possible to fix the bug.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
47
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
48 The fundamental principle of reporting bugs usefully is this: **report all the facts**. If you are not sure whether to state a fact or leave it out, state it.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
49
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
50 Often people omit facts because they think they know what causes the problem and they conclude that some details don't matter. Thus, you might assume that the name of the variable you use in an example does not matter. Well, probably it doesn't, but one cannot be sure. Perhaps the bug is a stray memory reference which happens to fetch from the location where that name is stored in memory; perhaps, if the name were different, the contents of that location would fool the interpreter into doing the right thing despite the bug. Play it safe and give a specific, complete example.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
51
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
52 Keep in mind that the purpose of a bug report is to enable someone to fix the bug if it is not known. Always write your bug reports on the assumption that the bug is not known.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
53
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
54 Sometimes people give a few sketchy facts and ask, "Does this ring a bell?" This cannot help us fix a bug. It is better to send a complete bug report to begin with.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
55
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
56 Try to make your bug report self-contained. If we have to ask you for more information, it is best if you include all the previous information in your response, as well as the information that was missing.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
57
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
58 The bug tracker will prompt you for some basic information like the version of Octave and the operating system you are using. You also need to include the following to enable someone to investigate the bug:
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
59
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
60 - A complete input file that will reproduce the bug. A single statement may not be enough of an example--the bug might depend on other details that are missing from the single statement where the error finally occurs.
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
61 - The command arguments you gave Octave to execute that example and observe the bug. To guarantee you won't omit something important, list all the options. If we were to try to guess the arguments, we would probably guess wrong and then we would not encounter the bug.
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
62 - A description of what behavior you observe that you believe is incorrect. For example, "The interpreter gets a fatal signal," or, "The output produced at line 208 is incorrect."
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
63 - The output you expected to see. Although it might seem obvious to you, someone examining the problem might not know what result you consider correct.
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
64 - If you wish to suggest changes to the Octave source, send them as context diffs. If you discuss something in the Octave source, refer to it by context, not by line number, because the line numbers in the development sources probably won't match those in your sources.
5
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
65
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
66 ### Sending Patches for Octave
e210b708b330 fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
67
92
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
68 If you have a suggested fix for a bug, please attach it to your report in the tracker. Your patch is more likely to be reviewed if you follow the guidelines in the Octave manual about to [generate a changeset](http://www.gnu.org/software/octave/doc/interpreter/Basics-of-Generating-a-Changeset.html#Basics-of-Generating-a-Changeset) and submit patches for Octave.
7609e2a6faef maint: revert changeset 40 (2ff331fce678) .gitignore -> .hgignore.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 43
diff changeset
69