doc/Makefile
author Edward Pilatowicz <edward.pilatowicz@oracle.com>
Mon, 16 Sep 2013 21:26:31 -0700
changeset 2945 24196b483cc6
parent 1923 8d42b7caa49d
permissions -rw-r--r--
17461187 packagemanager displays unexpected error message
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1923
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     1
#
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     2
# CDDL HEADER START
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     3
#
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     4
# The contents of this file are subject to the terms of the
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     5
# Common Development and Distribution License (the "License").
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     6
# You may not use this file except in compliance with the License.
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     7
#
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     8
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
     9
# or http://www.opensolaris.org/os/licensing.
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    10
# See the License for the specific language governing permissions
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    11
# and limitations under the License.
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    12
#
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    13
# When distributing Covered Code, include this CDDL HEADER in each
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    14
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    15
# If applicable, add the following below this CDDL HEADER, with the
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    16
# fields enclosed by brackets "[]" replaced with your own identifying
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    17
# information: Portions Copyright [yyyy] [name of copyright owner]
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    18
#
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    19
# CDDL HEADER END
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    20
#
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    21
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    22
# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    23
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    24
PWD:sh = pwd
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    25
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    26
RST2HTML_FLAGS = --rfc-references \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    27
                 --no-generator \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    28
                 --time \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    29
                 --stylesheet-path=$(CSS) \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    30
		 --link-stylesheet
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    31
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    32
RST2LATEX = rst2latex.py
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    33
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    34
RST2LATEX_FLAGS = --documentclass=ireport --documentoptions=12pt
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    35
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    36
draft := RST2LATEX_FLAGS = --documentclass=idraft --documentoptions=12pt
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    37
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    38
.MAKE.STATE:
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    39
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    40
M4_ARGS = -DCOMPLETE=1
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    41
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    42
WEB_INCLUDES = macros.rsi web.css
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    43
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    44
output/%.rsi: output %.rst
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    45
	gm4 $(M4_ARGS) $< > $@
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    46
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    47
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    48
TXT_FRAGMENTS = \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    49
	apt.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    50
	catalog.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    51
	deduction.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    52
	elf-jar-handling.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    53
	es-requirements.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    54
	file-metadata.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    55
	filter.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    56
	image.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    57
	multi-platform.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    58
	one-pager-main.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    59
	protocol-versioning.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    60
	publication.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    61
	razor.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    62
	rest.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    63
	rfes.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    64
	transaction-order.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    65
	usr-setuid-bins.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    66
	versions.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    67
	wos-conversion.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    68
	wos-filetype-stats.txt \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    69
	xml.txt
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    70
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    71
RST_FRAGMENTS = \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    72
	actions.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    73
	depot.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    74
	guide-basic-ops.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    75
	guide-implementation-depot.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    76
	guide-metadata-conventions.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    77
	guide-naming-conventions.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    78
	guide-pkg-states.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    79
	guide-publication-protocol.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    80
	guide-repository-format.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    81
	guide-retrieval-protocol.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    82
	guide-txn-states.rst \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    83
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    84
RST_JOINS = \
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    85
	guide-main.rst
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    86
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    87
CSS=pkg-guide-web.css
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    88
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    89
HTML_DIR = html-out
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    90
FILE_URL = file://$(PWD)/$(HTML_DIR)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    91
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    92
HTML_CSS = $(HTML_DIR)/$(CSS)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    93
HTML_FRAGMENTS = $(RST_FRAGMENTS:%.rst=$(HTML_DIR)/%.html)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    94
HTML_JOINS = $(RST_JOINS:%.rst=$(HTML_DIR)/%.html)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    95
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    96
.KEEP_STATE:
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    97
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    98
pdf: guide-main.pdf
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
    99
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   100
draft: pdf
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   101
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   102
html: $(HTML_DIR) .WAIT $(HTML_CSS) $(HTML_FRAGMENTS) $(HTML_JOINS)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   103
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   104
$(HTML_JOINS): $(HTML_FRAGMENTS)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   105
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   106
html-out:
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   107
	-mkdir $@
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   108
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   109
# If we are embedding stylesheets, then we may wish to have this rule also
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   110
# depend on $(CSS).
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   111
$(HTML_DIR)/%.html: %.rst macros.rst
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   112
	rst2html.py $(RST2HTML_FLAGS) $< > $@
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   113
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   114
$(HTML_DIR)/$(CSS): $(CSS)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   115
	cp $(CSS) $@
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   116
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   117
%.pdf: %.rst macros.rst $(RSI_INCLUDES)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   118
	$(RST2LATEX) $(RST2LATEX_FLAGS) $< > $(<:%.rst=%.tex)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   119
	pdflatex $(<:%.rst=%.tex)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   120
	pdflatex $(<:%.rst=%.tex)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   121
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   122
clean:
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   123
	rm -f $(HTML_FRAGMENTS) $(RSI_INCLUDES)
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   124
8d42b7caa49d 16081 begin a developer guide for pkg(5)
Stephen Hahn <stephen.hahn@oracle.com>
parents:
diff changeset
   125
clobber: clean