Packaging Best Practices - Additional Package Info

Skip to end of metadata
Go to start of metadata

> Producing and Maintaining Packages

Overview

The pkg(5) system supports a number of package attributes that provide additional information about a package. The following is a partial list of those attributes and how they are displayed by the Update Center tools.

Attributes

Attribute Description How displayed in the Update Tool GUI How displayed in the Software Update GUI
pkg.detailed_url One or more URLs to pages or sites with further information about the package.

Use a single URL if possible. If you need a list then make it space separated. You may use this attribute to include a URL for releases notes, documentation, etc.
Presented as a link in the component Overivew tab Presented as a link in the package summary table for an update.
info.maintainer A human readable string describing the entity providing the package. For an individual, this string is expected to be their name, or name and email. Not yet supported Not yet supported.
info.maintainer_url A URL associated with the entity providing the package.

You may use this attribute to reference the project producing the package.
Presented as a link in the component Overivew tab Not yet supported
info.upstream A human readable string describing the entity that creates the software. For an individual, this string is expected to be their name, or name and email. Not yet supported Not yet supported.
info.upstream_url A URL associated with the entity that creates the software delivered within the package.

You may use this attribute to reference the project producing the software that is in the package.
Presented as a link in the component Overivew tab Not yet supported
info.source_url A URL to the source code bundle, if appropriate, for the package. Not yet supported Not yet supported.
pkg.icon.24px A 24x24 pixel icon for the package which is supported using the makepkgs command. Presented as an image above the component Overview tab. Not yet supported.

Examples

For the pkg package shipped by Update Center you may have:

pkgsend add set name=pkg.detailed_url value='http://wiki.updatecenter.java.net/Wiki.jsp?page=UC2Documentation.ReleaseNotes.2.2'
pkgsend add set name=info.maintainer_url value=https://updatecenter2.dev.java.net/
pkgsend add set name=info.upstream_url value=http://opensolaris.org/os/project/pkg/

In this example pkg.detailed_url points to the release notes for the package. info.maintainer_url points to the project page for Update Center since that is the project producing the package. info.upstream_url points to the OpenSolaris pkg project page since that is the upstream project that develops the software contained in the package.

Alternatively, if you're using the makepkgs tool, you can set these attributes as follows:

...
    "attributes"    : {
                        "pkg.summary" : "pkg(5) Image Packaging System",
                        "description" : "pkg(5) Image Packaging System",
                        "pkg.description" : "The Image Packaging System, also known \
as pkg(5), is a network-centric packaging system. This is the core package of the pkg(5) \
system including the publication client, pkgsend(1), repository server, pkg.depotd(1m), \
and retrieval client, pkg(1) and other supporting tools. The Python-based pkg(5) system \
was originally developed in support of OpenSolaris, but early on in its development \
it was ported to a wide variety of operating systems to support installation and \
management of layered application installations. For more information, see \
http://ipshowto.org and http://OpenSolaris.org",
                        "info.classification" : ":System Tools",
                        "pkg.detailed_url" : "http://wiki.updatecenter.java.net/Wiki.jsp?page=UC2Documentation.ReleaseNotes.2.2",
                        "info.maintainer_url" : "http://wiki.updatecenter.java.net/",
                        "info.upstream_url" : "http://opensolaris.org/os/project/pkg/",
                        "pkg.icon.24px" : "pkg/lib/pkg-logo.png"
                      },
...
Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Oracle community and they might not be employed or in any way formally affiliated with Oracle. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Oracle nor any other party necessarily agrees with them.