home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fs.zip / octave / BUGS next >
Text File  |  2000-01-15  |  15KB  |  361 lines

  1. % DO NOT EDIT!  Generated automatically by munge-texi.
  2.  
  3.    This file documents known bugs in Octave and describes where and how
  4. to report any bugs that you may find.
  5.  
  6.    Copyright (C) 1996, 1997 John W. Eaton.  You may copy, distribute,
  7. and modify it freely as long as you preserve this copyright notice and
  8. permission notice.
  9.  
  10. Known Causes of Trouble with Octave
  11. ***********************************
  12.  
  13.    This section describes known problems that affect users of Octave.
  14. Most of these are not Octave bugs per se--if they were, we would fix
  15. them.  But the result for a user may be like the result of a bug.
  16.  
  17.    Some of these problems are due to bugs in other software, some are
  18. missing features that are too much work to add, and some are places
  19. where people's opinions differ as to what is best.
  20.  
  21. Actual Bugs We Haven't Fixed Yet
  22. ================================
  23.  
  24.    * Output that comes directly from Fortran functions is not sent
  25.      through the pager and may appear out of sequence with other output
  26.      that is sent through the pager.  One way to avoid this is to force
  27.      pending output to be flushed before calling a function that will
  28.      produce output from within Fortran functions.  To do this, use the
  29.      command
  30.  
  31.           fflush (stdout)
  32.  
  33.      Another possible workaround is to use the command
  34.  
  35.           page_screen_output = "false"
  36.  
  37.      to turn the pager off.
  38.  
  39.    * If you get messages like
  40.  
  41.           Input line too long
  42.  
  43.      when trying to plot many lines on one graph, you have probably
  44.      generated a plot command that is too larger for `gnuplot''s
  45.      fixed-length buffer for commands.  Splitting up the plot command
  46.      doesn't help because replot is implemented in gnuplot by simply
  47.      appending the new plotting commands to the old command line and
  48.      then evaluating it again.
  49.  
  50.      You can demonstrate this `feature' by running gnuplot and doing
  51.      something like
  52.  
  53.             plot sin (x), sin (x), sin (x), ... lots more ..., sin (x)
  54.  
  55.      and then
  56.  
  57.             replot sin (x), sin (x), sin (x), ... lots more ..., sin (x)
  58.  
  59.      after repeating the replot command a few times, gnuplot will give
  60.      you an error.
  61.  
  62.      Also, it doesn't help to use backslashes to enter a plot command
  63.      over several lines, because the limit is on the overall command
  64.      line length, once the backslashed lines are all pasted together.
  65.  
  66.      Because of this, Octave tries to use as little of the command-line
  67.      length as possible by using the shortest possible abbreviations for
  68.      all the plot commands and options.  Unfortunately, the length of
  69.      the temporary file names is probably what is taking up the most
  70.      space on the command line.
  71.  
  72.      You can buy a little bit of command line space by setting the
  73.      environment variable `TMPDIR' to be "." before starting Octave, or
  74.      you can increase the maximum command line length in gnuplot by
  75.      changing the following limits in the file plot.h in the gnuplot
  76.      distribution and recompiling gnuplot.
  77.  
  78.           #define MAX_LINE_LEN 32768  /* originally 1024 */
  79.           #define MAX_TOKENS 8192     /* originally 400 */
  80.  
  81.      Of course, this doesn't really fix the problem, but it does make it
  82.      much less likely that you will run into trouble unless you are
  83.      putting a very large number of lines on a given plot.
  84.  
  85.    A list of ideas for future enhancements is distributed with Octave.
  86. See the file `PROJECTS' in the top level directory in the source
  87. distribution.
  88.  
  89. Reporting Bugs
  90. ==============
  91.  
  92.    Your bug reports play an essential role in making Octave reliable.
  93.  
  94.    When you encounter a problem, the first thing to do is to see if it
  95. is already known.  *Note Trouble::.  If it isn't known, then you should
  96. report the problem.
  97.  
  98.    Reporting a bug may help you by bringing a solution to your problem,
  99. or it may not.  In any case, the principal function of a bug report is
  100. to help the entire community by making the next version of Octave work
  101. better.  Bug reports are your contribution to the maintenance of Octave.
  102.  
  103.    In order for a bug report to serve its purpose, you must include the
  104. information that makes it possible to fix the bug.
  105.  
  106.    If you have Octave working at all, the easiest way to prepare a
  107. complete bug report is to use the Octave function `bug_report'.  When
  108. you execute this function, Octave will prompt you for a subject and then
  109. invoke the editor on a file that already contains all the configuration
  110. information.  When you exit the editor, Octave will mail the bug report
  111. for you.
  112.  
  113. Have You Found a Bug?
  114. =====================
  115.  
  116.    If you are not sure whether you have found a bug, here are some
  117. guidelines:
  118.  
  119.    * If Octave gets a fatal signal, for any input whatever, that is a
  120.      bug.  Reliable interpreters never crash.
  121.  
  122.    * If Octave produces incorrect results, for any input whatever, that
  123.      is a bug.
  124.  
  125.    * Some output may appear to be incorrect when it is in fact due to a
  126.      program whose behavior is undefined, which happened by chance to
  127.      give the desired results on another system.  For example, the
  128.      range operator may produce different results because of
  129.      differences in the way floating point arithmetic is handled on
  130.      various systems.
  131.  
  132.    * If Octave produces an error message for valid input, that is a bug.
  133.  
  134.    * If Octave does not produce an error message for invalid input,
  135.      that is a bug.  However, you should note that your idea of
  136.      "invalid input" might be my idea of "an extension" or "support for
  137.      traditional practice".
  138.  
  139.    * If you are an experienced user of programs like Octave, your
  140.      suggestions for improvement are welcome in any case.
  141.  
  142. Where to Report Bugs
  143. ====================
  144.  
  145.    If you have Octave working at all, the easiest way to prepare a
  146. complete bug report is to use the Octave function `bug_report'.  When
  147. you execute this function, Octave will prompt you for a subject and then
  148. invoke the editor on a file that already contains all the configuration
  149. information.  When you exit the editor, Octave will mail the bug report
  150. for you.
  151.  
  152.    If for some reason you cannot use Octave's `bug_report' function,
  153. send bug reports for Octave to <bug-octave@bevo.che.wisc.edu>.
  154.  
  155.    *Do not send bug reports to `help-octave'*.  Most users of Octave do
  156. not want to receive bug reports.  Those that do have asked to be on the
  157. mailing list.
  158.  
  159.    As a last resort, send bug reports on paper to:
  160.  
  161.      Octave Bugs c/o John W. Eaton
  162.      University of Wisconsin-Madison
  163.      Department of Chemical Engineering
  164.      1415 Engineering Drive
  165.      Madison, Wisconsin 53706  USA
  166.  
  167. How to Report Bugs
  168. ==================
  169.  
  170.    Send bug reports for Octave to one of the addresses listed in *Note
  171. Bug Lists::.
  172.  
  173.    The fundamental principle of reporting bugs usefully is this:
  174. *report all the facts*.  If you are not sure whether to state a fact or
  175. leave it out, state it!
  176.  
  177.    Often people omit facts because they think they know what causes the
  178. problem and they conclude that some details don't matter.  Thus, you
  179. might assume that the name of the variable you use in an example does
  180. not matter.  Well, probably it doesn't, but one cannot be sure.
  181. Perhaps the bug is a stray memory reference which happens to fetch from
  182. the location where that name is stored in memory; perhaps, if the name
  183. were different, the contents of that location would fool the
  184. interpreter into doing the right thing despite the bug.  Play it safe
  185. and give a specific, complete example.
  186.  
  187.    Keep in mind that the purpose of a bug report is to enable someone to
  188. fix the bug if it is not known. Always write your bug reports on the
  189. assumption that the bug is not known.
  190.  
  191.    Sometimes people give a few sketchy facts and ask, "Does this ring a
  192. bell?"  This cannot help us fix a bug.  It is better to send a complete
  193. bug report to begin with.
  194.  
  195.    Try to make your bug report self-contained.  If we have to ask you
  196. for more information, it is best if you include all the previous
  197. information in your response, as well as the information that was
  198. missing.
  199.  
  200.    To enable someone to investigate the bug, you should include all
  201. these things:
  202.  
  203.    * The version of Octave.  You can get this by noting the version
  204.      number that is printed when Octave starts, or running it with the
  205.      `-v' option.
  206.  
  207.    * A complete input file that will reproduce the bug.
  208.  
  209.      A single statement may not be enough of an example--the bug might
  210.      depend on other details that are missing from the single statement
  211.      where the error finally occurs.
  212.  
  213.    * The command arguments you gave Octave to execute that example and
  214.      observe the bug.  To guarantee you won't omit something important,
  215.      list all the options.
  216.  
  217.      If we were to try to guess the arguments, we would probably guess
  218.      wrong and then we would not encounter the bug.
  219.  
  220.    * The type of machine you are using, and the operating system name
  221.      and version number.
  222.  
  223.    * The command-line arguments you gave to the `configure' command when
  224.      you installed the interpreter.
  225.  
  226.    * A complete list of any modifications you have made to the
  227.      interpreter source.
  228.  
  229.      Be precise about these changes--show a context diff for them.
  230.  
  231.    * Details of any other deviations from the standard procedure for
  232.      installing Octave.
  233.  
  234.    * A description of what behavior you observe that you believe is
  235.      incorrect.  For example, "The interpreter gets a fatal signal,"
  236.      or, "The output produced at line 208 is incorrect."
  237.  
  238.      Of course, if the bug is that the interpreter gets a fatal signal,
  239.      then one can't miss it.  But if the bug is incorrect output, we
  240.      might not notice unless it is glaringly wrong.
  241.  
  242.      Even if the problem you experience is a fatal signal, you should
  243.      still say so explicitly.  Suppose something strange is going on,
  244.      such as, your copy of the interpreter is out of synch, or you have
  245.      encountered a bug in the C library on your system.  Your copy
  246.      might crash and the copy here would not.  If you said to expect a
  247.      crash, then when the interpreter here fails to crash, we would
  248.      know that the bug was not happening.  If you don't say to expect a
  249.      crash, then we would not know whether the bug was happening.  We
  250.      would not be able to draw any conclusion from our observations.
  251.  
  252.      Often the observed symptom is incorrect output when your program
  253.      is run.  Unfortunately, this is not enough information unless the
  254.      program is short and simple.  It is very helpful if you can
  255.      include an explanation of the expected output, and why the actual
  256.      output is incorrect.
  257.  
  258.    * If you wish to suggest changes to the Octave source, send them as
  259.      context diffs.  If you even discuss something in the Octave source,
  260.      refer to it by context, not by line number, because the line
  261.      numbers in the development sources probably won't match those in
  262.      your sources.
  263.  
  264.    Here are some things that are not necessary:
  265.  
  266.    * A description of the envelope of the bug.
  267.  
  268.      Often people who encounter a bug spend a lot of time investigating
  269.      which changes to the input file will make the bug go away and
  270.      which changes will not affect it.  Such information is usually not
  271.      necessary to enable us to fix bugs in Octave, but if you can find
  272.      a simpler example to report *instead* of the original one, that is
  273.      a convenience.  Errors in the output will be easier to spot,
  274.      running under the debugger will take less time, etc. Most Octave
  275.      bugs involve just one function, so the most straightforward way to
  276.      simplify an example is to delete all the function definitions
  277.      except the one in which the bug occurs.
  278.  
  279.      However, simplification is not vital; if you don't want to do
  280.      this, report the bug anyway and send the entire test case you used.
  281.  
  282.    * A patch for the bug.  Patches can be helpful, but if you find a
  283.      bug, you should report it, even if you cannot send a fix for the
  284.      problem.
  285.  
  286. Sending Patches for Octave
  287. ==========================
  288.  
  289.    If you would like to write bug fixes or improvements for Octave,
  290. that is very helpful.  When you send your changes, please follow these
  291. guidelines to avoid causing extra work for us in studying the patches.
  292.  
  293.    If you don't follow these guidelines, your information might still be
  294. useful, but using it will take extra work.  Maintaining Octave is a lot
  295. of work in the best of circumstances, and we can't keep up unless you do
  296. your best to help.
  297.  
  298.    * Send an explanation with your changes of what problem they fix or
  299.      what improvement they bring about.  For a bug fix, just include a
  300.      copy of the bug report, and explain why the change fixes the bug.
  301.  
  302.    * Always include a proper bug report for the problem you think you
  303.      have fixed.  We need to convince ourselves that the change is
  304.      right before installing it.  Even if it is right, we might have
  305.      trouble judging it if we don't have a way to reproduce the problem.
  306.  
  307.    * Include all the comments that are appropriate to help people
  308.      reading the source in the future understand why this change was
  309.      needed.
  310.  
  311.    * Don't mix together changes made for different reasons.  Send them
  312.      *individually*.
  313.  
  314.      If you make two changes for separate reasons, then we might not
  315.      want to install them both.  We might want to install just one.
  316.  
  317.    * Use `diff -c' to make your diffs.  Diffs without context are hard
  318.      for us to install reliably.  More than that, they make it hard for
  319.      us to study the diffs to decide whether we want to install them.
  320.      Unidiff format is better than contextless diffs, but not as easy
  321.      to read as `-c' format.
  322.  
  323.      If you have GNU diff, use `diff -cp', which shows the name of the
  324.      function that each change occurs in.
  325.  
  326.    * Write the change log entries for your changes.
  327.  
  328.      Read the `ChangeLog' file to see what sorts of information to put
  329.      in, and to learn the style that we use.  The purpose of the change
  330.      log is to show people where to find what was changed.  So you need
  331.      to be specific about what functions you changed; in large
  332.      functions, it's often helpful to indicate where within the
  333.      function the change was made.
  334.  
  335.      On the other hand, once you have shown people where to find the
  336.      change, you need not explain its purpose. Thus, if you add a new
  337.      function, all you need to say about it is that it is new.  If you
  338.      feel that the purpose needs explaining, it probably does--but the
  339.      explanation will be much more useful if you put it in comments in
  340.      the code.
  341.  
  342.      If you would like your name to appear in the header line for who
  343.      made the change, send us the header line.
  344.  
  345. How To Get Help with Octave
  346. ===========================
  347.  
  348.    The mailing list <help-octave@bevo.che.wisc.edu> exists for the
  349. discussion of matters related to using and installing Octave.  If would
  350. like to join the discussion, please send a short note to
  351. <help-octave*-request*@bevo.che.wisc.edu>.
  352.  
  353.    *Please do not* send requests to be added or removed from the
  354. mailing list, or other administrative trivia to the list itself.
  355.  
  356.    If you think you have found a bug in the installation procedure,
  357. however, you should send a complete bug report for the problem to
  358. <bug-octave@bevo.che.wisc.edu>.  *Note Bug Reporting:: for information
  359. that will help you to submit a useful report.
  360.  
  361.