diff options
| author | fenn <fennetic.net> | 2011-01-07 16:39:38 -0800 |
|---|---|---|
| committer | fenn <fennetic.net> | 2011-01-07 16:39:38 -0800 |
| commit | 0cbd45d93a8b9821bdc727e61a4441d709075cfe (patch) | |
| tree | 35db48217d1ba233210f3a6f890cb2fc3a6025e7 | |
| parent | a7d69cdbe9257ea0b7573b27cfc9bb435f4b800e (diff) | |
| download | skdb-0cbd45d93a8b9821bdc727e61a4441d709075cfe.tar.gz skdb-0cbd45d93a8b9821bdc727e61a4441d709075cfe.zip | |
explain metadata template
| -rw-r--r-- | doc/package_spec.yaml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/package_spec.yaml b/doc/package_spec.yaml index 3c59bf5..b5b8d0d 100644 --- a/doc/package_spec.yaml +++ b/doc/package_spec.yaml @@ -76,7 +76,7 @@ data format: - yaml files shall be written in valid yaml 1.2 format (see http://www.yaml.org/spec ). yaml data should generally be in fully expanded (indentation-based) flow style unless the folded (explicit - delimeter json-style) flow style significantly improves readability. + delimiter json-style) flow style significantly improves readability. - use a consistent style and ordering when making changes to yaml files so that diffs show only the relevant change. do not overwrite @@ -118,9 +118,9 @@ metadata: - package data begins with the "!package" tag and has the following fields - maintainer: package maintainer name and contact info. - - license: package license. this license applies to all files in the package not - otherwise labeled. if particular files in the package have a - different license, it should be noted in the files section. + - license: package license. this license applies to all files in the + package not otherwise labeled. if particular files in the package + have a different license, it should be noted in the files section. - licenses shall be a string consisting of one of the following: - a creative commons short license name ("CC-BY-SA-3.0") from the list of choices at http://creativecommons.org/licenses/ i @@ -167,6 +167,14 @@ metadata: format of this will likely change. - use: a tree of possible sets of processes and packages required for using the artifact. more on this later. + - template: + if a package contains data for a family of parts, it is helpful to + describe the general form of the interfaces for a given part. is it + a mechanical part? an electrical connector? if the units match up + properly, there is a chance that the part does what you want and it + worth downloading for a look. to support this functionality, a + template part with the same set of interfaces as any given part in + the family is provided in the metadata file. external: - size: the size of the package (including the metadata file) |