summaryrefslogtreecommitdiff
path: root/storage/ndb/docs/README
blob: 262e9003aca2451cac66363cddea7623fab51971 (plain)
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
Create MySQL Cluster user documentation from source code
--------------------------------------------------------
(All these require Doxygen.) 

* make clean
  Remove all generated documentation and tmp files

* make ndbapidoc
  Makes the NDB API Programmer's Guide (in HTML)

* make ndbapipdf
  Makes the NDB API Programmer Guide (in PDF)

* make mgmapidoc
  Makes the MGM API Reference Manual (in HTML)

* make mgmapipdf
  Makes the MGM API Reference Manual (in PDF)

* make ndbdoc
  Makes source code browser for NDB Cluster (in HTML)
  (Requires Graphviz.)

Doxygen and Graphviz can be found at:
  http://www.doxygen.org
or at (for Red Hat 9.0 RPMs):
  http://dentrassi.de/download/doxygen/

--
lars@mysql.com