Mercurial > octave-nkf

annotate etc/HACKING @ 20614:10ec79b47808

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
use new string_value method to handle value extraction errors * __voronoi__.cc, chol.cc, colamd.cc, fftw.cc: Use new string_value method.
author John W. Eaton <jwe@octave.org>
date Thu, 08 Oct 2015 18:15:56 -0400
parents 4197fc428c7d
children
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
18286
de72c443ed3f HACKING: Refer to install.txi for the full dependency list (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 17800
diff changeset
57 In addition to these maintainer tools, Octave makes use of many external
de72c443ed3f HACKING: Refer to install.txi for the full dependency list (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 17800
diff changeset
58 libraries and packages. See the file doc/interpreter/install.txi for the
de72c443ed3f HACKING: Refer to install.txi for the full dependency list (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 17800
diff changeset
59 complete list of required and optional dependencies.
de72c443ed3f HACKING: Refer to install.txi for the full dependency list (bug #41233)
Mike Miller <mtmiller@ieee.org>
parents: 17800
diff changeset
60
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
61 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
62 Later, after synchronizing from the repository, a plain `make' should
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
63 be sufficient.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
64
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
65 ** First clone
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
66
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
67 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
68 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
69 relevant information on downloading sources at:
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
70
15497
c49d891eb263 Update broken or inconsistent project and wiki urls
Mike Miller <mtmiller@ieee.org>
parents: 14138
diff changeset
71 http://www.octave.org/download.html
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
72
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
73 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
74
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
75 $ ./bootstrap
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
76
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
77 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
78 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
79 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
80 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
81 be updated from the gnulib sources as necessary.
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 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
84 source tree, then pass the name of the directory containing gnulib-tool
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18286
diff changeset
85 to the bootstrap script using the option:
9949
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
86
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
87 --gnulib-srcdir=DIRNAME
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
88
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
89 If you have downloaded gnulib directly, DIRNAME will be the directory where
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18286
diff changeset
90 gnulib was unpacked. If you have installed gnulib using a package
9977
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
91 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
92 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
93
711aa22ff83d Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents: 9949
diff changeset
94 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
95 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
96 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
97 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
98 a past revision not too far in the past.
9949
a6308dcad5ac update HACKING file
John W. Eaton <jwe@octave.org>
parents: 9946
diff changeset
99
15414
494f9bac8862 build: Rename autogen.sh script to bootstrap to conform to GNU guidelines.
Rik <rik@octave.org>
parents: 15280
diff changeset
100 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
101 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
102
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
103 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
104 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
105 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
106 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
107 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
108
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
109 $ mkdir .build
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
110 $ cd .build
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
111 $ ../configure
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
112 $ make
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
113 $ make check
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
114
14646
f40c355491cc doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
115 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
116 and the currently visited hg revision:
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
117
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
118 $ hg diff
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
119
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
120 should output no difference.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
121
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
122 ** Coding style
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
123
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
124 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
125 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
126 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
127 "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
128
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
129 * Bugs and patches
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
130
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
131 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
132 and preparing patches.
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 * Code layout
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
135
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
136 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
137
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
138 build-aux -- scripts which support the build process
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
139
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
140
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
141 doc -- Texinfo documentation for Octave
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
142
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
143
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
144 etc -- miscellaneous files, such as this HACKING howto
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
145
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
146
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
147 examples -- some example files (mkoctfile and mex samples, old class
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
148 programming interface)
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
149
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
150
15921
d4671167972b * etc/HACKING: Update with new gnulib info.
John W. Eaton <jwe@octave.org>
parents: 15512
diff changeset
151 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
152 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
153 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
154 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
155 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
156 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
157 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
158 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
159 include small updates.
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
160
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
161
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
162 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
163 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
164 bootstrap script.
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
165
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
166
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
167 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
168 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
169 functions
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
170
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
171 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
172
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
173 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
174
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
175 amos bessel functions
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
176
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
177 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
178
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
179 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
180
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
181 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
182
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
183 dassl differential-algebraic system solver
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
184
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
185 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
186
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
187 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
188
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
189 misc miscellaneous utilities
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
190
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
191 odepack ordinary differential equation solver
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
192
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
193 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
194
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
195 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
196
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
197 ranlib random number generators
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
198
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
199 slatec-err slatec error handling library
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
200
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
201 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
202
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
203 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
204 algorithms
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
205
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
206 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
207
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
208 system OS-related functions
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18286
diff changeset
209
15280
2dd4f5930108 * doc: Update HACKING file with new locations in liboctave for source files.
Rik <rik@octave.org>
parents: 15198
diff changeset
210 util utility and miscellaneous functions
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
211
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
212 libinterp -- the interpreter itself plus lots of infrastructure
13921
712f45010543 doc: Update HACKING file
Rik <octave@nomad.inbox5.com>
parents: 13244
diff changeset
213 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
214 hierarchy for polymorphically handling all Octave
13921
712f45010543 doc: Update HACKING file
Rik <octave@nomad.inbox5.com>
parents: 13244
diff changeset
215 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
216 also defined here.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
217
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
218 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
219 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
220 types like struct numerical arrays, structure
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
221 arrays, and cell arrays.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
222
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
223 parse-tree Classes that define the parse tree for the
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
224 interpreter
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
225
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
226 corefcn statically linked DEFUN functions (callable from
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
227 the scripting langauge) as well as internal C++
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
228 functions used by the interpreter.
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
229
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
230 dldfcn dynamically linked DEFUN functions (callable
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
231 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
232 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
233 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
234 source code.
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
235
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
236 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
237 operators for all possible Octave type
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
238 combinations
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
239
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
240 template-inst some C++ template instantiations
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
241
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 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
244
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
245 kb-layouts various files need by the qterminal widget that has
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
246 been derived from Konsole
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
247
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
248 languages translation files and list of translators
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
249
15979
3cd3b548f90b Update description of qterminal directory
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 15921
diff changeset
250 qterminal Qt terminal widget
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
251
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
252 src source files
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
253
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
254 icons icon files that will be compiled into the
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
255 executable via a resource file
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
256
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
257 m-editor source files for the m-file editor
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
258
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
259 qtinfo source files for the Qt texinfo browser
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
260
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
261
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
262 m4 -- m4 scripts used by configure during the build process
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
263
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
264
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
265 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
266
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
267 @ftp ftp object class
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
268
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
269 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
270
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
271 deprecated older deprecated functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
272
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
273 elfun elementary mathematical functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
274
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
275 general utility functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
276
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
277 geometry geometry algorithms
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
278
17572
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
279 gui User-Interface (UI) functions
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
280
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
281 help help subsystem functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
282
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
283 image image processing
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
284
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
285 io input/output functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
286
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
287 linear-algebra linear algebra stuff
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
288
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
289 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
290
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
291 optimization zero finders and minimizers
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
292
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
293 path functions for path manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
294
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
295 pkg the package manager
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
296
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
297 plot plotting functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
298
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
299 polynomial polynomial manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
300
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
301 prefs user-defined preferences
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
302
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
303 set set manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
304
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
305 signal signal processing
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
306
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
307 sparse sparse matrix support
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
308
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
309 specfun special mathematical functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
310
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
311 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
312
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
313 startup initialization functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
314
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
315 statistics statistical functions, distributions, and tests
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
316
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
317 strings character string manipulation
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
318
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
319 testfun unit testing
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 time time and date functions
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
322
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
323
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
324 src -- code for the actual executables that are created. This
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
325 includes octave, octave-cli, octave-gui, as well as
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
326 mkoctfile.
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
327
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
328
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
329 test -- tests for the interpreter
15198
c3d463c93604 * HACKING: Update for libinterp and libgui changes.
John W. Eaton <jwe@octave.org>
parents: 15194
diff changeset
330
17794
7e9382588570 HACKING: Update information for impending 3.8 release.
Rik <rik@octave.org>
parents: 17744
diff changeset
331 *.tst 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
332
17572
7bb76a22cde1 maint: Split scripts/plot directory into 4 pieces.
Rik <rik@octave.org>
parents: 16664
diff changeset
333 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
334 .m files
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
335
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
336 ----
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
337 John W. Eaton
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
338 jwe@octave.org
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
339
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 18286
diff changeset
340 Last updated: Tue, 29 Oct 2013 11:42:47 PDT
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
341
13244
00c5d8d3ee00 Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 12733
diff changeset
342
12139
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
343
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
344 ################################################################################
2162104d40b1 Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents: 9977
diff changeset
345
19731
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19627
diff changeset
346 Copyright (C) 2009-2015 John W. Eaton
9946
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
347
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
348 This file is part of Octave.
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 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
351 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
352 Free Software Foundation; either version 3 of the License, or (at
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
353 your option) any later version.
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 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
356 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
357 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
358 for more details.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
359
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
360 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
361 along with Octave; see the file COPYING. If not, see
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
362 <http://www.gnu.org/licenses/>.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
363
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
364
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
365 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
366 GNU Bison, which contained the following Copyright notice:
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 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
369 Free Software Foundation, Inc.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
370
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
371 This file is part of GNU Bison.
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 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
374 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
375 the Free Software Foundation, either version 3 of the License, or
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
376 (at your option) any later version.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
377
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
378 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
379 but WITHOUT ANY WARRANTY; without even the implied warranty of
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
380 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
381 GNU General Public License for more details.
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
382
55061c7c8d6e start using gnulib
John W. Eaton <jwe@octave.org>
parents:
diff changeset
383 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
384 along with this program. If not, see <http://www.gnu.org/licenses/>.