From: Richard W.M. Jones <rjones@redhat.com> <"Richard W.M. Jones <rjones@redhat.com>">
Date: Wed, 23 Jul 2008 13:20:56 +0000 (+0100)
Subject: Fix 'make doc' and turn http://... into real links.
X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=8d9837165c14c181d5ce3f59fbd39afcb80ac8cc;p=virt-mem.git

Fix 'make doc' and turn ... into real links.
---

diff --git a/.hgignore b/.hgignore
index 1aa7b55..06a3ff6 100644
--- a/.hgignore
+++ b/.hgignore
@@ -19,6 +19,7 @@ config.status
 configure
 gmon.out
 virt-mem-*.tar.gz
+html
 lib/virt_mem_gettext.ml
 lib/virt_mem_version.ml
 lib/test_mmap
diff --git a/Make.rules.in b/Make.rules.in
index 0ce95e2..b22f337 100644
--- a/Make.rules.in
+++ b/Make.rules.in
@@ -23,9 +23,6 @@ OCAMLDEP	= @OCAMLDEP@
 OCAMLC		= @OCAMLC@
 OCAMLOPT	= @OCAMLOPT@
 
-OCAMLDOC        = @OCAMLDOC@
-OCAMLDOCFLAGS	+= -html -sort
-
 # Common rules for building OCaml objects.
 
 .mli.cmi:
@@ -52,17 +49,6 @@ ifeq ($(wildcard .depend),.depend)
 include .depend
 endif
 
-# Developer documentation (in html/ subdirectory).
-
-ifneq ($(OCAMLDOC),)
-ifneq ($(OCAMLDOCFILES),)
-doc:
-	rm -rf html
-	mkdir html
-	-$(OCAMLDOC) $(OCAMLDOCFLAGS) -d html $(OCAMLDOCFILES)
-endif
-endif
-
 .PHONY: depend dist check-manifest dpkg doc
 
 .SUFFIXES:      .cmo .cmi .cmx .ml .mli .mll .mly
diff --git a/Makefile.in b/Makefile.in
index cca6388..28e7858 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -24,6 +24,10 @@ MKDIR_P		= @MKDIR_P@
 datarootdir	= @datarootdir@
 mandir		= @mandir@
 
+OCAMLDOCFLAGS	= -html -sort -package bitstring,extlib -I lib
+OCAMLDOC	= @OCAMLDOC@
+OCAMLDOCFILES	= lib/virt_mem_utils.ml lib/virt_mem_mmap.mli lib/virt_mem.mli
+
 HAVE_PERLDOC    = @HAVE_PERLDOC@
 
 TOOLS		= uname dmesg ps
@@ -51,7 +55,7 @@ install: install-man
 	  if [ $$? -ne 0 ]; then exit 1; fi; \
 	done
 
-depend doc:
+depend:
 	for d in $(SUBDIRS_NOT_PO); do \
 	  $(MAKE) -C $$d $@; \
 	  if [ $$? -ne 0 ]; then exit 1; fi; \
@@ -73,6 +77,17 @@ distclean: clean
 	rm -f Makefile
 	rm -f */Makefile
 
+# Developer documentation (in html/ subdirectory).
+
+ifneq ($(OCAMLDOC),)
+ifneq ($(OCAMLDOCFILES),)
+doc:
+	rm -rf html
+	mkdir html
+	-ocamlfind ocamldoc $(OCAMLDOCFLAGS) -d html $(OCAMLDOCFILES)
+endif
+endif
+
 # Manual page.
 
 ifeq ($(HAVE_PERLDOC),perldoc)
diff --git a/lib/Makefile.in b/lib/Makefile.in
index d530c20..1b46ebe 100644
--- a/lib/Makefile.in
+++ b/lib/Makefile.in
@@ -41,8 +41,6 @@ OCAMLOPTFLAGS	= @OCAMLOPTFLAGS@ $(SYNTAX)
 OCAMLOPTPACKAGES = $(OCAMLCPACKAGES)
 OCAMLOPTLIBS	= -linkpkg
 
-OCAMLDOCFLAGS	= -html -sort $(OCAMLCPACKAGES) $(SYNTAX)
-
 OCAMLDEPFLAGS	= $(SYNTAX)
 
 TARGETS		= virt_mem.cma virt_mem.cmxa
diff --git a/lib/virt_mem.mli b/lib/virt_mem.mli
index 2f6ba86..d0ead0d 100644
--- a/lib/virt_mem.mli
+++ b/lib/virt_mem.mli
@@ -1,3 +1,4 @@
+(** Memory info for virtual domains. *)
 (* Memory info for virtual domains.
    (C) Copyright 2008 Richard W.M. Jones, Red Hat Inc.
    http://libvirt.org/
diff --git a/lib/virt_mem_mmap.mli b/lib/virt_mem_mmap.mli
index 50650b4..c66ba79 100644
--- a/lib/virt_mem_mmap.mli
+++ b/lib/virt_mem_mmap.mli
@@ -87,8 +87,14 @@ type ('ws,'e,'hm) t
     initializing certain parts of the memory map.  If you are not
     familiar with phantom types, you can just ignore them.
 
-    See also:
-    [http://camltastic.blogspot.com/2008/05/phantom-types.html] *)
+    See also
+    {{:http://camltastic.blogspot.com/2008/05/phantom-types.html}this
+    posting about the phantom types used in virt-mem}.
+
+    The memory map structure is an example of a
+    {{:http://en.wikipedia.org/wiki/Purely_functional}persistent
+    data structure}.
+*)
 
 type addr = int64
 (** Virtual memory addresses (even on 32 bit machines). *)
diff --git a/po/virt-mem.pot b/po/virt-mem.pot
index 230cb45..a4bfe93 100644
--- a/po/virt-mem.pot
+++ b/po/virt-mem.pot
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2008-07-23 11:53+0000\n"
+"POT-Creation-Date: 2008-07-23 13:08+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"