blob: 96978d893ef859edb892808c96d1ad7280f2c272 [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
Daniel Dunbarafed0992010-06-08 20:34:18 +000010CLANG_LEVEL := ..
mike-m3e5d00c2010-05-07 00:42:33 +000011DIRS := tools
12
13ifdef BUILD_FOR_WEBSITE
14PROJ_OBJ_DIR = .
15DOXYGEN = doxygen
16
17$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
18 cat $< | sed \
mike-m3e5d00c2010-05-07 00:42:33 +000019 -e 's/@DOT@/dot/g' \
20 -e 's/@PACKAGE_VERSION@/mainline/' \
Michael Gottesman855baa62013-08-28 20:29:44 +000021 -e 's/@abs_builddir@/./g' \
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070022 -e 's/@abs_srcdir@/./g' \
23 -e 's/@clang_doxygen_generate_qhp@/NO/g' \
24 -e 's/@clang_doxygen_qch_filename@//g' \
25 -e 's/@clang_doxygen_qhelpgenerator_path@//g' \
26 -e 's/@clang_doxygen_qhp_cust_filter_attrs@//g' \
27 -e 's/@clang_doxygen_qhp_cust_filter_name@//g' \
28 -e 's/@clang_doxygen_qhp_namespace@//g' \
Michael Gottesman855baa62013-08-28 20:29:44 +000029 -e 's/@enable_external_search@/NO/g' \
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070030 -e 's/@enable_searchengine@/NO/g' \
31 -e 's/@enable_server_based_search@/NO/g' \
32 -e 's/@extra_search_mappings@//g' \
33 -e 's/@searchengine_url@//g' \
34 > $@
mike-m3e5d00c2010-05-07 00:42:33 +000035endif
Daniel Dunbar1ede17a2008-07-26 21:32:24 +000036
Daniel Dunbarafed0992010-06-08 20:34:18 +000037include $(CLANG_LEVEL)/Makefile
mike-m3e5d00c2010-05-07 00:42:33 +000038
39HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
40 $(wildcard $(PROJ_SRC_DIR)/*.css)
41#IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070042DOXYFILES := doxygen.cfg.in doxygen.intro
mike-m3e5d00c2010-05-07 00:42:33 +000043
44.PHONY: install-html install-doxygen doxygen generated
45
46install_targets :=
47ifndef ONLY_MAN_DOCS
48install_targets += install-html
49endif
50ifeq ($(ENABLE_DOXYGEN),1)
51install_targets += install-doxygen
52endif
53install-local:: $(install_targets)
54
55# Live documentation is generated for the web site using this target:
56# 'make generated BUILD_FOR_WEBSITE=1'
57generated:: doxygen
58
59install-html: $(PROJ_OBJ_DIR)/html.tar.gz
60 $(Echo) Installing HTML documentation
61 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html
62 $(Verb) $(MKDIR) $(DESTDIR)$(PROJ_docsdir)/html/img
63 $(Verb) $(DataInstall) $(HTML) $(DESTDIR)$(PROJ_docsdir)/html
64# $(Verb) $(DataInstall) $(IMAGES) $(DESTDIR)$(PROJ_docsdir)/html/img
65 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(DESTDIR)$(PROJ_docsdir)
66
67$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
68 $(Echo) Packaging HTML documentation
69 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
70 $(Verb) cd $(PROJ_SRC_DIR) && \
71 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
Eric Christopher3bc3c6d2010-12-10 01:59:28 +000072 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/html.tar
mike-m3e5d00c2010-05-07 00:42:33 +000073
74install-doxygen: doxygen
75 $(Echo) Installing doxygen documentation
mike-m3e5d00c2010-05-07 00:42:33 +000076 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(DESTDIR)$(PROJ_docsdir)
Pirama Arumuga Nainar3ea9e332015-04-08 08:57:32 -070077 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen/html && \
78 for DIR in $$($(FIND) . -type d); do \
79 DESTSUB="$(DESTDIR)$(PROJ_docsdir)/html/doxygen/$$(echo $$DIR | cut -c 3-)"; \
80 $(MKDIR) $$DESTSUB && \
81 $(FIND) $$DIR -maxdepth 1 -type f -exec $(DataInstall) {} $$DESTSUB \; ; \
82 if [ $$? != 0 ]; then exit 1; fi \
83 done
mike-m3e5d00c2010-05-07 00:42:33 +000084
85doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
86
87regendoc:
88 $(Echo) Building doxygen documentation
David Majnemerdd1dad92013-10-15 08:33:43 +000089 $(Verb) $(RM) -rf $(PROJ_OBJ_DIR)/doxygen
mike-m3e5d00c2010-05-07 00:42:33 +000090 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Bill Wendling5f3d6a52013-10-27 05:00:50 +000091 $(Verb) sed -i "s/[$$]LatestRev[$$]/`svnversion $(PROJ_SRC_DIR)`/g" \
92 $(PROJ_OBJ_DIR)/doxygen/html/*.html
mike-m3e5d00c2010-05-07 00:42:33 +000093
94$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
95 $(Echo) Packaging doxygen documentation
96 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
97 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
Eric Christopher3bc3c6d2010-12-10 01:59:28 +000098 $(Verb) $(GZIPBIN) $(PROJ_OBJ_DIR)/doxygen.tar
mike-m3e5d00c2010-05-07 00:42:33 +000099 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
100
101userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
102
103$(LLVM_SRC_ROOT)/docs/userloc.html:
104 $(Echo) Making User LOC Table
105 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
106 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
107
108uninstall-local::
109 $(Echo) Uninstalling Documentation
110 $(Verb) $(RM) -rf $(DESTDIR)$(PROJ_docsdir)