1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<html lang="en">
<head>
<title>Other Sources - Untitled</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="Untitled">
<meta name="generator" content="makeinfo 4.11">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Contributing-Guidelines.html#Contributing-Guidelines" title="Contributing Guidelines">
<link rel="prev" href="C_002b_002b-Sources.html#C_002b_002b-Sources" title="C++ Sources">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Other-Sources"></a>
Previous: <a rel="previous" accesskey="p" href="C_002b_002b-Sources.html#C_002b_002b-Sources">C++ Sources</a>,
Up: <a rel="up" accesskey="u" href="Contributing-Guidelines.html#Contributing-Guidelines">Contributing Guidelines</a>
<hr>
</div>
<h3 class="section">D.5 Other Sources</h3>
<p>Apart from C++ and Octave language (m-files), Octave's sources include files
written in C, Fortran, M4, perl, unix shell, AWK, texinfo and TeX. There are
not many rules to follow when using these other languages; some of them are
summarized below. In any case, the golden rule is: if you modify a source
file, try to follow any conventions you can detect in the file or other similar
files.
<p>For C you should obviously follow all C++ rules that can apply.
<p>If you happen to modify a Fortran file, you should stay within Fortran 77
with common extensions like <code>END DO</code>. Currently, we want all sources
to be compilable with the f2c and g77 compilers, without special flags if
possible. This usually means that non-legacy compilers also accept the sources.
<p>The M4 macro language is mainly used for autoconf configuration files. You should
follow normal M4 rules when contributing to these files. Some M4 files come
from external source, namely the Autoconf archive
<a href="http://autoconf-archive.cryp.to">http://autoconf-archive.cryp.to</a>.
<p>If you give a code example in the documentation written in texinfo with the
<code>@example</code> environment, you should be aware that the text within such an
environment will not be wrapped. It is recommended that you keep the lines
short enough to fit on pages in the generated pdf or ps documents. Here is a
ruler (in an <code>@example</code> environment) for finding the appropriate line
width:
<pre class="example"> 1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890
</pre>
<!-- DO NOT EDIT! Generated automatically by munge-texi. -->
<!-- Copyright (C) 1996, 1997, 1999, 2000, 2002, 2004, 2007, 2009 John W. Eaton -->
<!-- This file is part of Octave. -->
<!-- Octave is free software; you can redistribute it and/or modify it -->
<!-- under the terms of the GNU General Public License as published by the -->
<!-- Free Software Foundation; either version 3 of the License, or (at -->
<!-- your option) any later version. -->
<!-- Octave is distributed in the hope that it will be useful, but WITHOUT -->
<!-- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -->
<!-- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -->
<!-- for more details. -->
<!-- You should have received a copy of the GNU General Public License -->
<!-- along with Octave; see the file COPYING. If not, see -->
<!-- <http://www.gnu.org/licenses/>. -->
<!-- The text of this file appears in the file BUGS in the Octave -->
<!-- distribution, as well as in the Octave manual. -->
</body></html>
|
