blob: 58175bd73286440e60364a40a02b7752b2672ed3 [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
Reid Spencer12cabda2007-03-04 00:45:50 +000016# Extract version number from the AC_INT line in configure.ac
Reid Spencer669ed452007-07-09 08:04:31 +000017# AC_INIT([[llvm]],[[2.1svn]],[llvmbugs@cs.uiuc.edu])
Reid Spencercf4c42c2007-07-05 10:00:19 +000018PACKAGE_VERSION = $(shell grep AC_INIT ../autoconf/configure.ac | sed -e 's/^[^0-9]*\([0-9_.a-zA-Z-]*\).*/\1/' )
Chris Lattner9e4692c2006-07-06 00:36:52 +000019
Tanya Lattnerb747fd22007-03-27 23:19:39 +000020$(PROJ_OBJ_DIR)/doxygen.cfg: doxygen.cfg.in
Reid Spencer12cabda2007-03-04 00:45:50 +000021 cat $< | sed \
22 -e 's/@abs_top_srcdir@/../g' \
23 -e 's/@DOT@/dot/g' \
Reid Spencercf4c42c2007-07-05 10:00:19 +000024 -e 's/@PACKAGE_VERSION@/$(PACKAGE_VERSION)/' \
Reid Spencer12cabda2007-03-04 00:45:50 +000025 -e 's/@abs_top_builddir@/../g' > $@
Chris Lattner9e4692c2006-07-06 00:36:52 +000026endif
27
Reid Spencerca5fc7b2004-11-29 04:47:35 +000028include $(LEVEL)/Makefile.common
29
Reid Spencerbdf6a392005-01-16 02:21:29 +000030HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
31 $(wildcard $(PROJ_SRC_DIR)/*.css)
32IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
Reid Spencer5a069f52005-01-11 06:26:27 +000033DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
34 doxygen.intro
Reid Spencerca5fc7b2004-11-29 04:47:35 +000035EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
36
37.PHONY: install-html install-doxygen doxygen
38
39ifeq ($(ENABLE_DOXYGEN),1)
40install-local:: install-html install-doxygen
41else
42install-local:: install-html
43endif
44
Reid Spencerbdf6a392005-01-16 02:21:29 +000045install-html: $(PROJ_OBJ_DIR)/html.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000046 $(Echo) Installing HTML documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000047 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
48 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
49 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
50 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
51 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000052
Reid Spencerbdf6a392005-01-16 02:21:29 +000053$(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
Reid Spencerca5fc7b2004-11-29 04:47:35 +000054 $(Echo) Packaging HTML documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000055 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
56 $(Verb) cd $(PROJ_SRC_DIR) && \
57 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
58 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
Reid Spencerca5fc7b2004-11-29 04:47:35 +000059
60install-doxygen: doxygen
61 $(Echo) Installing doxygen documentation
62 $(Echo) Installing doxygen documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000063 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
64 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
Reid Spencerbdf6a392005-01-16 02:21:29 +000065 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
Reid Spencerca5fc7b2004-11-29 04:47:35 +000066 $(FIND) . -type f -exec \
Reid Spencer29fbdd72005-02-24 21:28:08 +000067 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
Reid Spencerca5fc7b2004-11-29 04:47:35 +000068
Reid Spencer0b57a762007-03-27 06:06:15 +000069doxygen: regendoc $(PROJ_OBJ_DIR)/doxygen.tar.gz
Reid Spencerca5fc7b2004-11-29 04:47:35 +000070
Reid Spencer0b57a762007-03-27 06:06:15 +000071regendoc:
Reid Spencerca5fc7b2004-11-29 04:47:35 +000072 $(Echo) Building doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000073 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
74 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
Reid Spencer5a069f52005-01-11 06:26:27 +000075 fi
Reid Spencerbdf6a392005-01-16 02:21:29 +000076 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencer0b57a762007-03-27 06:06:15 +000077
78$(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
Reid Spencerca5fc7b2004-11-29 04:47:35 +000079 $(Echo) Packaging doxygen documentation
Reid Spencerbdf6a392005-01-16 02:21:29 +000080 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
81 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
82 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
Chris Lattner889bc472005-11-30 06:31:28 +000083 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
Reid Spencerca5fc7b2004-11-29 04:47:35 +000084
Reid Spencerd5de2c82005-05-16 18:29:13 +000085userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
86
87$(LLVM_SRC_ROOT)/docs/userloc.html:
Reid Spenceree6fcf22005-05-16 18:12:58 +000088 $(Echo) Making User LOC Table
89 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
Reid Spencerd5de2c82005-05-16 18:29:13 +000090 -html lib include tools runtime utils examples autoconf test > docs/userloc.html
Reid Spenceree6fcf22005-05-16 18:12:58 +000091