blob: a66d5ae4e8db90907109028c2e23232fe486957b [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
Dan Gohmanf17a25c2007-07-18 16:29:46 +000016
17$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
18 cat $< | sed \
19 -e 's/@abs_top_srcdir@/../g' \
20 -e 's/@DOT@/dot/g' \
Chris Lattner29325c12008-01-27 23:43:26 +000021 -e 's/@PACKAGE_VERSION@/mainline/' \
Dan Gohmanf17a25c2007-07-18 16:29:46 +000022 -e 's/@abs_top_builddir@/../g' > $@
23endif
24
25include $(LEVEL)/Makefile.common
26
27HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
28 $(wildcard $(PROJ_SRC_DIR)/*.css)
29IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
30DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
31 doxygen.intro
32EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
33
34.PHONY: install-html install-doxygen doxygen
35
36ifeq ($(ENABLE_DOXYGEN),1)
37install-local:: install-html install-doxygen
38else
39install-local:: install-html
40endif
41
42install-html: $(PROJ_OBJ_DIR)/html.tar.gz
43 $(Echo) Installing HTML documentation
44 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
45 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
46 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
47 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
48 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
49
50$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
51 $(Echo) Packaging HTML documentation
52 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
53 $(Verb) cd $(PROJ_SRC_DIR) && \
54 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
55 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
56
57install-doxygen: doxygen
58 $(Echo) Installing doxygen documentation
59 $(Echo) Installing doxygen documentation
60 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
61 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
62 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
63 $(FIND) . -type f -exec \
64 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
65
66doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
67
68regendoc:
69 $(Echo) Building doxygen documentation
70 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
71 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
72 fi
73 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
74
75$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
76 $(Echo) Packaging doxygen documentation
77 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
78 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
79 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
80 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
81
82userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
83
84$(LLVM_SRC_ROOT)/docs/userloc.html:
85 $(Echo) Making User LOC Table
86 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
87 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
88