Mercurial > web-octave
diff bugs.md @ 66:a7952259f5d3 kai
Markdownify more pages, make better use of SVG and CSS.
author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
---|---|
date | Wed, 12 Oct 2016 01:48:26 +0200 |
parents | 171ca967fcc9 |
children | 5e297505996c |
line wrap: on
line diff
--- a/bugs.md Wed Oct 12 01:47:36 2016 +0200 +++ b/bugs.md Wed Oct 12 01:48:26 2016 +0200 @@ -4,93 +4,89 @@ menu: true --- -<ul class="button-group"> - <li><a href="http://savannah.gnu.org/bugs/?func=additem&group=octave" class="button">Report</a></li> - <li><a href="http://savannah.gnu.org/bugs/?func=search&group=octave" class="button">Search</a></li> - <li><a href="http://savannah.gnu.org/bugs/?group=octave" class="button">Browse</a></li> -</ul> +GNU Octave uses the bug tracker at [Savannah][1]. +There you can [report a new bug][2], [browse recent bugs][1], +or [search for bugs][3]. + +[1]: https://savannah.gnu.org/bugs/?group=octave +[2]: https://savannah.gnu.org/bugs/?func=additem&group=octave +[3]: https://savannah.gnu.org/bugs/?func=search&group=octave -Your bug reports play an essential role in making Octave reliable. -You can make fixing problems easier by following the guidelines below. +<p> +<div class="alert"> +{% octicon stop class:"octicon-stop-octave" %} +Please do <strong>not</strong> send bug reports to the +<samp>help-octave@gnu.org</samp> mailing list. +Most users of Octave do not want to receive bug reports. +</div> +</p> + +<p> +<div class="alert"> +{% octicon stop class:"octicon-stop-octave" %} +<strong>Before</strong> reporting a new bug, read the guidelines below. +</div> +</p> -## Where and How to Send Bug Reports + +# Is the bug already known? -To report a bug in Octave, -<a href="http://savannah.gnu.org/bugs/?func=additem&group=octave">submit -a bug report</a> using the bug tracker. - -Please do <strong>not</strong> send bug reports to the -<samp>help-octave</samp> mailing list. Most users of Octave do not -want to receive bug reports. +When you encounter a problem, +the first thing to do is to see if it is already known. +Therefore, -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 -<a href="http://savannah.gnu.org/bugs/?group=octave">the Octave bug tracker</a>. +- [search for already reported bugs at the bug tracker][3], -The <a href="doc/interpreter/Trouble.html#Trouble">Octave -reference manual</a> also contains a list of known causes of -trouble. +- look at the list of known causes of trouble in the + [Octave reference manual][4]. -If you your problem does not appear to be known, then you should -report the problem. +If you your problem does not appear to be known, +then you should report the problem. 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. +[4]: {{site.docs_url}}/Trouble.html#Trouble -## Have You Found a Bug? + + +# Is it really a bug? If you are not sure whether you have found a bug, here are some guidelines: - <ul> - <li> - If Octave gets a fatal signal, for any input whatever, that is a bug. - Reliable interpreters never crash. - </li> +- If Octave gets a fatal signal, for any input whatever, that is a bug. + Reliable interpreters never crash. - <li> - If Octave produces incorrect results, for any input whatever, - that is a bug. - </li> +- If Octave produces incorrect results, for any input whatever, that is a bug. - <li> - 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. - </li> +- 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. - <li> - If Octave produces an error message for valid input, that is a - bug. - </li> +- If Octave produces an error message for valid input, that is a bug. - <li> - 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". - </li> +- 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". - <li> - If you are an experienced user of programs like Octave, your - suggestions for improvement are welcome in any case. - </li> - </ul> +- If you are an experienced user of programs like Octave, your + suggestions for improvement are welcome in any case. -## Making Your Bug Report Count + +# Make your bug report count In order for a bug report to serve its purpose, you must include the information that makes it possible to fix the bug. The fundamental principle of reporting bugs usefully is this: -<strong>report all the facts</strong>. If you are not sure whether to +**report all the facts**. If you are not sure whether to state a fact or leave it out, state it. Often people omit facts because they think they know what causes the @@ -120,50 +116,39 @@ also need to include the following to enable someone to investigate the bug: - <ul> - <li> - A complete input file that will reproduce the bug. +- 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. - </li> + 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. - <li> - 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. +- 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. - </li> + If we were to try to guess the arguments, we would probably guess wrong + and then we would not encounter the bug. - <li> - 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." - </li> +- 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." - <li> - 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. - </li> +- 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. - <li> - 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. - </li> - </ul> +- 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. -## Sending Patches for Octave + +# Sending Patches for Octave -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 -<a href="doc/interpreter/Basics-of-Generating-a-Changeset.html#Basics-of-Generating-a-Changeset">generate a changeset</a> +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][5] and submit patches for Octave. + +[5]: {{site.docs_url}}/Basics-of-Generating-a-Changeset.html#Basics-of-Generating-a-Changeset