usr/src/doc/Makefile.doc
author Stephen Talley <stephen.talley@oracle.com>
Thu, 16 Jun 2011 17:24:56 -0400
changeset 732 8bcc11c4f6e6
parent 587 7093024d532b
child 760 5220578b3b77
permissions -rw-r--r--
18564 sysid module needs rebranding
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     1
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     2
# CDDL HEADER START
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     3
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     4
# The contents of this file are subject to the terms of the
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     5
# Common Development and Distribution License (the "License").
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     6
# You may not use this file except in compliance with the License.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     7
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     8
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
     9
# or http://www.opensolaris.org/os/licensing.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    10
# See the License for the specific language governing permissions
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    11
# and limitations under the License.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    12
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    13
# When distributing Covered Code, include this CDDL HEADER in each
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    14
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    15
# If applicable, add the following below this CDDL HEADER, with the
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    16
# fields enclosed by brackets "[]" replaced with your own identifying
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    17
# information: Portions Copyright [yyyy] [name of copyright owner]
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    18
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    19
# CDDL HEADER END
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    20
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    21
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    22
#
732
8bcc11c4f6e6 18564 sysid module needs rebranding
Stephen Talley <stephen.talley@oracle.com>
parents: 587
diff changeset
    23
# Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved.
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    24
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    25
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    26
include $(SRC)/Makefile.env
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    27
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    28
# The location of the DocBook XSL stylesheets to use.  Most systems
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    29
# should provide a catalog which automatically maps from the
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    30
# DOCBOOK_XSL URL to a local path.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    31
#
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    32
# STYLESHEET would ideally be set to profile-docbook.xsl, but the
732
8bcc11c4f6e6 18564 sysid module needs rebranding
Stephen Talley <stephen.talley@oracle.com>
parents: 587
diff changeset
    33
# stylesheets shipped with Solaris are old and broken.  The effect
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    34
# is that the STATUS variable, described below, doesn't work.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    35
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    36
DOCBOOK_XSL=	http://docbook.sourceforge.net/release/xsl/current
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    37
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    38
STYLESHEET=	docbook.xsl
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    39
FO_XSL=		$(DOCBOOK_XSL)/fo/$(STYLESHEET)
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    40
HTML_XSL=	$(DOCBOOK_XSL)/html/$(STYLESHEET)
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    41
MAN_XSL=	$(DOCBOOK_XSL)/manpages/$(STYLESHEET)
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    42
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    43
# The sections of the documentation that make comments intended for an
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    44
# internal audience are given a status of "private".  Setting STATUS to
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    45
# something other than "private" will cause those sections to be
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    46
# eliminated from the generated output.  Currently broken (see
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    47
# STYLESHEET comment, above.)
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    48
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    49
STATUS=	private
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    50
DBOPTS=	\
587
7093024d532b 17210 Begin a developer guide
David Powell <david.e.powell@oracle.com>
parents: 585
diff changeset
    51
	--stringparam funcsynopsis.style "ansi" \
585
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    52
	--stringparam man.authors.section.enabled 0 \
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    53
	--stringparam section.autolabel 1 \
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    54
	--stringparam section.label.includes.component.label 1 \
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    55
	--stringparam segmentedlist.as.table 1 \
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    56
	--stringparam profile.status "$(STATUS)"
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    57
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    58
# We assume xsltproc, xmllint, and Apache fop are all in the user's
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    59
# path.
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    60
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    61
XSLTPROC=	xsltproc --xinclude --nonet $(DBOPTS)
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    62
XMLLINT=	xmllint --xinclude --postvalid --noout
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    63
FOP=		fop
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    64
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    65
# Commands
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    66
21a47246efe3 14967 rad needs a man page
David Powell <david.e.powell@oracle.com>
parents:
diff changeset
    67
XSLT.man = $(XSLTPROC) $(MAN_XSL) $<