blob: a66d5ae4e8db90907109028c2e23232fe486957b [file] [log] [blame]
John Criswelld8846c12003-10-21 14:33:46 +00001##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
2#
3# The LLVM Compiler Infrastructure
4#
Chris Lattner57360d12007-12-29 20:11:13 +00005# This file is distributed under the University of Illinois Open Source
6# License. See LICENSE.TXT for details.
John Criswelld8846c12003-10-21 14:33:46 +00007#
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
Tanya Lattnerb747fd22007-03-27 23:19:39 +000017$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
Reid Spencer12cabda2007-03-04 00:45:50 +000018 cat $< | sed \
19 -e 's/@abs_top_srcdir@/../g' \
20 -e 's/@DOT@/dot/g' \
Chris Lattner4d44d7a2008-01-27 23:43:26 +000021 -e 's/@PACKAGE_VERSION@/mainline/' \
Reid Spencer12cabda2007-03-04 00:45:50 +000022 -e 's/@abs_top_builddir@/../g' > $@
Chris Lattner9e4692c2006-07-06 00:36:52 +000023endif
24
Reid Spencerca5fc7b2004-11-29 04:47:35 +000025include $(LEVEL)/Makefile.common
26
Reid Spencerbdf6a392005-01-16 02:21:29 +000027HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
28 $(wildcard $(PROJ_SRC_DIR)/*.css)
29IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Reid Spencer5a069f52005-01-11 06:26:27 +000030DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
31 doxygen.intro
Reid Spencerca5fc7b2004-11-29 04:47:35 +000032EXTRA_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
Reid Spencerbdf6a392005-01-16 02:21:29 +000042install-html: $(PROJ_OBJ_DIR)/html.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000043 $(Echo) Installing HTML documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000044 $(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)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000049
Reid Spencerbdf6a392005-01-16 02:21:29 +000050$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000051 $(Echo) Packaging HTML documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000052 $(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
Reid Spencerca5fc7b2004-11-29 04:47:35 +000056
57install-doxygen: doxygen
58 $(Echo) Installing doxygen documentation
59 $(Echo) Installing doxygen documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000060 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
61 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
Reid Spencerbdf6a392005-01-16 02:21:29 +000062 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
Reid Spencerca5fc7b2004-11-29 04:47:35 +000063 $(FIND) . -type f -exec \
Reid Spencer29fbdd72005-02-24 21:28:08 +000064 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
Reid Spencerca5fc7b2004-11-29 04:47:35 +000065
Reid Spencer0b57a762007-03-27 06:06:15 +000066doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000067
Reid Spencer0b57a762007-03-27 06:06:15 +000068regendoc:
Reid Spencerca5fc7b2004-11-29 04:47:35 +000069 $(Echo) Building doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000070 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
71 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
Reid Spencer5a069f52005-01-11 06:26:27 +000072 fi
Reid Spencerbdf6a392005-01-16 02:21:29 +000073 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencer0b57a762007-03-27 06:06:15 +000074
75$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +000076 $(Echo) Packaging doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000077 $(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
Chris Lattner889bc472005-11-30 06:31:28 +000080 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
Reid Spencerca5fc7b2004-11-29 04:47:35 +000081
Reid Spencerd5de2c82005-05-16 18:29:13 +000082userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
83
84$(LLVM_SRC_ROOT)/docs/userloc.html:
Reid Spenceree6fcf22005-05-16 18:12:58 +000085 $(Echo) Making User LOC Table
86 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
Reid Spencerd5de2c82005-05-16 18:29:13 +000087 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
Reid Spenceree6fcf22005-05-16 18:12:58 +000088