blob: 10b31d1076f82aec515be839227888e3a33b6bcc [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
Chris Lattner3876aa72007-12-29 20:11:13 +00005# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007#
8##===----------------------------------------------------------------------===##
9
10LEVEL := ..
11DIRS := CommandGuide
12
13ifdef BUILD_FOR_WEBSITE
14PROJ_OBJ_DIR = .
15DOXYGEN = doxygen
16# Extract version number from the AC_INT line in configure.ac
17# AC_INIT([[llvm]],[[2.1svn]],[llvmbugs@cs.uiuc.edu])
18PACKAGE_VERSION = $(shell grep AC_INIT ../autoconf/configure.ac | sed -e 's/^[^0-9]*\([0-9_.a-zA-Z-]*\).*/\1/' )
19
20$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
21 cat $< | sed \
22 -e 's/@abs_top_srcdir@/../g' \
23 -e 's/@DOT@/dot/g' \
24 -e 's/@PACKAGE_VERSION@/$(PACKAGE_VERSION)/' \
25 -e 's/@abs_top_builddir@/../g' > $@
26endif
27
28include $(LEVEL)/Makefile.common
29
30HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
31 $(wildcard $(PROJ_SRC_DIR)/*.css)
32IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
33DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
34 doxygen.intro
35EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
36
37.PHONY: install-html install-doxygen doxygen
38
39ifeq ($(ENABLE_DOXYGEN),1)
40install-local:: install-html install-doxygen
41else
42install-local:: install-html
43endif
44
45install-html: $(PROJ_OBJ_DIR)/html.tar.gz
46 $(Echo) Installing HTML documentation
47 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
48 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
49 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
50 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
51 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
52
53$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
54 $(Echo) Packaging HTML documentation
55 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
56 $(Verb) cd $(PROJ_SRC_DIR) && \
57 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
58 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
59
60install-doxygen: doxygen
61 $(Echo) Installing doxygen documentation
62 $(Echo) Installing doxygen documentation
63 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
64 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
65 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
66 $(FIND) . -type f -exec \
67 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
68
69doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
70
71regendoc:
72 $(Echo) Building doxygen documentation
73 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
74 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
75 fi
76 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
77
78$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
79 $(Echo) Packaging doxygen documentation
80 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
81 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
82 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
83 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
84
85userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
86
87$(LLVM_SRC_ROOT)/docs/userloc.html:
88 $(Echo) Making User LOC Table
89 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
90 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
91