Adding ocamldoc generation.

Patch by Erick Tryzelaar.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48147 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/Makefile.config.in b/Makefile.config.in
index 94dce300bbf37647b564510fa74b65d324b14ef9..f3a9346592890a2029e951823bd869308af5758b 100644 (file)
--- a/Makefile.config.in
+++ b/Makefile.config.in
@@ -154,6 +154,7 @@ GZIP       := @GZIP@
 OCAMLC     := @OCAMLC@
 OCAMLOPT   := @OCAMLOPT@
 OCAMLDEP   := @OCAMLDEP@
+OCAMLDOC   := @OCAMLDOC@
 POD2HTML   := @POD2HTML@
 POD2MAN    := @POD2MAN@
 RUNTEST    := @RUNTEST@

diff --git a/autoconf/configure.ac b/autoconf/configure.ac
index b6f23a381c3d8ac07942cf5a7671b0312e065250..86459b8f710d9b936db81f11bc9a23e63acffea5 100644 (file)
--- a/autoconf/configure.ac
+++ b/autoconf/configure.ac
@@ -592,6 +592,7 @@ AC_PATH_PROG(ZIP, [zip])
 AC_PATH_PROGS(OCAMLC, [ocamlc.opt ocamlc])
 AC_PATH_PROGS(OCAMLOPT, [ocamlopt.opt ocamlopt])
 AC_PATH_PROGS(OCAMLDEP, [ocamldep.opt ocamldep])
+AC_PATH_PROGS(OCAMLDOC, [ocamldoc.opt ocamldoc])
 
 dnl Determine if the linker supports the -R option.
 AC_LINK_USE_R

diff --git a/bindings/ocaml/Makefile b/bindings/ocaml/Makefile
index 5cd3b89b5793aa915c7b497b5865db4cb1031fee..5f1788e33ea4b988460687b3ca94f6927182e483 100644 (file)
--- a/bindings/ocaml/Makefile
+++ b/bindings/ocaml/Makefile
@@ -10,4 +10,9 @@
 LEVEL := ../..
 DIRS = llvm bitreader bitwriter analysis executionengine
 
+ocamldoc:
+       $(Verb) for i in $(DIRS) ; do \
+               $(MAKE) -C $$i ocamldoc; \
+       done
+
 include $(LEVEL)/Makefile.common

diff --git a/bindings/ocaml/Makefile.ocaml b/bindings/ocaml/Makefile.ocaml
index 8edb180c3df8a0a4dec68f30368fa39d835cd918..55a052af7e0123313b647646e8b3843abdd7d863 100644 (file)
--- a/bindings/ocaml/Makefile.ocaml
+++ b/bindings/ocaml/Makefile.ocaml
@@ -285,6 +285,13 @@ uninstall-cmxa::
 
 endif
 
+##===- Generate documentation ---------------------------------------------===##
+
+$(ObjDir)/$(LIBRARYNAME).odoc: $(ObjectsCMI)
+       $(Echo) "Documenting $(notdir $@)"
+       $(Verb) $(OCAMLDOC) -I $(OcamlDir) -I $(ObjDir) -dump $@ $(OcamlHeaders)
+
+ocamldoc: $(ObjDir)/$(LIBRARYNAME).odoc
 
 ##===- Debugging gunk -----------------------------------------------------===##
 printvars:: printcamlvars

diff --git a/docs/Makefile b/docs/Makefile
index a66d5ae4e8db90907109028c2e23232fe486957b..1b5987914dc1ff30776771a05050f02344f0c2ae 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -31,13 +31,16 @@ DOXYFILES  := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
               doxygen.intro
 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
 
-.PHONY: install-html install-doxygen doxygen
+.PHONY: install-html install-doxygen doxygen install-ocamldoc ocamldoc
 
+install_targets := install-html
 ifeq ($(ENABLE_DOXYGEN),1)
-install-local:: install-html install-doxygen
-else
-install-local:: install-html
+install_targets += install-doxygen
 endif
+ifneq (,$(filter ocaml,$(BINDINGS_TO_BUILD)))
+install_targets += install-ocamldoc
+endif
+install-local:: $(install_targets)
 
 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
        $(Echo) Installing HTML documentation
@@ -55,7 +58,6 @@ $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
        $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
 
 install-doxygen: doxygen
-       $(Echo) Installing doxygen documentation
        $(Echo) Installing doxygen documentation
        $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
        $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
@@ -85,4 +87,31 @@ $(LLVM_SRC_ROOT)/docs/userloc.html:
        $(Echo) Making User LOC Table
        $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
          -html lib include tools runtime utils examples autoconf test > docs/userloc.html
-         
+
+install-ocamldoc: ocamldoc
+       $(Echo) Installing ocamldoc documentation
+       $(Verb) $(MKDIR) $(PROJ_docsdir)/ocamldoc/html
+       $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_docsdir)
+       $(Verb) cd $(PROJ_OBJ_DIR)/ocamldoc && \
+         $(FIND) . -type f -exec \
+           $(DataInstall) {} $(PROJ_docsdir)/ocamldoc/html \;
+
+ocamldoc: regen-ocamldoc $(PROJ_OBJ_DIR)/ocamldoc.tar.gz
+
+regen-ocamldoc:
+       $(Echo) Building ocamldoc documentation
+       $(Verb) if test -e $(PROJ_OBJ_DIR)/ocamldoc ; then \
+               $(RM) -rf $(PROJ_OBJ_DIR)/ocamldoc ; \
+       fi
+       $(Verb) $(MAKE) -C $(LEVEL)/bindings/ocaml ocamldoc
+       $(Verb) $(MKDIR) $(PROJ_OBJ_DIR)/ocamldoc/html
+       $(Verb) \
+               $(OCAMLDOC) -d $(PROJ_OBJ_DIR)/ocamldoc/html -sort -colorize-code -html \
+               `$(FIND) $(LEVEL)/bindings/ocaml -name "*.odoc" -exec echo -load '{}' ';'`
+
+$(PROJ_OBJ_DIR)/ocamldoc.tar.gz:
+       $(Echo) Packaging ocamldoc documentation
+       $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/ocamldoc.tar
+       $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/ocamldoc.tar ocamldoc
+       $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/ocamldoc.tar
+       $(Verb) $(CP) $(PROJ_OBJ_DIR)/ocamldoc.tar.gz $(PROJ_OBJ_DIR)/ocamldoc/html/