2N/A#

2N/A# CDDL HEADER START

2N/A#

2N/A# The contents of this file are subject to the terms of the

2N/A# Common Development and Distribution License (the "License").

2N/A# You may not use this file except in compliance with the License.

2N/A#

2N/A# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE

2N/A# or http://www.opensolaris.org/os/licensing.

2N/A# See the License for the specific language governing permissions

2N/A# and limitations under the License.

2N/A#

2N/A# When distributing Covered Code, include this CDDL HEADER in each

2N/A# file and include the License file at usr/src/OPENSOLARIS.LICENSE.

2N/A# If applicable, add the following below this CDDL HEADER, with the

2N/A# fields enclosed by brackets "[]" replaced with your own identifying

2N/A# information: Portions Copyright [yyyy] [name of copyright owner]

2N/A#

2N/A# CDDL HEADER END

2N/A#

3040N/A# Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved.

2N/A#

2N/A

2N/A#

2N/A# Rules and Macros for generating an IPS package manifest and publishing an

2N/A# IPS package to a pkg depot.

2N/A#

2N/A# To use these rules, include ../make-rules/ips.mk in your Makefile

2N/A# and define an "install" target appropriate to building your component.

2N/A# Ex:

166N/A#

166N/A# install: $(BUILD_DIR)/build/$(MACH32)/.installed \

2N/A# $(BUILD_DIR)/build/$(MACH64)/.installed

2N/A#

59N/A# This set of rules makes the "publish" target the default target for make(1)

59N/A#

166N/A

59N/APKGDEPEND = /usr/bin/pkgdepend

59N/APKGFMT = /usr/bin/pkgfmt

2N/APKGMOGRIFY = /usr/bin/pkgmogrify

166N/APKGSEND = /usr/bin/pkgsend

166N/APKGLINT = /usr/bin/pkglint

166N/APKGMANGLE = $(WS_TOOLS)/userland-mangler

2N/A

2N/A# Package headers should all pretty much follow the same format

2N/AMETADATA_TEMPLATE = $(WS_TOP)/transforms/manifest-metadata-template

2N/ACOPYRIGHT_TEMPLATE = $(WS_TOP)/transforms/copyright-template

2N/A

166N/A# order is important

2N/AGENERATE_TRANSFORMS += $(WS_TOP)/transforms/generate-cleanup

2N/A

2N/APKGMOGRIFY_TRANSFORMS += $(WS_TOP)/transforms/libtool-drop

2N/A

166N/ACOMPARISON_TRANSFORMS += $(WS_TOP)/transforms/comparison-cleanup

2N/ACOMPARISON_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)

2N/A

58N/A# order is important

58N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/variant-cleanup

58N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/autopyc

58N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/defaults

58N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/actuators

58N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/devel

151N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/docs

151N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/locale

58N/APUBLISH_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)

58N/APUBLISH_TRANSFORMS += $(WS_TOP)/transforms/publish-cleanup

58N/A

58N/APKG_MACROS += MACH=$(MACH)

119N/APKG_MACROS += MACH32=$(MACH32)

58N/APKG_MACROS += MACH64=$(MACH64)

57N/APKG_MACROS += PUBLISHER=$(PUBLISHER)

57N/APKG_MACROS += PUBLISHER_LOCALIZABLE=$(PUBLISHER_LOCALIZABLE)

278N/APKG_MACROS += CONSOLIDATION=$(CONSOLIDATION)

278N/APKG_MACROS += BUILD_VERSION=$(BUILD_VERSION)

3N/APKG_MACROS += SOLARIS_VERSION=$(SOLARIS_VERSION)

206N/APKG_MACROS += OS_VERSION=$(OS_VERSION)

58N/APKG_MACROS += PKG_SOLARIS_VERSION=$(PKG_SOLARIS_VERSION)

278N/APKG_MACROS += HUMAN_VERSION=$(HUMAN_VERSION)

58N/APKG_MACROS += IPS_COMPONENT_VERSION=$(IPS_COMPONENT_VERSION)

58N/APKG_MACROS += COMPONENT_VERSION=$(COMPONENT_VERSION)

58N/APKG_MACROS += COMPONENT_PROJECT_URL=$(COMPONENT_PROJECT_URL)

151N/APKG_MACROS += COMPONENT_ARCHIVE_URL=$(COMPONENT_ARCHIVE_URL)

