blob: d7442d9d361666779b2c3daf284762468801278c [file] [log] [blame]
John Criswelld8846c12003-10-21 14:33:46 +00001##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
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.
7#
8##===----------------------------------------------------------------------===##
Chris Lattnerb9a827c2002-01-30 21:20:23 +00009
Reid Spencerca5fc7b2004-11-29 04:47:35 +000010LEVEL := ..
11DIRS := CommandGuide
12
Chris Lattner9e4692c2006-07-06 00:36:52 +000013ifdef BUILD_FOR_WEBSITE
14PROJ_OBJ_DIR = .
15DOXYGEN = doxygen
16
17doxygen.cfg: doxygen.cfg.in
18 cat $< | sed 's/@abs_top_srcdir@/../g' | sed 's/@DOT@/dot/g' | \
19 sed 's/@PACKAGE_VERSION@/CVS/g' | sed 's/@abs_top_builddir@/../g' > $@
20endif
21
Reid Spencerca5fc7b2004-11-29 04:47:35 +000022include $(LEVEL)/Makefile.common
23
Reid Spencerbdf6a392005-01-16 02:21:29 +000024HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
25 $(wildcard $(PROJ_SRC_DIR)/*.css)
26IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Reid Spencer5a069f52005-01-11 06:26:27 +000027DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
28 doxygen.intro
Reid Spencerca5fc7b2004-11-29 04:47:35 +000029EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
30
31.PHONY: install-html install-doxygen doxygen
32
33ifeq ($(ENABLE_DOXYGEN),1)
34install-local:: install-html install-doxygen
35else
36install-local:: install-html
37endif
38
Reid Spencerbdf6a392005-01-16 02:21:29 +000039install-html: $(PROJ_OBJ_DIR)/html.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000040 $(Echo) Installing HTML documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000041 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
42 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
43 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
44 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
45 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000046
Reid Spencerbdf6a392005-01-16 02:21:29 +000047$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000048 $(Echo) Packaging HTML documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000049 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
50 $(Verb) cd $(PROJ_SRC_DIR) && \
51 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
52 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
Reid Spencerca5fc7b2004-11-29 04:47:35 +000053
54install-doxygen: doxygen
55 $(Echo) Installing doxygen documentation
56 $(Echo) Installing doxygen documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000057 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
58 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
Reid Spencerbdf6a392005-01-16 02:21:29 +000059 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
Reid Spencerca5fc7b2004-11-29 04:47:35 +000060 $(FIND) . -type f -exec \
Reid Spencer29fbdd72005-02-24 21:28:08 +000061 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
Reid Spencerca5fc7b2004-11-29 04:47:35 +000062
Reid Spencerbdf6a392005-01-16 02:21:29 +000063doxygen: $(PROJ_OBJ_DIR)/doxygen.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000064
Reid Spencerbdf6a392005-01-16 02:21:29 +000065$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +000066 $(Echo) Building doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000067 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
68 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
Reid Spencer5a069f52005-01-11 06:26:27 +000069 fi
Reid Spencerbdf6a392005-01-16 02:21:29 +000070 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +000071 $(Echo) Packaging doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000072 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
73 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
74 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
Chris Lattner889bc472005-11-30 06:31:28 +000075 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
Reid Spencerca5fc7b2004-11-29 04:47:35 +000076
Reid Spencerd5de2c82005-05-16 18:29:13 +000077userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
78
79$(LLVM_SRC_ROOT)/docs/userloc.html:
Reid Spenceree6fcf22005-05-16 18:12:58 +000080 $(Echo) Making User LOC Table
81 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
Reid Spencerd5de2c82005-05-16 18:29:13 +000082 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
Reid Spenceree6fcf22005-05-16 18:12:58 +000083