ips.mk revision 32
2058N/A#
2058N/A# CDDL HEADER START
2058N/A#
2058N/A# The contents of this file are subject to the terms of the
2058N/A# Common Development and Distribution License (the "License").
2058N/A# You may not use this file except in compliance with the License.
2058N/A#
2058N/A# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2058N/A# or http://www.opensolaris.org/os/licensing.
2058N/A# See the License for the specific language governing permissions
2058N/A# and limitations under the License.
2058N/A#
2058N/A# When distributing Covered Code, include this CDDL HEADER in each
2058N/A# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2058N/A# If applicable, add the following below this CDDL HEADER, with the
2058N/A# fields enclosed by brackets "[]" replaced with your own identifying
2058N/A# information: Portions Copyright [yyyy] [name of copyright owner]
2058N/A#
2058N/A# CDDL HEADER END
2058N/A#
3996N/A# Copyright (c) 2010, Oracle and/or it's affiliates. All rights reserved.
2058N/A#
2058N/A
2058N/A#
2058N/A# Rules and Macros for generating an IPS package manifest and publishing an
2320N/A# IPS package to a pkg depot.
2058N/A#
2058N/A# To use these rules, include ../make-rules/ips.mk in your Makefile
2058N/A# and define an "install" target appropriate to building your component.
2320N/A# Ex:
2058N/A#
2058N/A# install: $(COMPONENT_SRC)/build-$(MACH32)/.installed \
2058N/A# $(COMPONENT_SRC)/build-$(MACH64)/.installed
2058N/A#
3661N/A# This set of rules makes the "publish" target the default target for make(1)
3661N/A#
3996N/A
3996N/APKGDEPEND = /usr/bin/pkgdepend
3996N/APKGFMT = /usr/bin/pkgfmt
2058N/APKGMOGRIFY = /usr/bin/pkgmogrify
2058N/APKGSEND = /usr/bin/pkgsend
2058N/A
2058N/A# Package headers should all pretty much follow the same format
2058N/AMETADATA_TEMPLATE = $(WS_TOP)/transforms/manifest-metadata-template
2058N/ACOPYRIGHT_TEMPLATE = $(WS_TOP)/transforms/copyright-template
2058N/A
2058N/A# order is important
2058N/AGENERATE_TRANSFORMS += $(WS_TOP)/transforms/generate-cleanup
2058N/AGENERATE_TRANSFORMS += $(WS_TOP)/transforms/variant.arch
2058N/A
2058N/ACOMPARISON_TRANSFORMS += $(WS_TOP)/transforms/comparison-cleanup
2058N/ACOMPARISON_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)
2058N/A
# order is important
PUBLISH_TRANSFORMS += $(WS_TOP)/transforms/defaults
PUBLISH_TRANSFORMS += $(WS_TOP)/transforms/actuators
PUBLISH_TRANSFORMS += $(WS_TOP)/transforms/devel
PUBLISH_TRANSFORMS += $(WS_TOP)/transforms/docs
PUBLISH_TRANSFORMS += $(WS_TOP)/transforms/locale
PUBLISH_TRANSFORMS += $(PKGMOGRIFY_TRANSFORMS)
PUBLISH_TRANSFORMS += $(WS_TOP)/transforms/publish-cleanup
PKG_MACROS += MACH=$(MACH)
PKG_MACROS += ARCH=$(MACH)
PKG_MACROS += MACH32=$(MACH32)
PKG_MACROS += MACH64=$(MACH64)
PKG_MACROS += IPS_PKG_NAME=$(IPS_PKG_NAME)
PKG_MACROS += PUBLISHER=$(PUBLISHER)
PKG_MACROS += CONSOLIDATION=$(CONSOLIDATION)
PKG_MACROS += BUILD_VERSION=$(BUILD_VERSION)
PKG_MACROS += SOLARIS_VERSION=$(SOLARIS_VERSION)
PKG_MACROS += OS_VERSION=$(OS_VERSION)
PKG_MACROS += IPS_COMPONENT_VERSION=$(IPS_COMPONENT_VERSION)
PKG_MACROS += COMPONENT_PROJECT_URL=$(COMPONENT_PROJECT_URL)
PKG_MACROS += COMPONENT_ARCHIVE_URL=$(COMPONENT_ARCHIVE_URL)
PKG_OPTIONS += $(PKG_MACROS:%=-D %)
# multi-word macros get broken up, so we handle them "specially"
PKG_OPTIONS += -D COMPONENT_SUMMARY=$(COMPONENT_SUMMARY)
PKG_OPTIONS += -D COMPONENT_DESCRIPTION=$(COMPONENT_DESCRIPTION)
PKG_OPTIONS += -D COMPONENT_CLASSIFICATION=$(COMPONENT_CLASSIFICATION)
MANIFEST_BASE = $(COMPONENT_SRC)/manifest-$(MACH)
CANONICAL_MANIFESTS = $(wildcard *.p5m)
GENERATED = $(MANIFEST_BASE)-generated
COMBINED = $(MANIFEST_BASE)-combined
MANIFESTS = $(CANONICAL_MANIFESTS:%=$(MANIFEST_BASE)-%)
MOGRIFIED=$(CANONICAL_MANIFESTS:%.p5m=$(MANIFEST_BASE)-%.resolved)
PUBLISHED=$(MOGRIFIED:%.resolved=%.published)
COPYRIGHT_FILE = $(COMPONENT_NAME)-$(COMPONENT_VERSION).copyright
ifeq ($(IPS_PKG_NAME),)
IPS_PKG_NAME = $(COMPONENT_NAME)
endif
IPS_COMPONENT_VERSION = $(COMPONENT_VERSION)
.DEFAULT: publish
.SECONDARY: $(GENERATED).fdeps
publish: install $(COMPONENT_SRC)/.published
sample-manifest: $(GENERATED).p5m
#
# Rules for generating a manifest automatically. Generated manifests will
# contain the following:
# copyright - template copyright information
# metadata - mogrified template metadata
# actions - "normalized" actions for the paths to be installed.
# depends - automatically generated dependencies
#
# transform template metadata into slightly more package specific metadata.
$(GENERATED).metadata: $(METADATA_TEMPLATE) install
$(PKGMOGRIFY) -D IPS_PKG_NAME=$(IPS_PKG_NAME) $< | \
sed -e '/^$$/d' -e '/^#.*$$/d' | $(PKGFMT) >$@
# generate actions from the proto dir
$(GENERATED).generate: install
$(PKGSEND) generate $(PKG_HARDLINKS:%=--target %) $(PROTO_DIR) >$@
# convert actions to a "normalized" format
$(GENERATED).actions: $(GENERATED).generate
$(PKGMOGRIFY) $(PKG_OPTIONS) $< $(GENERATE_TRANSFORMS) | \
sed -e '/^$$/d' -e '/^#.*$$/d' | $(PKGFMT) >$@
# generate dependencies
$(MANIFEST_BASE)-%.fdeps: $(MANIFEST_BASE)-%.generate
$(PKGDEPEND) generate $(PKG_OPTIONS) $< $(PROTO_DIR) >$@
$(MANIFEST_BASE)-%.depend: $(MANIFEST_BASE)-%.fdeps
$(PKGDEPEND) resolve -o $< | sed -e '1d' >$@
# generate a complete manifest from the pieces
$(GENERATED).p5m: $(GENERATED).metadata $(GENERATED).actions \
$(GENERATED).depend
cat $(COPYRIGHT_TEMPLATE) $(GENERATED).metadata $(GENERATED).actions \
$(GENERATED).depend >$@
#
# Rules to generate a combined manifest from the canonical manifest(s) checked
# into the workspace.
#
# Combine the canonical manifest(s) for this component and "normalize" them
# for comparison.
$(COMBINED).p5m: canonical-manifests
cat $(CANONICAL_MANIFESTS) | $(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \
sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u | $(PKGFMT) >$@
$(MANIFEST_BASE)-%.compare: $(MANIFEST_BASE)-%.p5m
$(PKGMOGRIFY) $(PKG_OPTIONS) $(COMPARISON_TRANSFORMS) $< >$@
manifest-compare: $(COMBINED).compare $(GENERATED).compare
@echo "Manifest comparison"
@pkgdiff $(GENERATED).compare $(COMBINED).compare
# mogrify the canonical manifest(s)
#
$(MANIFEST_BASE)-%.resolved: %.p5m manifest-compare
$(PKGMOGRIFY) $(PKG_OPTIONS) $< $(PUBLISH_TRANSFORMS) >$@
$(MANIFEST_BASE)-%.published: $(MANIFEST_BASE)-%.resolved
$(PKGSEND) -s $(PKG_REPO) publish --fmri-in-manifest \
-d $(PROTO_DIR) -d . $<
$(TOUCH) $@
$(COMPONENT_SRC)/.published: manifest-compare $(PUBLISHED)
$(TOUCH) $@
print-package-names: canonical-manifests
@cat $(CANONICAL_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 $(CANONICAL_MANIFESTS) $(WS_TOP)/transforms/print-paths | \
$(PKGMOGRIFY) $(PKG_OPTIONS) /dev/fd/0 | \
sed -e '/^$$/d' -e '/^#.*$$/d' | sort -u
canonical-manifests: $(CANONICAL_MANIFESTS)
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' >$@
CLEAN_PATHS += required-pkgs.mk