METADATA

For all open source components to be included in the SFW consolidation, a METADATA file with relevant information about the component should be included in the package's top directory (where the package specific Makefile.sfw lives). This file contains a set of common data in a common format and is largely static. Updates to this file are likely to be prompted by bug fixing or component upgrade, but little else is expected to cause any updates.

NOTE: As of 2009-05-07, components integrating into the SFW gate must have a METADATA file and this file must contain all of the fields described below. The SFW build now validates the file prior to building each component and will fail if it doesn't exist or contains data that is not properly formatted.

Example:

NAME:             cups
VERSION:          1.3.9
DESCRIPTION:      Common Unix Print System
LICENSE:          CUPS, Aladdin, Unicode
PACKAGE:          SUNWcupsr SUNWcupsu
PROJECT_URL:      http://www.cups.org/
SOURCE_DOWNLOAD:  http://ftp.easysw.com/pub/cups/1.3.9/cups-1.3.9-source.tar.bz2
SUPPORT:          C
BUGTRAQ:          solaris/print/cups
OSR:              8430
COMMENTS:
    Any additional information that you want to supply goes down here

A complete description of the fields follows:

Field	Description
NAME	The "short" name that the open source project is known by, usually the prefix used in naming the source archive.
VERSION	The full version string ofthe version of the open source project.
DESCRIPTION	A one line summary of what the open source project supplied.
LICENSE	A comma separated list of license names that apply to this software. (see @licenses in $(SRC)/tools/metainfo.pl for a list of more common abreviations.
PACKAGE	A whitespace separated list of SVR4 package names containing the software, when built.
PROJECT_URL	The URL to the open source project page.
SOURCE_DOWNLOAD	A URL that can be used to download the source. This URL must always end with /{name-of-source-archive-file}. If you can't locate a URL in that format, please use ftp://tarballs.opensolaris.org/pub/{name-of-source-archive-file} and place the actual source archive download URL (from the project page) in the comments section of this file on a line by itself using "download={url}
SUPPORT	One of C: Support will only be provided through community update. B: Support will primarily provided through community update, but severe issues may be addressed A: Support may be provided through community update, but will be as expected for all software written in-house.
BUGTRAQ	A string in the form {product}/{category}/{subcategory}
OSR	The OpenSource Review number assigned by Sun legal.
COMMENTS	Start of comments section of the file. The rest of this line should be blank and the rest of the file is considered to be a comment block.

Values for all keys except for the COMMENTS: section should consist of one line only to allow for easy parsing of metadata.

The COMMENTS section must come last in the METADATA file

METADATA

Labels