278N/APKG_MACROS += COMPONENT_HG_URL=$(COMPONENT_HG_URL)

62N/APKG_MACROS += COMPONENT_HG_REV=$(COMPONENT_HG_REV)

58N/A

58N/APKG_OPTIONS += $(PKG_MACROS:%=-D %)

2N/A

181N/AMANGLED_DIR = $(PROTO_DIR)/mangled

181N/A

2N/APKG_PROTO_DIRS += $(MANGLED_DIR) $(PROTO_DIR) $(@D) $(COMPONENT_DIR) $(COMPONENT_SRC)

62N/A

814N/AMANIFEST_BASE = $(BUILD_DIR)/manifest-$(MACH)

814N/A

814N/ACANONICAL_MANIFESTS = $(wildcard *.p5m)

814N/A

814N/A# Look for manifests which need to be duplicated for each version of python.

814N/Aifeq ($(findstring -PYVER,$(CANONICAL_MANIFESTS)),-PYVER)

814N/AUNVERSIONED_MANIFESTS = $(filter-out %-GENFRAG.p5m,$(filter-out %-PYVER.p5m,$(CANONICAL_MANIFESTS)))

814N/APY_MANIFESTS = $(filter %-PYVER.p5m,$(CANONICAL_MANIFESTS))

814N/APYV_MANIFESTS = $(foreach v,$(shell echo $(PYTHON_VERSIONS) | tr -d .),$(shell echo $(PY_MANIFESTS) | sed -e 's/-PYVER.p5m/-$(v).p5m/g'))

814N/APYNV_MANIFESTS = $(shell echo $(PY_MANIFESTS) | sed -e 's/-PYVER//')

2N/Aelse

716N/AUNVERSIONED_MANIFESTS = $(CANONICAL_MANIFESTS)

716N/Aendif

2077N/A

716N/A# Look for manifests which need to be duplicated for each version of perl.

716N/Aifeq ($(findstring -PERLVER,$(UNVERSIONED_MANIFESTS)),-PERLVER)

2N/ANOPERL_MANIFESTS = $(filter-out %-GENFRAG.p5m,$(filter-out %-PERLVER.p5m,$(UNVERSIONED_MANIFESTS)))

151N/APERL_MANIFESTS = $(filter %-PERLVER.p5m,$(UNVERSIONED_MANIFESTS))

59N/APERLV_MANIFESTS = $(foreach v,$(shell echo $(PERL_VERSIONS) | tr -d .),$(shell echo $(PERL_MANIFESTS) | sed -e 's/-PERLVER.p5m/-$(v).p5m/g'))

2N/APERLNV_MANIFESTS = $(shell echo $(PERL_MANIFESTS) | sed -e 's/-PERLVER//')

2N/Aelse

16N/ANOPERL_MANIFESTS = $(UNVERSIONED_MANIFESTS)

151N/Aendif

2N/A

2N/AVERSIONED_MANIFESTS = \

2N/A $(PYV_MANIFESTS) $(PYNV_MANIFESTS) \

2N/A $(PERLV_MANIFESTS) $(PERLNV_MANIFESTS) \

59N/A $(UNVERSIONED_MANIFESTS)

2N/A

16N/AGENERATED = $(MANIFEST_BASE)-generated

151N/ACOMBINED = $(MANIFEST_BASE)-combined

2N/AMANIFESTS = $(VERSIONED_MANIFESTS:%=$(MANIFEST_BASE)-%)

814N/A

1780N/A

814N/ADEPENDED=$(VERSIONED_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.depend)

2N/ARESOLVED=$(VERSIONED_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.depend.res)

2N/APUBLISHED=$(RESOLVED:%.depend.res=%.published)

2N/A

59N/ACOPYRIGHT_FILE ?= $(COMPONENT_NAME)-$(COMPONENT_VERSION).copyright

2N/AIPS_COMPONENT_VERSION ?= $(COMPONENT_VERSION)

16N/A

58N/A.DEFAULT: publish

2N/A

2N/A.SECONDARY:

59N/A

166N/A# allow publishing to be overridden, such as when

166N/A# a package is for one architecture only.

166N/APUBLISH_STAMP ?= $(BUILD_DIR)/.published-$(MACH)

3205N/A

3205N/Apublish: build install $(PUBLISH_STAMP)

166N/A

166N/Asample-manifest: $(GENERATED).p5m

166N/A

166N/A$(GENERATED).p5m: install

