Sugar Network/Recipe Specification: Difference between revisions
No edit summary |
|||
| Line 14: | Line 14: | ||
Common options. Options from this section will be accessible from all other sections. It could be useful to store options that are common for all sections. | Common options. Options from this section will be accessible from all other sections. It could be useful to store options that are common for all sections. | ||
'''import''' = <filename> [ | '''import''' = <filename> [; ...] | ||
Import another spec file. Makes sense only within [DEFAULT] section itself. | Import another spec file. Makes sense only within [DEFAULT] section itself. | ||
| Line 58: | Line 58: | ||
Relative (from Zero Sugar based project) path to icon file. | Relative (from Zero Sugar based project) path to icon file. | ||
'''category''' = <category> [ | '''category''' = <category> [; ...] | ||
A classification for the package using values defined by [http://standards.freedesktop.org/menu-spec/latest/apa.html freedesktop.org menu specification]. | A classification for the package using values defined by [http://standards.freedesktop.org/menu-spec/latest/apa.html freedesktop.org menu specification]. | ||
| Line 75: | Line 75: | ||
* stable | * stable | ||
'''requires''' = <dependency> [(=|>=|<) <version>] [ | '''requires''' = <dependency> [(=|>=|<) <version>] [; ...] | ||
List of dependencies that should exist before using the package. Dependency names could be: | List of dependencies that should exist before using the package. Dependency names could be: | ||
| Line 81: | Line 81: | ||
* regular 0install feed url | * regular 0install feed url | ||
'''slots'''[<dependency>] = <first-dependency-version> [ | '''slots'''[<dependency>] = <first-dependency-version> [; ...], <last-dependency-verison> | ||
To specify dependency [[#Slots|slots]].. | To specify dependency [[#Slots|slots]].. | ||
'''binding''' = [prepend|append|replace] <variable-name> [<insert-text-to-prepand-variable-value>] [ | '''binding''' = [prepend|append|replace] <variable-name> [<insert-text-to-prepand-variable-value>] [; ...] | ||
What environment variables, 0install should export to process which uses this package. Makes sense only for various activity dependencies (like libraries), not for activity itself. | What environment variables, 0install should export to process which uses this package. Makes sense only for various activity dependencies (like libraries), not for activity itself. | ||
| Line 104: | Line 104: | ||
exec[valac] = exec "$VALADIR"/bin/valac --vapidir "$VALADIR"/share/vala/vapi "$@" | exec[valac] = exec "$VALADIR"/bin/valac --vapidir "$VALADIR"/share/vala/vapi "$@" | ||
'''include''' = <glob-pattern> [ | '''include''' = <glob-pattern> [; ...] | ||
[[#Glob patterns|Glob pattern]] for files to include to package. By default, all files are assumed. | [[#Glob patterns|Glob pattern]] for files to include to package. By default, all files are assumed. | ||
'''exclude''' = <glob-pattern> [ | '''exclude''' = <glob-pattern> [; ...] | ||
[[#Glob patterns|Glob pattern]] for files to exclude from package. In additional, various temporary files will be excluded like ''.bak'' or ''.pyc''. | [[#Glob patterns|Glob pattern]] for files to exclude from package. In additional, various temporary files will be excluded like ''.bak'' or ''.pyc''. | ||
'''langs''' = <lang-name> [ | '''langs''' = <lang-name> [; ...] | ||
include[<lang-name>] = <glob-pattern> [ | include[<lang-name>] = <glob-pattern> [; ...] | ||
exclude[<lang-name>] = <glob-pattern> [ | exclude[<lang-name>] = <glob-pattern> [; ...] | ||
A special form of ''include''/''exclude'' options that are intended to create separate, per locale, (sub)packages. If language is mentioned in ''langs'' list but doesn't have ''include[]''/''exclude[]'' options, ''include''/''exclude'' will be used (in that case, using special [[#Predefined_options|LANG]] variable makes sense). | A special form of ''include''/''exclude'' options that are intended to create separate, per locale, (sub)packages. If language is mentioned in ''langs'' list but doesn't have ''include[]''/''exclude[]'' options, ''include''/''exclude'' will be used (in that case, using special [[#Predefined_options|LANG]] variable makes sense). | ||
| Line 128: | Line 128: | ||
* ''build'' for binaries to use current architecture | * ''build'' for binaries to use current architecture | ||
'''packaged''' = <distro-name> <package-name> [ | '''packaged''' = <distro-name> <package-name> [; ...] | ||
If package could be installed from official GNU/Linux distributions repository (i.e. not from packages generated from 0sugar.info spec file on OBS), use this option to let 0install know what packages names are on particular GNU/Linux distribution. | If package could be installed from official GNU/Linux distributions repository (i.e. not from packages generated from 0sugar.info spec file on OBS), use this option to let 0install know what packages names are on particular GNU/Linux distribution. | ||
| Line 173: | Line 173: | ||
How to build binaries. If package contains binary implementations, this section should present to describe building process. | How to build binaries. If package contains binary implementations, this section should present to describe building process. | ||
'''requires''' = <dependency-name> [(=|>=|<) <version>] [ | '''requires''' = <dependency-name> [(=|>=|<) <version>] [; ...] | ||
What packages should present before building this one from sources. Similar to ''requires'' option from ''[Package]''. | What packages should present before building this one from sources. Similar to ''requires'' option from ''[Package]''. | ||
| Line 197: | Line 197: | ||
Web link to the sources tarball, if parameter is absent, exec from this section will be used to generate tarball. | Web link to the sources tarball, if parameter is absent, exec from this section will be used to generate tarball. | ||
'''requires''' = <dependency> [(=|>=|<) <version>] [ | '''requires''' = <dependency> [(=|>=|<) <version>] [; ...] | ||
What packages should present before invoking {{Code|0sugar dist}} command i.e. only in maintainer environment not even while building package from sources on user side or on OBS. | What packages should present before invoking {{Code|0sugar dist}} command i.e. only in maintainer environment not even while building package from sources on user side or on OBS. | ||
'''patch''' = <path-to-patch> [patch-level] [ | '''patch''' = <path-to-patch> [patch-level] [; ...] | ||
Patch downloaded tarball, makes sense only if source parameter exists. Option ''exec'' should present as well to make new tarball. | Patch downloaded tarball, makes sense only if source parameter exists. Option ''exec'' should present as well to make new tarball. | ||
| Line 246: | Line 246: | ||
[Service] | [Service] | ||
recipe = <component-name> [ | recipe = <component-name> [; ...] | ||
and declare sections that contain components: | and declare sections that contain components: | ||