Mercurial > octave-nkf

annotate etc/README.devel @ 15902:858cbf6fc2ec stable rc-3-6-4-1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bump version for 3.6.4-rc1
author John W. Eaton <jwe@octave.org>
date Sat, 05 Jan 2013 19:46:27 -0500
parents c49d891eb263
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
12140
bce5b7c1a20a 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
12140
bce5b7c1a20a 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
bce5b7c1a20a 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
15497
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 12733
diff changeset
18 guidelines (http://www.octave.org/bugs.html) before submitting an item.
3031
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe]
jwe
parents:
diff changeset
19
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe]
jwe
parents:
diff changeset
20 If you have a fix for a bug, or an enhancement to submit, send your
12349
7b153b1af227 PROJECTS, README.devel: use maintainers@octave.org instead of octave-maintainers@octave.org
John W. Eaton <jwe@octave.org>
parents: 12140
diff changeset
21 patch to maintainers@octave.org or submit it to the patch
12140
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
22 tracker at 'http://savannah.gnu.org/patch/?group=octave'.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
23
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
24 By adhering to the following guidelines you can minimize the work that
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
25 Octave maintainers need to do to apply your patch. Maintaining Octave
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
26 is a lot of work in the best of circumstances, and we can't keep up
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
27 unless you do your best to help.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
28
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
29 * Send an explanation with your changes of what problem they fix or
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
30 what improvement they bring about. For a bug fix, just include a
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
31 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
32
12140
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
33 * Always include a proper bug report for the problem you think you
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
34 have fixed. We need to convince ourselves that the change is
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
35 right before installing it. Even if it is right, we might have
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
36 trouble judging it if we don't have a way to reproduce the problem.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
37
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
38 * Include all the comments that are appropriate to help people
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
39 reading the source in the future understand why this change was
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
40 needed.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
41
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
42 * Don't mix together changes made for different reasons. Send them
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
43 _individually_.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
44
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
45 If you make two changes for separate reasons, then we might not
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
46 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
47
12140
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
48 * Use `diff -c' to make your diffs. Diffs without context are hard
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
49 for us to install reliably. More than that, they make it hard for
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
50 us to study the diffs to decide whether we want to install them.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
51 Unified diff format is better than contextless diffs, but not as
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
52 easy to read as `-c' format.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
53
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
54 If you have GNU diff, use `diff -cp', which shows the name of the
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
55 function that each change occurs in.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
56
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
57 * Write the change log entries for your changes.
3031
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe]
jwe
parents:
diff changeset
58
12140
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
59 Read the `ChangeLog' file to see what sorts of information to put
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
60 in, and to learn the style that we use. The purpose of the
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
61 change log is to show people where to find what was changed. So
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
62 you need to be specific about what functions you changed; in
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
63 large functions, it's often helpful to indicate where within the
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
64 function the change was made.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
65
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
66 On the other hand, once you have shown people where to find the
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
67 change, you need not explain its purpose. Thus, if you add a new
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
68 function, all you need to say about it is that it is new. If you
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
69 feel that the purpose needs explaining, it probably does--but the
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
70 explanation will be much more useful if you put it in comments in
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
71 the code.
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
72
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
73 If you would like your name to appear in the header line for who
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
74 made the change, send us the header line.
3031
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe]
jwe
parents:
diff changeset
75
10495
f7d8b2bd7b57 README.ftp and README.devel updates
John W. Eaton <jwe@octave.org>
parents: 9322
diff changeset
76 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
77 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
78 sources. Instructions for checking out a copy are available on the
15497
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 12733
diff changeset
79 web at http://www.octave.org/download.html.
3031
be1b26b99caa [project @ 1997-06-05 07:34:53 by jwe]
jwe
parents:
diff changeset
80
12140
bce5b7c1a20a Update README.devel for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 10495
diff changeset
81 Last updated: Sat Jan 22 21:26:18 PST 2011