814N/A $(PKGSEND) generate $(PKG_HARDLINKS:%=--target %) $(PROTO_DIR) | \

1780N/A $(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 $(GENERATE_TRANSFORMS) | \

814N/A sed -e '/^$$/d' -e '/^#.*$$/d' | $(PKGFMT) | \

814N/A cat $(METADATA_TEMPLATE) - >$@

814N/A

814N/A# copy the canonical manifest(s) to the build tree

814N/A$(MANIFEST_BASE)-%.generate: %.p5m canonical-manifests

59N/A cat $(METADATA_TEMPLATE) $< >$@

59N/A

# The text of a transform that will emit a dependency conditional on the

# presence of a particular version of a runtime, which will then draw in the

# runtime-version-specific version of the package we're operating on. $(1) is

# the name of the runtime package, and $(2) is the version suffix.

mkgeneric = \

echo "<transform set name=pkg.fmri value=(?:pkg:/)?(.+)-\#\#\#@(.*)" \

"-> emit depend nodrop=true type=conditional" \

"predicate=$(1)-$(2) fmri=%<1>-$(2)@%<2>>" >> $@;

# Define and execute a macro that generates a rule to create a manifest for a

# python module specific to a particular version of the python runtime.

define python-manifest-rule

$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).p5m: %-PYVER.p5m

$(PKGMOGRIFY) -D PYVER=$(1) -D PYV=$(shell echo $(1) | tr -d .) $$< > $$@

endef

$(foreach ver,$(PYTHON_VERSIONS),$(eval $(call python-manifest-rule,$(ver))))

# A rule to create a helper transform package for python, that will insert the

# appropriate conditional dependencies into a python library's

# runtime-version-generic package to pull in the version-specific bits when the

# corresponding version of python is on the system.

$(WS_TOP)/transforms/mkgeneric-python: $(WS_TOP)/make-rules/shared-macros.mk

$(RM) $@

$(foreach ver,$(shell echo $(PYTHON_VERSIONS) | tr -d .), \

$(call mkgeneric,runtime/python,$(ver)))

# Build Python version-wrapping manifests from the generic version.

$(MANIFEST_BASE)-%.p5m: %-PYVER.p5m $(WS_TOP)/transforms/mkgeneric-python

$(PKGMOGRIFY) -D PYV=### $(WS_TOP)/transforms/mkgeneric-python \

$(WS_TOP)/transforms/mkgeneric $< > $@

if [ -f $*-GENFRAG.p5m ]; then cat $*-GENFRAG.p5m >> $@; fi

# A rule to create a helper transform package for perl, that will insert the

# appropriate conditional dependencies into a perl library's

# runtime-version-generic package to pull in the version-specific bits when the

# corresponding version of perl is on the system.

$(WS_TOP)/transforms/mkgeneric-perl: $(WS_TOP)/make-rules/shared-macros.mk

$(RM) $@

$(foreach ver,$(shell echo $(PERL_VERSIONS) | tr -d .), \

$(call mkgeneric,runtime/perl,$(ver)))

# Define and execute a macro that generates a rule to create a manifest for a

# perl module specific to a particular version of the perl runtime.

define perl-manifest-rule

$(MANIFEST_BASE)-%-$(shell echo $(1) | tr -d .).p5m: %-PERLVER.p5m

$(PKGMOGRIFY) -D PERLVER=$(1) -D PLV=$(shell echo $(1) | tr -d .) $< > $@

endef

$(foreach ver,$(PERL_VERSIONS),$(eval $(call perl-manifest-rule,$(ver))))

# Build Perl version-wrapping manifests from the generic version.

$(MANIFEST_BASE)-%.p5m: %-PERLVER.p5m

$(PKGMOGRIFY) -D PLV=### $(WS_TOP)/transforms/mkgeneric-perl \

$(WS_TOP)/transforms/mkgeneric $< > $@

if [ -f $*-GENFRAG.p5m ]; then cat $*-GENFRAG.p5m >> $@; fi

# mogrify non-parameterized manifests

$(MANIFEST_BASE)-%.mogrified: %.p5m $(BUILD_DIR)

$(PKGMOGRIFY) $(PKG_OPTIONS) $< \

$(PUBLISH_TRANSFORMS) | \

sed -e '/^$$/d' -e '/^#.*$$/d' | uniq >$@

# mogrify parameterized manifests

