octave-nkf: README.devel annotate

annotate README.devel @ 12312:b10ea6efdc58 release-3-4-x ss-3-3-91

version is now 3.3.91

author	John W. Eaton <jwe@octave.org>
date	Mon, 31 Jan 2011 08:36:58 -0500
parents	097c84d2f87b
children	7b153b1af227

rev	line source
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	1 This directory contains development releases of Octave.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	2
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	3 If you want a stable, well-tested version of Octave, you should be
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	4 looking at ftp://ftp.gnu.org/gnu/octave.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	5
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	6 Development releases are provided for people who want to help test,
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	7 debug, and improve Octave. Very little testing is done before making
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	8 the development releases and they may even be made when Octave is in
f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	9 an inconsistent state. It is possible that you will encounter a
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	10 very obvious bug, such as a failure to compile on any machine. It is
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	11 likely that such bugs will be fixed by the next development release,
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	12 so it really isn't necessary to report them unless they persist over
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	13 more than one release.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	14
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	15 Please DO report other bugs in the development releases as soon as you
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	16 find them. Bugs should be reported to the bug tracker at
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	17 'http://bugs.octave.org'. Please read read the bug reporting
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	18 guidelines (http://www.gnu.org/software/octave/bugs.html) before
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	19 submitting an item.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	20
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	21 If you have a fix for a bug, or an enhancement to submit, send your
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	22 patch to octave-maintainers@octave.org or submit it to the patch
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	23 tracker at 'http://savannah.gnu.org/patch/?group=octave'.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	24
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	25 By adhering to the following guidelines you can minimize the work that
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	26 Octave maintainers need to do to apply your patch. Maintaining Octave
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	27 is a lot of work in the best of circumstances, and we can't keep up
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	28 unless you do your best to help.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	29
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	30 * Send an explanation with your changes of what problem they fix or
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	31 what improvement they bring about. For a bug fix, just include a
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	32 copy of the bug report, and explain why the change fixes the bug.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	33
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	34 * Always include a proper bug report for the problem you think you
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	35 have fixed. We need to convince ourselves that the change is
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	36 right before installing it. Even if it is right, we might have
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	37 trouble judging it if we don't have a way to reproduce the problem.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	38
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	39 * Include all the comments that are appropriate to help people
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	40 reading the source in the future understand why this change was
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	41 needed.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	42
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	43 * Don't mix together changes made for different reasons. Send them
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	44 _individually_.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	45
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	46 If you make two changes for separate reasons, then we might not
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	47 want to install them both. We might want to install just one.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	48
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	49 * Use `diff -c' to make your diffs. Diffs without context are hard
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	50 for us to install reliably. More than that, they make it hard for
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	51 us to study the diffs to decide whether we want to install them.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	52 Unified diff format is better than contextless diffs, but not as
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	53 easy to read as `-c' format.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	54
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	55 If you have GNU diff, use `diff -cp', which shows the name of the
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	56 function that each change occurs in.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	57
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	58 * Write the change log entries for your changes.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	59
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	60 Read the `ChangeLog' file to see what sorts of information to put
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	61 in, and to learn the style that we use. The purpose of the
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	62 change log is to show people where to find what was changed. So
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	63 you need to be specific about what functions you changed; in
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	64 large functions, it's often helpful to indicate where within the
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	65 function the change was made.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	66
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	67 On the other hand, once you have shown people where to find the
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	68 change, you need not explain its purpose. Thus, if you add a new
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	69 function, all you need to say about it is that it is new. If you
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	70 feel that the purpose needs explaining, it probably does--but the
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	71 explanation will be much more useful if you put it in comments in
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	72 the code.
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	73
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	74 If you would like your name to appear in the header line for who
097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	75 made the change, send us the header line.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	76
10495 f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	77 If you would like to be on the very sharpest part of the bleeding
f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	78 edge, you can now use Mercurial to access Octave's current development
f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	79 sources. Instructions for checking out a copy are available on the
f7d8b2bd7b57 README.ftp and README.devel updates John W. Eaton <jwe@octave.org> parents: 9322 diff changeset	80 web at http://www.gnu.org/software/octave/download.html.
3031 be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe] jwe parents: diff changeset	81
12146 097c84d2f87b Update README.devel for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 10495 diff changeset	82 Last updated: Sat Jan 22 21:26:18 PST 2011

Mercurial > octave-nkf

annotate README.devel @ 12312:b10ea6efdc58 release-3-4-x ss-3-3-91