[Mono-docs-list] monoapi Documentation

Jonathan Pryor jonpryor at vt.edu
Wed Oct 29 11:33:01 EDT 2008


After hunting around for a bit (wondering why my openSUSE monodoc had
mono embedding documentation but not my local build), I found that
mono/mono/docscripts generates the monoapi{.source,.tree.zip} files
needed to display mono embedding documentation within monodoc.

The downside is that these files are NOT built and installed as part of
the normal build process, they require special handling.  And since
we've merged the monodoc & mcs modules for Mono 2.2, I don't think this
"special handling" will be valid anymore (particularly wrt the
monodoc.xml changes -- monoapi.source will need _some_ (minor) changes
to display documentation in the right spot).

Thus, a question/proposal; could we:

1. Move mono/mono/docscripts/* into mono/docs.
2. Change mono/Makefile.am so that docs is built *after* runtime.
   This looks safe, as mono/docs/Makefile.am doesn't really do anything.
3. Always build/install the monoapi documentation as part of the normal 
   build process.
4. Update the RPM .spec file to install the monoapi files
   (necessary so that we don't "lose" the monoapi documentation between
   2.0 and 2.2.)

(1), (2), and (4) should be quite straightforward; it's (3) I worry
about; is there a way to "safely" use mcs-located tools from mono as
part of the build process?  I *think* I should be able to use
$(mcs_topdir) and $(builddir) to launch managed apps, e.g.

	$(builddir)/runtime/mono-wrapper \
	  $(mcs_topdir)/tools/mdoc/mdoc.exe ...

Though I'm not entirely sure if this is fully supported...

Thanks,
 - Jon




More information about the Mono-docs-list mailing list