$(MANIFEST_BASE)-%.mogrified: $(MANIFEST_BASE)-%.p5m $(BUILD_DIR)

$(PKGMOGRIFY) $(PKG_OPTIONS) $< \

$(PUBLISH_TRANSFORMS) | \

sed -e '/^$$/d' -e '/^#.*$$/d' | uniq >$@

# mangle the file contents

$(BUILD_DIR) $(MANGLED_DIR):

$(MKDIR) $@

PKGMANGLE_OPTIONS = -D $(MANGLED_DIR) $(PKG_PROTO_DIRS:%=-d %)

$(MANIFEST_BASE)-%.mangled: $(MANIFEST_BASE)-%.mogrified $(MANGLED_DIR)

$(PKGMANGLE) $(PKGMANGLE_OPTIONS) -m $< >$@

# generate dependencies

PKGDEPEND_GENERATE_OPTIONS = -m $(PKG_PROTO_DIRS:%=-d %)

$(MANIFEST_BASE)-%.depend: $(MANIFEST_BASE)-%.mangled

$(PKGDEPEND) generate $(PKGDEPEND_GENERATE_OPTIONS) $< >$@

# resolve the dependencies all at once

$(BUILD_DIR)/.resolved-$(MACH): $(DEPENDED)

$(PKGDEPEND) resolve -m $(DEPENDED)

$(TOUCH) $@

# lint the manifests all at once

$(BUILD_DIR)/.linted-$(MACH): $(BUILD_DIR)/.resolved-$(MACH)

@echo "VALIDATING MANIFEST CONTENT: $(RESOLVED)"

$(ENV) PYTHONPATH=$(WS_TOOLS)/python PROTO_PATH="$(PKG_PROTO_DIRS)"\

$(PKGLINT) $(CANONICAL_REPO:%=-c $(WS_LINT_CACHE)) \

-f $(WS_TOOLS)/pkglintrc $(RESOLVED)

$(TOUCH) $@

# published

PKGSEND_PUBLISH_OPTIONS = -s $(PKG_REPO) publish --fmri-in-manifest

PKGSEND_PUBLISH_OPTIONS += $(PKG_PROTO_DIRS:%=-d %)

PKGSEND_PUBLISH_OPTIONS += -T \*.py

$(MANIFEST_BASE)-%.published: $(MANIFEST_BASE)-%.depend.res $(BUILD_DIR)/.linted-$(MACH)

$(PKGSEND) $(PKGSEND_PUBLISH_OPTIONS) $<

$(PKGFMT) <$< >$@

$(BUILD_DIR)/.published-$(MACH): $(PUBLISHED)

$(TOUCH) $@

print-package-names: canonical-manifests

@cat $(VERSIONED_MANIFESTS) $(WS_TOP)/transforms/print-pkgs | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \

sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u

print-package-paths: canonical-manifests

@cat $(VERSIONED_MANIFESTS) $(WS_TOP)/transforms/print-paths | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \

sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u

install-packages: publish

@if [ $(IS_GLOBAL_ZONE) = 0 -o x$(ROOT) != x ]; then \

cat $(VERSIONED_MANIFESTS) $(WS_TOP)/transforms/print-paths | \

$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \

sed -e '/^$$/d' -e '/^#.*$$/d' -e 's;/;;' | sort -u | \

(cd $(PROTO_DIR) ; pfexec /bin/cpio -dump $(ROOT)) ; \

else ; \

echo "unsafe to install package(s) automatically" ; \

fi

$(RESOLVED): install

canonical-manifests: $(CANONICAL_MANIFESTS) Makefile $(PATCHES)

ifeq ($(strip $(CANONICAL_MANIFESTS)),)

# If there were no canonical manifests in the workspace, nothing will

# be published and we should fail. A sample manifest can be generated

# with

# $ gmake sample-manifest

# Once created, it will need to be reviewed, edited, and added to the

# workspace.

$(error Missing canonical manifest(s))

endif

# This converts required paths to containing package names for be able to

# properly setup the build environment for a component.

required-pkgs.mk: Makefile

@echo "generating $@ from Makefile REQUIRED_* data"

@pkg search -H -l '<$(DEPENDS:%=% OR) /bin/true>' \

| sed -e 's/pkg:\/\(.*\)@.*/REQUIRED_PKGS += \1/g' >$@

pre-prep: required-pkgs.mk

CLEAN_PATHS += required-pkgs.mk