16726438 manifest-metadata-template needs work
authorJohn Beck <John.Beck@Oracle.COM>
Fri, 12 Jul 2013 09:55:54 -0700
changeset 1393 300d3de848bb
parent 1392 812d4bf54f42
child 1394 5f86498eee95
16726438 manifest-metadata-template needs work 17088960 document manually generated pkg(5) actions
doc/packaging.txt
transforms/manifest-metadata-template
--- a/doc/packaging.txt	Thu Jul 11 17:18:47 2013 -0700
+++ b/doc/packaging.txt	Fri Jul 12 09:55:54 2013 -0700
@@ -58,7 +58,28 @@
     Actions for editable files must include an appropriate 'preserve' attribute:
         file path=etc/gnu/a2ps.cfg preserve=true mode=0644
 
-    license actions should be placed in the canonical manifest.
+    license actions should be placed in the canonical manifest, as should a
+    handful of other special actions noted in the "Manually generated actions"
+    section just below.
+
+Manually generated actions
+    * com.oracle.info.description is a terse description of what utilities,
+      libraries and/or services the package provides.  This should be short,
+      specific, concise text, identifying the technology covered by the
+      associated license(s).  It should fit naturally in the sentence "This
+      package may contain XXX."  For example, "XXX" might be "the tar command"
+      or "bzip2 compression software."  When appropriate, this may begin with
+      "portions of" or another, more specific qualifying clause.
+    * com.oracle.info.tpno is the Oracle 3rd party license number.
+    * info.classification is "org.opensolaris.category.2008:FOO" where FOO
+      varies according to the sorts of utilities, libraries and/or services
+      that the package provides.  Existing packages contain most useful
+      values; check them out to find the closest match.  For a complete
+      list of allowed values, refer to the Solaris system file
+      /usr/share/lib/pkg/opensolaris.org.sections .
+    * org.opensolaris.arc-caseid is typically "PSARC/YYYY/###" and multiple
+      different values are allowed.
+    * pkg.summary is a short synopsis of what the package provides.
 
 Mogrified Manifest
     The canonical manifest is combined with a set of the transforms
--- a/transforms/manifest-metadata-template	Thu Jul 11 17:18:47 2013 -0700
+++ b/transforms/manifest-metadata-template	Fri Jul 12 09:55:54 2013 -0700
@@ -21,11 +21,16 @@
 # Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
 #
 
-set name=pkg.fmri value=pkg:/$(IPS_PKG_NAME)@$(IPS_COMPONENT_VERSION),$(BUILD_VERSION)
+set name=pkg.fmri \
+    value=pkg:/$(IPS_PKG_NAME)@$(IPS_COMPONENT_VERSION),$(BUILD_VERSION)
 set name=pkg.summary value="XXX Summary XXX"
-set name=info.classification value="org.opensolaris.category.2008:XXX Classification XXX"
+set name=com.oracle.info.description value="XXX Description XXX"
+set name=com.oracle.info.tpno value=XXXXX
+set name=info.classification \
+    value="org.opensolaris.category.2008:XXX Classification XXX"
+set name=info.source-url value=$(COMPONENT_ARCHIVE_URL)
 set name=info.upstream-url value=$(COMPONENT_PROJECT_URL)
-set name=info.source-url value=$(COMPONENT_ARCHIVE_URL)
+set name=org.opensolaris.arc-caseid value=PSARC/YYYY/XXX
 set name=org.opensolaris.consolidation value=$(CONSOLIDATION)
 
 license $(COPYRIGHT_FILE) license='$(COPYRIGHTS)'