1 ##===- docs/Makefile ---------------------------------------*- Makefile -*-===##
3 # The LLVM Compiler Infrastructure
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.
8 ##===----------------------------------------------------------------------===##
13 include $(LEVEL)/Makefile.common
15 HTML := $(wildcard $(PROJ_SRC_DIR)/*.html) \
16 $(wildcard $(PROJ_SRC_DIR)/*.css)
17 IMAGES := $(wildcard $(PROJ_SRC_DIR)/img/*.*)
18 DOXYFILES := doxygen.cfg.in doxygen.css doxygen.footer doxygen.header \
20 EXTRA_DIST := $(HTML) $(DOXYFILES) llvm.css CommandGuide img
22 .PHONY: install-html install-doxygen doxygen
24 ifeq ($(ENABLE_DOXYGEN),1)
25 install-local:: install-html install-doxygen
27 install-local:: install-html
30 install-html: $(PROJ_OBJ_DIR)/html.tar.gz
31 $(Echo) Installing HTML documentation
32 $(Verb) $(MKDIR) $(PROJ_docsdir)/html
33 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/img
34 $(Verb) $(DataInstall) $(HTML) $(PROJ_docsdir)/html
35 $(Verb) $(DataInstall) $(IMAGES) $(PROJ_docsdir)/html/img
36 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/html.tar.gz $(PROJ_docsdir)
38 $(PROJ_OBJ_DIR)/html.tar.gz: $(HTML)
39 $(Echo) Packaging HTML documentation
40 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/html.tar
41 $(Verb) cd $(PROJ_SRC_DIR) && \
42 $(TAR) cf $(PROJ_OBJ_DIR)/html.tar *.html
43 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/html.tar
45 install-doxygen: doxygen
46 $(Echo) Installing doxygen documentation
47 $(Echo) Installing doxygen documentation
48 $(Verb) $(MKDIR) $(PROJ_docsdir)/html/doxygen
49 $(Verb) $(DataInstall) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_docsdir)
50 $(Verb) cd $(PROJ_OBJ_DIR)/doxygen && \
51 $(FIND) . -type f -exec \
52 $(DataInstall) {} $(PROJ_docsdir)/html/doxygen \;
54 doxygen: $(PROJ_OBJ_DIR)/doxygen.tar.gz
56 $(PROJ_OBJ_DIR)/doxygen.tar.gz: $(DOXYFILES) $(PROJ_OBJ_DIR)/doxygen.cfg
57 $(Echo) Building doxygen documentation
58 $(Verb) if test -e $(PROJ_OBJ_DIR)/doxygen ; then \
59 $(RM) -rf $(PROJ_OBJ_DIR)/doxygen ; \
61 $(Verb) $(DOXYGEN) $(PROJ_OBJ_DIR)/doxygen.cfg
62 $(Echo) Packaging doxygen documentation
63 $(Verb) $(RM) -rf $@ $(PROJ_OBJ_DIR)/doxygen.tar
64 $(Verb) $(TAR) cf $(PROJ_OBJ_DIR)/doxygen.tar doxygen
65 $(Verb) $(GZIP) $(PROJ_OBJ_DIR)/doxygen.tar
66 $(Verb) $(CP) $(PROJ_OBJ_DIR)/doxygen.tar.gz $(PROJ_OBJ_DIR)/doxygen/html/
68 userloc: $(LLVM_SRC_ROOT)/docs/userloc.html
70 $(LLVM_SRC_ROOT)/docs/userloc.html:
71 $(Echo) Making User LOC Table
72 $(Verb) cd $(LLVM_SRC_ROOT) ; ./utils/userloc.pl -details -recurse \
73 -html lib include tools runtime utils examples autoconf test > docs/userloc.html