usrguide/Makefile

   1 ##############################################################################
   2 # Copyright (c) 2000-2016 Ericsson Telecom AB
   3 # All rights reserved. This program and the accompanying materials
   4 # are made available under the terms of the Eclipse Public License v1.0
   5 # which accompanies this distribution, and is available at
   6 # http://www.eclipse.org/legal/epl-v10.html
   7 #
   8 # Contributors:
   9 #
  10 #   >
  11 #   Baji, Laszlo
  12 #   Balasko, Jeno
  13 #   Forstner, Matyas
  14 #   Gecse, Roland
  15 #   Gillespie, Raymond
  16 #   Kremer, Peter
  17 #   Lovassy, Arpad
  18 #   Ormandi, Matyas
  19 #   Pandi, Krisztian
  20 #   Raduly, Csaba
  21 #   Szabados, Kristof
  22 #   Szabo, Janos Zoltan – initial implementation
  23 #   Szalai, Gabor
  24 #   Tatarka, Gabor
  25 #   Torpis, Zsolt
  26 #   Zalanyi, Balazs Andor
  27 #
  28 ##############################################################################
  29 # Makefile for the TITAN User Guide
  30
  31 TOP  := ..
  32 include ../Makefile.cfg
  33
  34 .SUFFIXES: .tex .labels .dvi .ps .pdf
  35
  36 DOC2PDF_JAR := ../../titan_playground/jar/doc2pdf.jar
  37 WARNING_TXT := warning.txt
  38 TITAN_DOCS := apiguide.doc userguide.doc installationguide.doc referenceguide.doc releasenotes.doc
  39 TITAN_PDFS := $(TITAN_DOCS:.doc=.pdf)
  40
  41 ifeq ($(GEN_PDF), yes)
  42
  43 # Install with error handling: Tries to create PDFs and copy the available documents to $(DOCDIR).
  44 # On success (PDF files are successfully created), the PDF files are copied to the $(DOCDIR) directory.
  45 # On failure (if doc2pdf.jar is not available or install_pdf exits with error, so PDFs are not created), the DOC files are copied to the $(DOCDIR) directory instead of the PDF files.
  46 install:
  47         { make test_doc2pdf_jar && make install_pdf; } || make install_error_handling
  48
  49 # Checks if $(DOC2PDF_JAR) is present, and exit with error if not.
  50 test_doc2pdf_jar:
  51         @{ test -f $(DOC2PDF_JAR) && echo "$(DOC2PDF_JAR) is present .. OK"; } || { echo "ERROR: $(DOC2PDF_JAR) is missing" && false; };
  52
  53 # Install PDFs normal case: PDFs are created and copied to the $(DOCDIR) directory.
  54 # PDF creation may fail if doc2pdf.jar fails, which can happen for example if the server, that converts from DOC to PDF, is not available. In this case the target exits with error.
  55 install_pdf: $(TITAN_PDFS)
  56 ifdef MINGW
  57 $(info Skipped ${CURDIR} for MinGW)
  58 else
  59         mkdir -p $(DOCDIR)
  60         cp $(TITAN_PDFS) $(DOCDIR)
  61 endif
  62
  63 # Copies DOC files to $(DOCDIR) instead of the PDF files, because PDF creation failed. Also a $(WARNING_TXT) is created
  64 install_error_handling:
  65         @echo "Error handling: DOC files are copied to $(DOCDIR) instead of PDF files"
  66 ifdef MINGW
  67 $(info Skipped ${CURDIR} for MinGW)
  68 else
  69         mkdir -p $(DOCDIR)
  70         cp $(TITAN_DOCS) $(DOCDIR)
  71         @echo "Creating $(WARNING_TXT)"
  72         @echo "DOC files are copied to $(DOCDIR) instead of PDF files." >$(WARNING_TXT)
  73         @echo "It is because $(DOC2PDF_JAR) is missing or failed, which can happen for example if the server, that converts from DOC to PDF, is not available." >>$(WARNING_TXT)
  74         cp $(WARNING_TXT) $(DOCDIR)
  75 endif
  76
  77 # Converts DOC to PDF
  78 # $@ : target name, for example: apiguide.pdf
  79 # $(basename $@) : target name without extension, for example: apiguide
  80 %.pdf : %.doc
  81         @java -jar $(DOC2PDF_JAR) $(basename $@).doc $@ || { echo "ERROR: doc2pdf.jar failed with $(basename $@).doc" && false; }
  82
  83 else
  84 # GEN_PDF == no
  85 install:
  86 endif
  87
  88 release:
  89         $(MAKE) install GEN_PDF=yes
  90
  91 all run:
  92
  93 clean:
  94
  95 distclean:clean
  96
  97 dep:
  98