annotate etc/HACKING @ 17744:d63878346099

maint: Update copyright notices for release.
author John W. Eaton <jwe@octave.org>
date Wed, 23 Oct 2013 22:09:27 -0400
parents 7bb76a22cde1
children 7e9382588570
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 -*- outline -*-
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 This file attempts to describe the rules to use when hacking Octave.
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
4 DO NOT put this file into the distribution.
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 * Working from the repository
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
8 These notes are intended to help people working on sources cloned from
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
9 the savannah source code repository.
13921
712f45010543 doc: Update HACKING file
Rik <octave@nomad.inbox5.com>
parents: 13244
diff changeset
10 These requirements do not apply when building from a distribution tarball.
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11
16664
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
12 * Quick start
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
13
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
14 1. Install all the required dependencies. Precisely how to do that
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
15 depends on what type of system you are using. There are more
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
16 details below.
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
17
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
18 2. Clone the Octave sources:
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
19
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
20 hg clone http://www.octave.org/hg/octave
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
21
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
22 3. Change to the top-level directory of the Octave source tree and run
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
23 the bootstrap script:
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
24
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
25 cd octave
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
26 ./bootstrap
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
27
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
28 4. Create a build directory, cd to it, then run configure and make:
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
29
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
30 mkdir .build
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
31 cd .build
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
32 ../configure
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
33 make
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
34
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 ** Requirements
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 We've opted to keep only the highest-level sources in the repository.
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
38 This eases our maintenance burden, (fewer merges, etc.), but imposes
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
39 more requirements on anyone wishing to build from the just-cloned
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 sources. For example, you have to use the latest stable versions of
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 the maintainer tools we depend upon, including:
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 - Autoconf <http://www.gnu.org/software/autoconf/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
44 - Automake <http://www.gnu.org/software/automake/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45 - Bison <http://www.gnu.org/software/bison/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
46 - Flex <http://www.gnu.org/software/flex/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
47 - Gnulib <http://www.gnu.org/software/gnulib/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
48 - GNU Make <http://www.gnu.org/software/make/>
16664
789d2376db2d maint: update etc/HACKING
John W. Eaton <jwe@octave.org>
parents: 16235
diff changeset
49 - gperf <http://www.gnu.org/software/gperf/>
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
50 - Gzip <http://www.gnu.org/software/gzip/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
51 - Libtool <http://www.gnu.org/software/libtool/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
52 - Mercurial <http://mercurial.selenic.com/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
53 - Perl <http://www.cpan.org/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
54 - Rsync <http://samba.anu.edu.au/rsync/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
55 - Tar <http://www.gnu.org/software/tar/>
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
56
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
57 Only building the initial full source tree will be a bit painful.
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
58 Later, after synchronizing from the repository, a plain `make' should
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
59 be sufficient.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
60
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
61 ** First clone
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
62
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
63 If you are reading these notes, you may have already managed to clone
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64 this package from the repository. For the record, you will find all the
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
65 relevant information on downloading sources at:
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66
15497
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 14138
diff changeset
67 http://www.octave.org/download.html
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
68
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
69 After cloning Octave, you will need to run the bootstrap script:
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
71 $ ./bootstrap
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
73 This script will examine the source tree and generate some Makefile
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
74 fragments, then run autotools scripts to generate Makefile.in files from
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
75 Makefile.am files and create the configure script. The bootstrap script
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
76 comes from gnulib, but is kept in the Octave source archive. It should
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
77 be updated from the gnulib sources as necessary.
9949
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
78
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
79 If you have a copy of gnulib in some directory apart from the Octave
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
80 source tree, then pass the name of the directory containing gnulib-tool
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
81 to the bootstrap script using the option:
9949
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
82
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
83 --gnulib-srcdir=DIRNAME
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
84
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
85 If you have downloaded gnulib directly, DIRNAME will be the directory where
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
86 gnulib was unpacked. If you have installed gnulib using a package
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
87 manager, DIRNAME is likely to be /usr/bin or /usr/local/bin(where the
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
88 gnulib-tool script resides).
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
89
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
90 By using an external gnulib directory, you can share a single gnulib source
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
91 tree among several projects. Since 2011, the gnulib sources are a Mercurial
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
92 subrepository, so they will be automatically updated to the
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
93 corresponding Mercurial revision if you update the working directory to
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
94 a past revision not too far in the past.
9949
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
95
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
96 Additional options besides --gnulib-srcdir can be passed to bootstrap and
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
97 they will be forwarded without modification to the gnulib bootstrap script.
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
98
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
99 Once the bootstrap script completes successfully, you may configure and
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
100 build Octave. We recommend that you build Octave in a separate
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
101 directory tree from the sources. For example, if you have just finished
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
102 running the bootstrap script in the top-level source directory, run the
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
103 following commands to create a build tree, configure, and build Octave:
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
104
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
105 $ mkdir .build
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
106 $ cd .build
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
107 $ ../configure
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
108 $ make
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
109 $ make check
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
110
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
111 At this point, there should be no difference between your working tree
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
112 and the currently visited hg revision:
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114 $ hg diff
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
115
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
116 should output no difference.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
117
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
118 ** Coding style
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
119
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
120 The most important advice is to follow any conventions you detect in the
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
121 file being edited. In addition, Octave maintainers have written a lot
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
122 on the subject. See "Appendix C: Tips and Standards" and
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
123 "Appendix D: Contributing Guidelines" in the PDF documentation.
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
124
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
125 * Bugs and patches
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
126
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
127 See the file BUGS in this directory for more guidance on reporting bugs
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
128 and preparing patches.
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
129
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
130 * Code layout
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
131
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
132 An overview of the directory layout of Octave's source files:
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
133
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
134 doc -- Texinfo documentation for Octave
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
135
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
136
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
137 examples -- some example files
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
138
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
139
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
140 gnulib-hg -- gnulib subrepo. This is a clone of the gnulib source
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
141 tree maintained by the Octave project. The default
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
142 branch is identical to the upstream gnulib sources.
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
143 There is also an "octave-stable" branch that may
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
144 contain changes as needed for the "stable" branch in
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
145 the Octave archive. We usually don't want to update
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
146 gnulib sources when going from one stable point
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
147 release to the next, but we occasionally need to
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
148 include small updates.
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
149
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
150
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
151 libgnu -- gnulib sources that we use. The files here are
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
152 copied here from the gnulib directory by the
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
153 bootstrap script.
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
154
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
155
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
156 liboctave -- C++ interfaces to the numerical libraries, Fortran
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
157 numerical libraries, various OS facilities, and utility
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
158 functions
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
159
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
160 array the base Array, NDArray, Matrix, and Sparse classes
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
161
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
162 cruft various numerical libraries (mostly Fortran)
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
163
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
164 amos bessel functions
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
165
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
166 blas-xtra wrappers for blas functions used in Octave
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
167
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
168 daspk large scale differential algebraic equation solver
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
169
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
170 dasrt differential algebraic equation solver with root finding
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
171
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
172 dassl differential-algebraic system solver
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
173
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
174 fftpack subroutines for fast fourier transforms
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
175
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
176 lapack-xtra wrappers for lapack functions used in Octave
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
177
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
178 misc miscellaneous utilities
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
179
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
180 odepack ordinary differential equation solver
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
181
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
182 ordered-qz code for ordering eigenvalues for QZ factorization
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
183
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
184 quadpack subroutines for numerical integration
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
185
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
186 ranlib random number generators
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
187
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
188 slatec-err slatec error handling library
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
189
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
190 slatec-fn various special function subroutines
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
191
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
192 numeric C++ numerical algorithms and interfaces to the Fortran
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
193 algorithms
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
194
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
195 operators code for operators that act on base classes such as Array
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
196
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
197 system OS-related functions
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
198
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
199 util utility and miscellaneous functions
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
200
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
201 libinterp -- The interpreter itself plus lots of infrastructure
13921
712f45010543 doc: Update HACKING file
Rik <octave@nomad.inbox5.com>
parents: 13244
diff changeset
202 around it. Octave's extensive octave_value class
13244
00c5d8d3ee00 Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 12733
diff changeset
203 hierarchy for polymorphically handling all Octave
13921
712f45010543 doc: Update HACKING file
Rik <octave@nomad.inbox5.com>
parents: 13244
diff changeset
204 types is defined here. The built-in functions are
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
205 also defined here.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
206
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
207 octave-value The octave_value class hierarchy. These are the
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
208 container classes that hold various Octave data
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
209 types like struct numerical arrays, structure
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
210 arrays, and cell arrays.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
211
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
212 parse-tree Classes that define the parse tree for the
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
213 interpreter.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
214
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
215 interp-core Core utilities for the interpreter. There are no
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
216 DEFUN functions (callable from the scripting
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
217 language) defined here.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
218
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
219 interpfcn Functions closely related to the interpreter.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
220 Includes DEFUN functions (callable from the
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
221 scripting language). Also may export C++ functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
222 that are used in other parts of the interpreter.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
223
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
224 corefcn Statically linked DEFUN functions (callable from
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
225 the scripting langauge). No C++ functions exported
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
226 for use in other parts of the interpreter.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
227
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
228 dldfcn Dynamically linked DEFUN functions (callable
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
229 from the scripting language). If you see "help
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
230 foo" telling you that foo is defined in foo.oct,
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
231 then foo.cc will be found here and contain the
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
232 source code.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
233
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
234 operators Definitions and template instantiations for
13244
00c5d8d3ee00 Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 12733
diff changeset
235 operators for all possible Octave type
00c5d8d3ee00 Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 12733
diff changeset
236 combinations.
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
237
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
238 template-inst Some C++ template instantiations.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
239
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
240
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
241 libgui -- the graphical user interface of GNU Octave
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
242
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
243 src source files.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
244
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
245 m-editor source files for the m-file editor.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
246
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
247 qtinfo source files for the Qt texinfo browser.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
248
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
249 icons icon files that will be compiled into the
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
250 executable via a resource file.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
251
15979
3cd3b548f90b Update description of qterminal directory
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15921
diff changeset
252 qterminal Qt terminal widget
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
253
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
254 languages translation files and list of translators.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
255
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
256 kb-layouts various files need by the qterminal widget that has
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
257 been derived from Konsole.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
258
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
259
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
260 scripts -- functions written in the Octave language
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
261
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
262 audio play and record sound files (system dependent)
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
263
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
264 deprecated older deprecated functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
265
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
266 elfun elementary mathematical functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
267
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
268 @ftp ftp object class
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
269
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
270 general utility functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
271
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
272 geometry geometry algorithms
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
273
17572
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
274 gui User-Interface (UI) functions
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
275
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
276 help help subsystem functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
277
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
278 image image processing
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
279
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
280 io input/output functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
281
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
282 linear-algebra linear algebra stuff
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
283
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
284 miscellaneous stuff that doesn't fit anywhere else
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
285
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
286 optimization zero finders and minimizers
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
287
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
288 path functions for path manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
289
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
290 pkg the package manager
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
291
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
292 plot plotting functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
293
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
294 polynomial polynomial manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
295
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
296 prefs user-defined preferences
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
297
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
298 set set manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
299
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
300 signal signal processing
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
301
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
302 sparse sparse matrix support
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
303
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
304 specfun special mathematical functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
305
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
306 special-matrix functions for generating special types of matrices
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
307
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
308 startup initialization functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
309
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
310 statistics statistical functions, distributions, and tests
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
311
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
312 strings character string manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
313
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
314 testfun unit testing
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
315
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
316 time time and date functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
317
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
318
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
319 test -- tests for the interpreter
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
320
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
321 test_ .m fixed tests for the interpreter
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
322
17572
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
323 fntests.m script to run function tests embedded in C++ and
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
324 .m files
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
325
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
326 ----
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
327 John W. Eaton
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
328 jwe@octave.org
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
329
17572
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
330 Last updated: Fri, 4 Oct 2013 16:58:52 PDT
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
331
13244
00c5d8d3ee00 Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 12733
diff changeset
332
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
333
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
334 ################################################################################
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
335
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
336 Copyright (C) 2009-2013 John W. Eaton
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
337
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
338 This file is part of Octave.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
339
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
340 Octave is free software; you can redistribute it and/or modify it
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
341 under the terms of the GNU General Public License as published by the
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
342 Free Software Foundation; either version 3 of the License, or (at
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
343 your option) any later version.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
344
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
345 Octave is distributed in the hope that it will be useful, but WITHOUT
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
346 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
347 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
348 for more details.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
349
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
350 You should have received a copy of the GNU General Public License
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
351 along with Octave; see the file COPYING. If not, see
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
352 <http://www.gnu.org/licenses/>.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
353
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
354
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
355 This file was adapted for Octave from the HACKING file that is part of
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
356 GNU Bison, which contained the following Copyright notice:
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
357
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
358 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
359 Free Software Foundation, Inc.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
360
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
361 This file is part of GNU Bison.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
362
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
363 This program is free software: you can redistribute it and/or modify
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
364 it under the terms of the GNU General Public License as published by
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
365 the Free Software Foundation, either version 3 of the License, or
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
366 (at your option) any later version.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
367
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
368 This program is distributed in the hope that it will be useful,
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
369 but WITHOUT ANY WARRANTY; without even the implied warranty of
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
370 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
371 GNU General Public License for more details.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
372
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
373 You should have received a copy of the GNU General Public License
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
374 along with this program. If not, see <http://www.gnu.org/licenses/>.