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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
<html>
<head>
<title>AOLserver</title>
</head>
<body>
<h1>AOLserver C Module Example</h1>
<p>
$Header: /cvsroot/aolserver/aolserver.com/docs/devel/c/c-module-example.html,v 1.1 2002/03/07 19:15:35 kriston Exp $
<p>
<a href=#1>C Module Example</a>
<p>
<a href=#2>Download the Example</a>
<p>
<h2><a name=1>C Module Example</a></h2>
<p>
This module demonstrates some guidelines to follow when creating an
AOLserver module. Here they are in a nutshell:
<p>
1) Each module has a readme file. The file can be named
README-modulename.txt or readme.txt (the first form is preferred).
<p>
2) Each file has an entry called "(dollar-sign)Header: (dollar-sign)"
near the top of the document. This includes html, adp, tcl, java, c,
as well as any plain text file. Data files directly read by a module
may be excluded.
<p>
3) The Makefile follows the format of the example provided here and
must be named "<b>Makefile</b>" (not "makefile"): <a
href=Makefile.txt>Makefile</a>
<p>
4) A ChangeLog file reflects the changes made to the code and must be
named "<b>ChangeLog</b>". This can be a simple cut-and-paste of your
CVS log entry. This is absolutely essential! Emacs users can type
"C-x 4 a" to automatically create ChangeLog entries. <a
href=ChangeLog.txt>ChangeLog</a>.
<p>
5) Modules should follow the AOLserver Engineering Manual guidelines
at http://aolserver.com/ as closely as possible.
<p>
6) CVS tags include the name of the module followed by the version.
This is typically "nsmodulename3_0" or "nsmodulename_v3_0" (or even
just "nsmodulename_v3"). Major and minor numbers are delimited by
underscores since CVS doesn't allow the use of the period character.
Tags should be done with care.
<p>
7) Try not to type cvs commands in your $TOP directory. Always work
from the subdirectory. The only exception to this is "cvs update" and
"cvs checkout".
<p>
Thanks for reading, and contribute away!
<p>
<h2><a name=2>C Module Example</a></h2>
<p>
<b>
<a href=nsexample.c.txt>nsexample.c</a>
<p>
<a href=ChangeLog.txt>ChangeLog</a>
<p>
<a href=Makefile.txt>Makefile</a>
<p>
<a href=nsexample_v1.tar.gz>nsexample_v1.tar.gz</a>
</b>
<p>
</body>
</html>
|
