blob: 3b65183107263a6eba58aad42d5680996eb82234 [file] [log] [blame]
Reid Spencer52d7a752004-11-29 03:45:02 +00001##===- docs/CommandGuide/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.
Reid Spencer52d7a752004-11-29 03:45:02 +00007#
8##===----------------------------------------------------------------------===##
Brian Gaekee993d202004-05-14 19:50:33 +00009
Reid Spencer63184562004-12-08 04:43:40 +000010ifdef BUILD_FOR_WEBSITE
11# This special case is for keeping the CommandGuide on the LLVM web site
12# up to date automatically as the documents are checked in. It must build
13# the POD files to HTML only and keep them in the src directories. It must also
14# build in an unconfigured tree, hence the ifdef. To use this, run
15# make -s BUILD_FOR_WEBSITE=1 inside the cvs commit script.
Chris Lattner18232a52008-02-12 06:07:47 +000016SRC_DOC_DIR=
17DST_HTML_DIR=html/
18DST_MAN_DIR=man/man1/
19DST_PS_DIR=ps/
Reid Spencer63184562004-12-08 04:43:40 +000020
Chris Lattner18232a52008-02-12 06:07:47 +000021# If we are in BUILD_FOR_WEBSITE mode, default to the all target.
22all:: html man ps
Reid Spencere47fd7d2004-12-08 19:01:01 +000023
24clean:
25 rm -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
Tanya Lattner301d5b42008-06-09 07:14:31 +000026
27# To create other directories, as needed, and timestamp their creation
28%/.dir:
29 -mkdir $* > /dev/null
30 date > $@
31
Chris Lattner18232a52008-02-12 06:07:47 +000032else
Reid Spencer63184562004-12-08 04:43:40 +000033
Chris Lattner18232a52008-02-12 06:07:47 +000034# Otherwise, if not in BUILD_FOR_WEBSITE mode, use the project info.
Reid Spencer52d7a752004-11-29 03:45:02 +000035LEVEL := ../..
Reid Spencer52d7a752004-11-29 03:45:02 +000036include $(LEVEL)/Makefile.common
37
Chris Lattner18232a52008-02-12 06:07:47 +000038SRC_DOC_DIR=$(PROJ_SRC_DIR)/
39DST_HTML_DIR=$(PROJ_OBJ_DIR)/
40DST_MAN_DIR=$(PROJ_OBJ_DIR)/
41DST_PS_DIR=$(PROJ_OBJ_DIR)/
Reid Spencer52d7a752004-11-29 03:45:02 +000042
Chris Lattner18232a52008-02-12 06:07:47 +000043endif
Reid Spencer52d7a752004-11-29 03:45:02 +000044
Chris Lattner18232a52008-02-12 06:07:47 +000045
46POD := $(wildcard $(SRC_DOC_DIR)*.pod)
47HTML := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_HTML_DIR)%.html, $(POD))
48MAN := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD))
49PS := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD))
Reid Spencer52d7a752004-11-29 03:45:02 +000050
Douglas Gregorcb3e3d32009-08-23 05:24:49 +000051# The set of man pages we will not install
52NO_INSTALL_MANS = $(DST_MAN_DIR)FileCheck.1
53
54# The set of man pages that we will install
55INSTALL_MANS = $(filter-out $(NO_INSTALL_MANS), $(MAN))
56
Brian Gaekee993d202004-05-14 19:50:33 +000057.SUFFIXES:
58.SUFFIXES: .html .pod .1 .ps
59
Chris Lattner18232a52008-02-12 06:07:47 +000060$(DST_HTML_DIR)%.html: %.pod $(DST_HTML_DIR)/.dir
61 pod2html --css=manpage.css --htmlroot=. \
62 --podpath=. --noindex --infile=$< --outfile=$@ --title=$*
63
64$(DST_MAN_DIR)%.1: %.pod $(DST_MAN_DIR)/.dir
65 pod2man --release=CVS --center="LLVM Command Guide" $< $@
66
67$(DST_PS_DIR)%.ps: $(DST_MAN_DIR)%.1 $(DST_PS_DIR)/.dir
68 groff -Tps -man $< > $@
69
Reid Spencer52d7a752004-11-29 03:45:02 +000070
Chris Lattnerdbcd4f52004-12-09 21:06:32 +000071html: $(HTML)
Chris Lattner18232a52008-02-12 06:07:47 +000072man: $(MAN)
73ps: $(PS)
Chris Lattnerdbcd4f52004-12-09 21:06:32 +000074
Chris Lattner18232a52008-02-12 06:07:47 +000075EXTRA_DIST := $(POD) index.html
Brian Gaekee993d202004-05-14 19:50:33 +000076
Reid Spencer52d7a752004-11-29 03:45:02 +000077clean-local::
78 $(Verb) $(RM) -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
Brian Gaekee993d202004-05-14 19:50:33 +000079
Reid Spencerbdf6a392005-01-16 02:21:29 +000080HTML_DIR := $(PROJ_docsdir)/html/CommandGuide
81MAN_DIR := $(PROJ_mandir)/man1
82PS_DIR := $(PROJ_docsdir)/ps
Reid Spencer3c54b6c2004-11-29 04:34:05 +000083
Douglas Gregorcb3e3d32009-08-23 05:24:49 +000084install-local:: $(HTML) $(INSTALL_MANS) $(PS)
Reid Spencer52d7a752004-11-29 03:45:02 +000085 $(Echo) Installing HTML CommandGuide Documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000086 $(Verb) $(MKDIR) $(HTML_DIR)
87 $(Verb) $(DataInstall) $(HTML) $(HTML_DIR)
88 $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/index.html $(HTML_DIR)
Reid Spencer837300a2005-02-24 21:41:26 +000089 $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/manpage.css $(HTML_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000090 $(Echo) Installing MAN CommandGuide Documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000091 $(Verb) $(MKDIR) $(MAN_DIR)
Douglas Gregorcb3e3d32009-08-23 05:24:49 +000092 $(Verb) $(DataInstall) $(INSTALL_MANS) $(MAN_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000093 $(Echo) Installing PS CommandGuide Documentation
Reid Spencer29fbdd72005-02-24 21:28:08 +000094 $(Verb) $(MKDIR) $(PS_DIR)
95 $(Verb) $(DataInstall) $(PS) $(PS_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +000096
97uninstall-local::
Erick Tryzelaar4f678c32008-03-30 20:32:18 +000098 $(Echo) Uninstalling CommandGuide Documentation
99 $(Verb) $(RM) -rf $(HTML_DIR) $(MAN_DIR) $(PS_DIR)
Reid Spencer52d7a752004-11-29 03:45:02 +0000100
101printvars::
102 $(Echo) "POD : " '$(POD)'
103 $(Echo) "HTML : " '$(HTML)'