~hww3/caudium

ref: 93d5a75fba08db71b832716377276978cdd7888d caudium/autodoc/README -rw-r--r-- 844 bytes
93d5a75fWilliam Welliver storage: method "None" was missing stop function. should fix error on shutdown 1 year, 1 month ago
                                                                                
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
Notes for the Caudium autodoc
-----------------------------

We use the Pike 7.3+ autodoc system to produce documentation of the Caudium
Pike/C API. The bin/ directory contains all the original Pike files that
had to be modified in order to work with Caudium. The system processes only
the Pike API calls - it does NOT understand the Caudium
defvars/tags/containers for now. This is in the TODO :)

To generate the documentation you will need the following software:

1. Pike 7.3 sources
2. Pike 7.3 binaries
3. GNU Autoconf 2.5x+
4. GNU Make

Run the provided autogen.sh then invoke the generated configure script
passing it the path to the Pike 7.3 source tree:

./configure --with-pikesrc=/usr/src/pike-7.3

optionally you can pass the configure script a path to the pike binary it
should use using the --with-pike parameter.

grendel

$Id$