Mercurial > octave-nkf
annotate etc/HACKING @ 15194:0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
* translators: Moved to languages subdirectory.
* HACKING: Added GUI structure.
author | Jacob Dawid <jacob.dawid@cybercatalyst.net> |
---|---|
date | Sat, 18 Aug 2012 12:01:06 +0200 |
parents | f40c355491cc |
children | c3d463c93604 |
rev | line source |
---|---|
9946 | 1 -*- outline -*- |
2 | |
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 | 5 |
6 * Working from the repository | |
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 | 10 These requirements do not apply when building from a distribution tarball. |
9946 | 11 |
12 ** Requirements | |
13 | |
14 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
|
15 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
|
16 more requirements on anyone wishing to build from the just-cloned |
9946 | 17 sources. For example, you have to use the latest stable versions of |
18 the maintainer tools we depend upon, including: | |
19 | |
20 - Autoconf <http://www.gnu.org/software/autoconf/> | |
21 - Automake <http://www.gnu.org/software/automake/> | |
22 - Bison <http://www.gnu.org/software/bison/> | |
23 - Flex <http://www.gnu.org/software/flex/> | |
24 - Git <http://git-scm.com/> | |
25 - Gnulib <http://www.gnu.org/software/gnulib/> | |
26 - GNU Make <http://www.gnu.org/software/make/> | |
27 - Gzip <http://www.gnu.org/software/gzip/> | |
28 - Libtool <http://www.gnu.org/software/libtool/> | |
29 - Mercurial <http://mercurial.selenic.com/> | |
30 - Perl <http://www.cpan.org/> | |
31 - Rsync <http://samba.anu.edu.au/rsync/> | |
32 - Tar <http://www.gnu.org/software/tar/> | |
33 | |
34 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
|
35 Later, after synchronizing from the repository, a plain `make' should |
9946 | 36 be sufficient. |
37 | |
14646
f40c355491cc
doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
38 ** First clone |
9946 | 39 |
14646
f40c355491cc
doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
40 If you are reading these notes, you may have already managed to clone |
9946 | 41 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
|
42 relevant information on downloading sources at: |
9946 | 43 |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
44 http://www.gnu.org/software/octave/download.html |
9946 | 45 |
14646
f40c355491cc
doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
46 After cloning Octave, you will need to run the autogen.sh script: |
9946 | 47 |
48 $ ./autogen.sh | |
49 | |
50 This script will examine the source tree and generate some Makefile | |
51 fragments and then runs the bootstrap script. The bootstrap script comes | |
9977
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
52 from gnulib, but is kept in the Octave source archive. It should be |
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
53 updated from the gnulib sources as necssary. The bootstrap script takes |
14646
f40c355491cc
doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
54 care of running the autotools and generating the configure script. |
9949 | 55 |
56 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
|
57 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
|
58 to the bootstrap script using the option: |
9949 | 59 |
60 --gnulib-srcdir=DIRNAME | |
61 | |
9977
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
62 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
|
63 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
|
64 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
|
65 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
|
66 |
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
67 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
|
68 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
|
69 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
|
70 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
|
71 a past revision not too far in the past. |
9949 | 72 |
9977
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
73 Additional options besides --gnulib-srcdir can be passed to autogen.sh and |
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
74 they will be forwarded without modification to the bootstrap script. |
711aa22ff83d
Elaborate which DIRNAME to use for --gnulib-srcdir option in HACKING file
Rik <rdrider0-list@yahoo.com>
parents:
9949
diff
changeset
|
75 |
9949 | 76 Once the autogen.sh and bootstrap scripts complete successfully, you may |
77 run | |
9946 | 78 |
79 $ ./configure | |
80 $ make | |
81 $ make check | |
82 | |
14646
f40c355491cc
doc: Modify the language in HACKING concerning cloning and git subrepo
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
14138
diff
changeset
|
83 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
|
84 and the currently visited hg revision: |
9946 | 85 |
86 $ hg diff | |
87 | |
88 should output no difference. | |
89 | |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
90 ** Coding style |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
91 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
92 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
|
93 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
|
94 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
|
95 "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
|
96 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
97 * Bugs and patches |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
98 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
99 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
|
100 and preparing patches. |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
101 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
102 * Code layout |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
103 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
104 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
|
105 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
106 doc -- Texinfo documentation for Octave |
9946 | 107 |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
108 examples -- some example files |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
109 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
110 libcruft -- various numerical libraries (mostly Fortran) |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
111 amos * bessel functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
112 blas-xtra * wrappers for blas functions used in Octave |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
113 daspk * large scale differential algebraic equation solver |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
114 dasrt * differential algebraic equation solver with root finding |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
115 dassl * differential-algebraic system solver |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
116 fftpack * subroutines for fast fourier transforms |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
117 lapack-xtra * wrappers for lapack functions used in Octave |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
118 misc * miscellaneous utilities |
13921 | 119 odepack * ordinary differential equation solver |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
120 ordered-qz * code for ordering eigenvalues for QZ factorization |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
121 quadpack * subroutines for numerical integration |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
122 ranlib * random number generators |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
123 slatec-err * slatec error handling library |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
124 slatec-fn * various special function subroutines |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
125 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
126 liboctave -- the C++ interfaces to the numerical libraries and |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
127 various OS facilities |
9946 | 128 |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
129 scripts -- functions written in the Octave language |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
130 audio * play and record sound files (system dependent) |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
131 deprecated * older deprecated functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
132 elfun * elementary mathematical functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
133 @ftp * ftp object class |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
134 general * utility functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
135 geometry * geometry algorithms |
13921 | 136 help * help subsystem functions |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
137 image * image processing |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
138 io * input/output functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
139 linear-algebra * linear algebra stuff |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
140 miscellaneous * stuff that doesn't fit anywhere else |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
141 optimization * zero finders and minimizers |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
142 path * functions for path manipulation |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
143 pkg * the package manager |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
144 plot * plotting functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
145 polynomial * polynomial manipulation |
13921 | 146 prefs * user-defined preferences |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
147 set * set manipulation |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
148 signal * signal processing |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
149 sparse * sparse matrix support |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
150 specfun * special mathematical functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
151 special-matrix * functions for generating special types of matrices |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
152 startup * initialization functions |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
153 statistics * statistical functions, distributions, and tests |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
154 strings * character string manipulation |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
155 testfun * unit testing |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
156 time * time and date functions |
9946 | 157 |
13244
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
158 src -- the interpreter itself plus lots of infrastructure |
13921 | 159 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
|
160 hierarchy for polymorphically handling all Octave |
13921 | 161 types is defined here. The built-in functions are |
13244
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
162 also defined here, so if "help foo" tells you foo is |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
163 built-in, its source will be somewhere in this |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
164 directory. |
13921 | 165 DLD-FUNCTIONS * Dynamically linked oct files. If you see "help foo" |
13244
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
166 telling you that foo is defined in foo.oct, then |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
167 foo.cc will be found here and contain the source |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
168 code. |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
169 OPERATORS * Definitions and template instantiations for |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
170 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
|
171 combinations. |
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
172 TEMPLATE-INST * Some C++ template instantiations. |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
173 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
174 test -- tests for the interpreter |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
175 test_*.m * fixed tests for the interpreter |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
176 fntests.m * script to run function tests embedded in C++ and .m files |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
177 |
15194
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
178 gui -- the graphical user interface of GNU Octave |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
179 src * source files. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
180 m-editor * source files for the m-file editor. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
181 octave-adapter * souce files for the octave layer for threadsafe |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
182 communication with the octave interpreter. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
183 qtinfo * source files for the Qt texinfo browser. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
184 icons * icon files that will be compiled into the executable via |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
185 a resource file. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
186 qterminal * subrepository for the qterminal Qt terminal widget. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
187 languages * translation files and list of translators. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
188 kb-layouts * various files need by the qterminal widget that has been |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
189 derived from Konsole. |
0f0b795044c3
Moved translators file and added GUI structure to etc/HACKING.
Jacob Dawid <jacob.dawid@cybercatalyst.net>
parents:
14646
diff
changeset
|
190 |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
191 ---- |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
192 John W. Eaton |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
193 jwe@octave.org |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
194 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
195 |
13921 | 196 Last updated: Tue Nov 22 20:51:34 PST 2011 |
13244
00c5d8d3ee00
Explain a bit more the src/ directory in HACKING file
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents:
12733
diff
changeset
|
197 |
12139
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
198 |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
199 ################################################################################ |
2162104d40b1
Revise HACKING file and incorporate all of ROADMAP file.
Rik <octave@nomad.inbox5.com>
parents:
9977
diff
changeset
|
200 |
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13921
diff
changeset
|
201 Copyright (C) 2009,2012 John W. Eaton |
9946 | 202 |
203 This file is part of Octave. | |
204 | |
205 Octave is free software; you can redistribute it and/or modify it | |
206 under the terms of the GNU General Public License as published by the | |
207 Free Software Foundation; either version 3 of the License, or (at | |
208 your option) any later version. | |
209 | |
210 Octave is distributed in the hope that it will be useful, but WITHOUT | |
211 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
212 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
213 for more details. | |
214 | |
215 You should have received a copy of the GNU General Public License | |
216 along with Octave; see the file COPYING. If not, see | |
217 <http://www.gnu.org/licenses/>. | |
218 | |
219 | |
220 This file was adapted for Octave from the HACKING file that is part of | |
221 GNU Bison, which contained the following Copyright notice: | |
222 | |
223 Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009 | |
224 Free Software Foundation, Inc. | |
225 | |
226 This file is part of GNU Bison. | |
227 | |
228 This program is free software: you can redistribute it and/or modify | |
229 it under the terms of the GNU General Public License as published by | |
230 the Free Software Foundation, either version 3 of the License, or | |
231 (at your option) any later version. | |
232 | |
233 This program is distributed in the hope that it will be useful, | |
234 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
235 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
236 GNU General Public License for more details. | |
237 | |
238 You should have received a copy of the GNU General Public License | |
239 along with this program. If not, see <http://www.gnu.org/licenses/>. |