blob: 9b706c7f36d229b113edd4a1865de6a21fa323ee [file] [log] [blame]
Daniel Dunbar1ede17a2008-07-26 21:32:24 +00001##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
5# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
7#
8##===----------------------------------------------------------------------===##
9
10LEVEL := ../../..
Daniel Dunbardbec0332009-04-29 01:00:32 +000011DIRS := tools
Daniel Dunbar1ede17a2008-07-26 21:32:24 +000012
13ifdef BUILD_FOR_WEBSITE
14PROJ_OBJ_DIR = .
15DOXYGEN = doxygen
16
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' \
21 -e 's/@PACKAGE_VERSION@/mainline/' \
22 -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)
Mike Stumpc7856762008-08-12 00:32:59 +000029#IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Daniel Dunbar1ede17a2008-07-26 21:32:24 +000030DOXYFILES := 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 generated
35
Daniel Dunbare0a80922009-05-01 23:11:42 +000036install_targets :=
37ifndef ONLY_MAN_DOCS
38install_targets += install-html
39endif
Daniel Dunbar1ede17a2008-07-26 21:32:24 +000040ifeq ($(ENABLE_DOXYGEN),1)
41install_targets += install-doxygen
42endif
43install-local:: $(install_targets)
44
45# Live documentation is generated for the web site using this target:
46# 'make generated BUILD_FOR_WEBSITE=1'
47generated:: doxygen
48
49install-html: $(PROJ_OBJ_DIR)/html.tar.gz
50 $(Echo) Installing HTML documentation
51 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
52 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
53 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
Mike Stumpc7856762008-08-12 00:32:59 +000054# $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
Daniel Dunbar1ede17a2008-07-26 21:32:24 +000055 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
56
57$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
58 $(Echo) Packaging HTML documentation
59 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
60 $(Verb) cd $(PROJ_SRC_DIR) && \
61 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
62 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
63
64install-doxygen: doxygen
65 $(Echo) Installing doxygen documentation
66 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
67 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
68 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
69 $(FIND) . -type f -exec \
70 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
71
72doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
73
74regendoc:
75 $(Echo) Building doxygen documentation
76 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
77 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
78 fi
79 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
80
81$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
82 $(Echo) Packaging doxygen documentation
83 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
84 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
85 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
86 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
87
88userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
89
90$(LLVM_SRC_ROOT)/docs/userloc.html:
91 $(Echo) Making User LOC Table
92 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
93 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
94
95uninstall-local::
96 $(Echo) Uninstalling Documentation
97 $(Verb) $(RM) -rf $(PROJ_docsdir)