config/gen/makefiles/docs.in

   1 # Copyright (C) 2001-2006, The Perl Foundation.
   2 # $Id$
   3
   4 # Setup of some commands
   5 PERL   = @perl@
   6 RM_F   = @rm_f@
   7 MKPATH = @mkpath@
   8 CHMOD  = @chmod@
   9 PERLDOC = @perldoc@
  10
  11 # long list of .pod files
  12 POD = @pod@
  13
  14 #
  15 # Targets
  16 #
  17
  18 # The default target
  19 all: doc-prep packfile-c.pod $(POD)
  20
  21 # This is a listing of all targets, that are meant to be called by users
  22 # Most of them are proxied in the root makefile parrot/Makefile
  23 help :
  24         @echo ""
  25         @echo "Following targets are available to the user:"
  26         @echo ""
  27         @echo "  all:               Generate documentation from .pod files or from the sources."
  28         @echo "                     This is the default target."
  29         @echo "  clean:             Remove the generated documentation."
  30         @echo "  html:              Generate HTML documentation."
  31         @echo "  html-clean:        Remove the generated HTML documentation."
  32         @echo ""
  33
  34 doc-prep:
  35         $(MKPATH) ops
  36
  37 packfile-c.pod: ../src/packfile.c
  38 #CONDITIONED_LINE(new_perldoc): perldoc -ud packfile-c.pod ../src/packfile.c
  39 #INVERSE_CONDITIONED_LINE(new_perldoc): perldoc -u ../src/packfile.c > packfile-c.pod
  40
  41 clean:
  42         $(RM_F) packfile-c.pod $(POD)
  43
  44 html:
  45         $(PERL) -I../lib ../tools/docs/write_docs.pl --silent
  46
  47 html-clean:
  48         $(PERL) -I../lib -MParrot::Distribution -e "Parrot::Distribution->new()->delete_html_docs()"
  49