docs/CommandGuide/Makefile

   1 ##===- docs/CommandGuide/Makefile --------------------------*- Makefile -*-===##
   2 #
   3 #                     The LLVM Compiler Infrastructure
   4 #
   5 # This file is distributed under the University of Illinois Open Source
   6 # License. See LICENSE.TXT for details.
   7 #
   8 ##===----------------------------------------------------------------------===##
   9
  10 ifdef 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.
  16 SRC_DOC_DIR=
  17 DST_HTML_DIR=html/
  18 DST_MAN_DIR=man/man1/
  19 DST_PS_DIR=ps/
  20
  21 # If we are in BUILD_FOR_WEBSITE mode, default to the all target.
  22 all:: html man ps
  23
  24 clean:
  25         rm -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
  26 else
  27
  28 # Otherwise, if not in BUILD_FOR_WEBSITE mode, use the project info.
  29 LEVEL := ../..
  30 include $(LEVEL)/Makefile.common
  31
  32 SRC_DOC_DIR=$(PROJ_SRC_DIR)/
  33 DST_HTML_DIR=$(PROJ_OBJ_DIR)/
  34 DST_MAN_DIR=$(PROJ_OBJ_DIR)/
  35 DST_PS_DIR=$(PROJ_OBJ_DIR)/
  36
  37 endif
  38
  39
  40 POD  := $(wildcard $(SRC_DOC_DIR)*.pod)
  41 HTML := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_HTML_DIR)%.html, $(POD))
  42 MAN  := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_MAN_DIR)%.1, $(POD))
  43 PS   := $(patsubst $(SRC_DOC_DIR)%.pod, $(DST_PS_DIR)%.ps, $(POD))
  44
  45 .SUFFIXES:
  46 .SUFFIXES: .html .pod .1 .ps
  47
  48 $(DST_HTML_DIR)%.html: %.pod $(DST_HTML_DIR)/.dir
  49         pod2html --css=manpage.css --htmlroot=. \
  50           --podpath=. --noindex --infile=$< --outfile=$@ --title=$*
  51
  52 $(DST_MAN_DIR)%.1: %.pod $(DST_MAN_DIR)/.dir
  53         pod2man --release=CVS --center="LLVM Command Guide" $< $@
  54
  55 $(DST_PS_DIR)%.ps: $(DST_MAN_DIR)%.1 $(DST_PS_DIR)/.dir
  56         groff -Tps -man $< > $@
  57
  58
  59 html: $(HTML)
  60 man: $(MAN)
  61 ps: $(PS)
  62
  63 EXTRA_DIST := $(POD) index.html
  64
  65 clean-local::
  66         $(Verb) $(RM) -f pod2htm*.*~~ $(HTML) $(MAN) $(PS)
  67
  68 HTML_DIR := $(PROJ_docsdir)/html/CommandGuide
  69 MAN_DIR  := $(PROJ_mandir)/man1
  70 PS_DIR   := $(PROJ_docsdir)/ps
  71
  72 install-local:: $(HTML) $(MAN) $(PS)
  73         $(Echo) Installing HTML CommandGuide Documentation
  74         $(Verb) $(MKDIR) $(HTML_DIR)
  75         $(Verb) $(DataInstall) $(HTML) $(HTML_DIR)
  76         $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/index.html $(HTML_DIR)
  77         $(Verb) $(DataInstall) $(PROJ_SRC_DIR)/manpage.css $(HTML_DIR)
  78         $(Echo) Installing MAN CommandGuide Documentation
  79         $(Verb) $(MKDIR) $(MAN_DIR)
  80         $(Verb) $(DataInstall) $(MAN) $(MAN_DIR)
  81         $(Echo) Installing PS CommandGuide Documentation
  82         $(Verb) $(MKDIR) $(PS_DIR)
  83         $(Verb) $(DataInstall) $(PS) $(PS_DIR)
  84
  85 uninstall-local::
  86         $(Echo) Uninstalling Documentation
  87         $(Verb) $(RM) -rf $(LLVM_DOCSDIR)
  88
  89 printvars::
  90         $(Echo) "POD            : " '$(POD)'
  91         $(Echo) "HTML           : " '$(HTML)'