1 ##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
3 # The LLVM Compiler Infrastructure
5 # This file was developed by the LLVM research group and is distributed under
6 # the University of Illinois Open Source License. See LICENSE.TXT for details.
8 ##===----------------------------------------------------------------------===##
13 ifdef BUILD_FOR_WEBSITE
16 # Extract version number from the AC_INT line in configure.ac
17 # AC_INIT([[llvm]],[[2.0cvs]],[llvmbugs@cs.uiuc.edu])
18 PACKAGE_VERSION = $(shell grep AC_INIT ../autoconf/configure.ac | sed -e 's/[^,]*,[[][[]//' -e 's/]],.*//')
19 $(warning VERSION=$(VERSION))
21 $(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
23 -e 's/@abs_top_srcdir@/../g' \
25 -e 's/@PACKAGE_VERSION@/$(PACKAGE_VERSION)/g' \
26 -e 's/@abs_top_builddir@/../g' > $@
29 include $(LEVEL)/Makefile.common
31 HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
32 $(wildcard $(PROJ_SRC_DIR)/*.css)
33 IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
34 DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
36 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
38 .PHONY: install-html install-doxygen doxygen
40 ifeq ($(ENABLE_DOXYGEN),1)
41 install-local:: install-html install-doxygen
43 install-local:: install-html
46 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
47 $(Echo) Installing HTML documentation
48 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
49 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
50 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
51 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
52 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
54 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
55 $(Echo) Packaging HTML documentation
56 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
57 $(Verb) cd $(PROJ_SRC_DIR) && \
58 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
59 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
61 install-doxygen: doxygen
62 $(Echo) Installing doxygen documentation
63 $(Echo) Installing doxygen documentation
64 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
65 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
66 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
67 $(FIND) . -type f -exec \
68 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
70 doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
73 $(Echo) Building doxygen documentation
74 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
75 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
77 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
79 $(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
80 $(Echo) Packaging doxygen documentation
81 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
82 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
83 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
84 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
86 userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
88 $(LLVM_SRC_ROOT)/docs/userloc.html:
89 $(Echo) Making User LOC Table
90 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
91 -html lib include tools runtime utils examples autoconf test > docs/userloc.html