Difference between revisions of "Sugar Network/Recipe Specification"

From Sugar Labs
Jump to navigation Jump to search
 
(152 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<noinclude>
+
== Summary ==
−
{{TOCright}}
 
−
[[Category:Zero Sugar]]
 
−
</noinclude>
 
  
−
== Spec file sections ==
+
The document describes software specification files format which is a superset on top of the Sugar [[Development_Team/Almanac/Activity_Bundles|activity bundles]] specification. This format is backwards compatible with [[Development_Team/Almanac/Activity_Bundles#.info_file_format|activity.info]] files to make sure that software starts well from the regular Sugar Shell. But the major purpose of introducing new format is supporting software hosted on the [[Sugar Network]]. In particular, new format assumes the following functionality:
  
−
The 0sugar.info specification file is an analog of scenario files in regular GNU/Linux distributions, like .spec files in RPM. It is the cornerstone of Zero Sugar workflows, everything depends on the 0sugar.info spec file.
+
* Support binary based software;
 +
* Provide information about software dependencies;
 +
* Introduce stability levels to make it possible (for interested in people) to run development versions using the same, like for stable releases, distribution channel;
 +
* Distribute not only Sugar activities, e.g., software libraries;
 +
* Include all required information to make it possible to reuse the same spec file on different software evolution phases, like, making sources tarball, building binaries on Sugar Labs [[Platform_Team/Open_Build_Service|instance]] of the [http://openbuildservice.org/ Open Build Service], executing.
  
−
For activities, ''activity.info'', a deprecated spec file name, is supported.
+
The format is partially based on the [http://0install.net/ Zero Install] [http://0install.net/interface-spec.html specification] since implementation code reuses Zero Install library in order to launch software on users side.
  
−
=== [DEFAULT] ===
+
== Spec file locations ==
  
−
Common options. Options from this section will be accessible from all other sections. It may be useful to store options that are common for all sections.
+
There are two possible spec file locations (staring from the top directory of a distribution bundle):
  
−
'''import''' = <filename> [; ...]
+
* {{Code|/activity/activity.info}}<br>for Sugar activities to make them capable to be launched from the regular Sugar Shell;
 +
* {{Code|/sweets.recipe}}<br>in the rest of cases.
  
−
Import another spec file. Makes sense only within the [DEFAULT] section itself.
+
== Configuration sections ==
 +
 
 +
As ''activity.info'' files, new format is based on [[wikipedia:INI_file|INI files]] and should contain at least one of the following sections.
  
 
=== Common options ===
 
=== Common options ===
  
−
Options that are common for all sections except [DEFAULT].
+
Regardless of the software type, a recipe section (or one of them) should contain the following options.
 +
 
 +
<div id="context"></div>
 +
 
 +
'''context''' = ''GUID''
 +
 
 +
Required (but see the [[#.5BActivity.5D|[Activity]]] section). The value which uniquely identifies a software project this particular version implements. This is a Sugar Network [[Platform_Team/Sugar_Network/Objects_model|Context]] GUID.
 +
 
 +
<div id="name"></div>
 +
 
 +
'''name''' = ''NAME''
 +
 
 +
Optional. Free-form name. (It is equal to the ''implemented'', by default.)
 +
 
 +
<div id="summary"></div>
 +
 
 +
'''summary''' = ''ONE_LINE_TEXT''
 +
 
 +
Required. Short descriptive line.
  
−
'''inherit''' = <section-name> [; ...]
+
<div id="description"></div>
  
−
Include options from another section.
+
'''description''' = ''MULTI_LINE_TEXT''
  
−
'''merge''' = <section-name> [; ...]
+
Optional. Long descriptive text. To wrap long text, all lines starting from the second, should start with spaces. This field is equal to ''summary'' by default.
  
−
The same behaviour as ''inherit'', but merges values for list type options, i.e., the final values will consist of the base-section values with addtional child-section values. List options are:
+
<div id="license"></div>
  
−
* category
+
'''license''' = ''LICENSE'' [; ...]
−
* requires
 
−
* binding
 
−
* include
 
−
* exclude
 
−
* langs
 
−
* packaged
 
  
−
=== [Package] ===
+
Required. Short license names. The licenses should conform with the [[Activity Library]] licensing [[Activity_Library/Editors/Policy/Licensing|policy]].
  
−
This is a required section (but could be replaced by [Activity]). It describes the main package.
+
<div id="homepage"></div>
  
−
  '''slug''' = <package-slug>
+
  '''homepage''' = ''URL''
  
−
The string used as identifier in cases like 0install feed urls or native package names. Only lower alphabetic, numeric, "+"  or "-" symbols are allowed. Slug value should be at least two characters long and start with an alphanumeric character.
+
Required. Software project home page.
  
−
'''name''' = <package-name>
+
<div id="icon"></div>
  
−
Package name, in free form, equals to ''slug'', by default.
+
'''icon''' = ''FILENAME''
  
−
'''summary''' = <one-line-description>
+
Optional (but see the [[#.5BActivity.5D|[Activity]]] section). Path to the icon file starting from the path where the recipe file is located.
  
−
Short descriptive line.
+
<div id="tags"></div>
  
−
  '''description''' = <multi-line-description>
+
  '''tags''' = ''TAG'' [; ...]
  
−
Long descriptive text. To wrap long text, all lines after the second, should start with spaces. This field is equal to ''summary'' by default.
+
Optional. Tags give more context by which to group the software. This is done to allow users to make search more easily.
  
−
'''license''' = <licence-name>
+
<div id="version"></div>
  
−
Package license. Short licence names from [http://fedoraproject.org/wiki/Licensing Fedora naming scheme] are welcome.
+
'''version''' = ''VERSION''
  
−
'''homepage''' = <url>
+
Required. Current version of the software using [[#Version_numbers|special notation]]. Note, to make Sugar activity bundles compatible with pristine Sugar, use a limited format subset supported by the Sugar Shell.
  
−
Packaged project home page.
+
<div id="stability"></div>
  
−
  '''icon''' = <icon-file-name>
+
  '''stability''' = ''LEVEL''
  
−
Relative (from Zero Sugar based project) path to icon file.
+
Required. Stability level of the current version. Values conform to the [[#Software_stability_levels|below list]].
  
−
'''category''' = <category> [; ...]
+
<div id="requires"></div>
  
−
A classification for the package using values defined by [http://standards.freedesktop.org/menu-spec/latest/apa.html freedesktop.org menu specification].
+
'''requires''' = ''DEPENDENCY'' [; ...]
  
−
'''age''' = <age-number>
+
Optional. List of [[#Dependencies|dependencies]] that should exist at run-time before launching the release.
  
−
Simple number that will be used as a major number for ''version'', see [[Activity Team/Zero Sugar/Packaging Guide#Versioning|versioning scheme]] for details.
+
=== [Activity] ===
  
−
'''version''' = <version-number>
+
This section type should be present only in Sugar activities.
  
−
Current version of the package using [http://0install.net/interface-spec.html#id4016582 0install version format]. If the ''age'' option was set, versioning is a bit [[Activity Team/Zero Sugar/Packaging Guide#Versioning|different]].
+
<div id="activity_version"></div>
  
−
  '''stability''' = <stability-level>
+
  '''activity_version''' = ''VERSION''
  
−
Stability level of current version. Values conform to [http://0install.net/interface-spec.html#id4016716 0install stability levels] and could be:
+
Required. An alias of the ''version'' option.
−
* insecure
 
−
* buggy
 
−
* developer
 
−
* testing
 
−
* stable
 
  
−
'''requires''' = <dependency> [(=|>=|<) <version>] [; ...]
+
<div id="bundle_id"></div>
  
−
List of [[Activity Team/Zero Sugar/Packaging Guide#Package_names|dependencies]] that should exist before using the package.
+
'''bundle_id''' = ''BUNDLE_ID''
  
−
'''slots'''[<dependency>] = <first-dependency-version> [; ...], <last-dependency-verison>
+
Required. An alias of the ''context'' option.
  
−
To specify dependency [[Activity Team/Zero Sugar/Packaging Guide#Slots|slots]].
+
<div id="icon"></div>
  
−
  '''binding''' = [prepend|append|replace] <variable-name> [<insert-text-to-prepend-variable-value>] [; ...]
+
  '''icon''' = ''FILENAME_WITHOUT_SUFFIX''
 +
 
 +
Required. Behaviour from {{Code|activity.info}} is supported (value should not have a {{Code|.svg}} suffix, and the icon file can be found only in the {{Code|activity}} subdirectory) and, while deprecated, it needs to be used to not break backwards compatibility. For the remaining cases, the regular ''icon'' behaviour should be used instead.
 +
 
 +
<div id="activity_exec"></div>
 +
 
 +
'''exec''' = ''SHELL_COMMAND''
 +
 
 +
Required. Sugar will pass additional [[Development_Team/Low-level_Activity_API#Command_Line_Arguments| command line arguments]] to this command.
  
−
The environment variables 0install should export to the process that uses this package. This makes sense only for multiple-activity-serving dependencies (like libraries), not for the activity itself.
+
<div id="mime_types"></div>
  
−
  '''main''' = <path-to-exec-file>
+
  '''mime_types''' = ''MIME_TYPE'' [; ...]
  
−
The relative path of an executable inside the implementation that should be executed by default when the package is run.
+
Optional. List of mime types supported by the activity. It's used when opening a file from the web, or to present to the user a list of activities that can open a certain Journal object.
  
−
'''exec''' = <shell-command>
+
<!--
 +
=== [Application] ===
  
−
Instead of using an executable program from the ''main'' option, 0sugar can bundle a script to run an arbitrary shell command.
+
Application to run outside of Sugar Shell.
  
−
If a package has neither ''main'' nor ''exec'', then it cannot be executed. This typically means that the package is for a library.
+
'''exec''' = ''SHELL_COMMAND''
  
−
'''include''' = <glob-pattern> [; ...]
+
Required. The relative path of an executable command inside the implementation that should be executed by default when the sweet is run. Command can have optional arguments.
  
−
[[Activity Team/Zero Sugar/Packaging Guide#Glob patterns|Glob pattern]] for files to include to the package. Path related patterns will be processed starting from [[#Predefined_options|%(DISTDIR)s/%(PREFIX)s]] directory. By default, all files are assumed.
+
=== [Library] ===
  
−
  '''exclude''' = <glob-pattern> [; ...]
+
  '''binding''' = [prepend|append|replace] <variable-name> [<insert-text-to-prepend-variable-value>] [; ...]
  
−
Like ''include'' option but for excluding files from the package. In additional, various temporary files will be excluded like ''.bak'' or ''.pyc''.
+
Required. The environment variables 0install should export to the process that uses this sweet.
 +
-->
 +
=== [Archive] ===
  
−
'''langs''' = <lang-name> [; ...]
+
This configuration section makes sense only while building binary distribution bundles from the sources. The section is optional for spec files that describe software assumed to be launched as-is, e.g., ''.xo'' bundles.
−
include[<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).
+
Each ''[Archive]'' section describes one particular binary bundle. There are might be several sections to define binaries for different cases:
  
−
'''arch''' = <arch>
+
* To save storage space or bandwidth when some bundles will contain any-arch data that are common for all platforms, and another bundle will contain binaries for a particular platform;
 +
* Per language bundles, e.g., for media content.
  
−
Makes sense only for binary (sub)packages, and can contain:
+
All archive sections are named:
−
* ''all'' for noarch (by default)
 
−
* ''any'' for binaries to use the current architecture
 
  
−
=== [Buid] ===
+
Archive[:''SUBNAME'']
  
−
How to build binaries. If package contains binary implementations, this section should be present to describe the building process.
+
And contain the following options:
  
−
'''NOTE''' The commands in this section will be executed, not only in the developer's environment, but also in the user's, if a proper binary wasn't found; so move all development-related commands, like autogen.sh, to the ''[Maintain]'' section.
+
<div id="archive-include"></div>
  
−
  '''requires''' = <dependency-name> [(=|>=|<) <version>] [; ...]
+
  '''include''' = ''GLOB'' [; ...]
  
−
What [[Activity Team/Zero Sugar/Packaging Guide#Package_names|dependencies]] should be present before building the package from sources, in addition to ''requires'' values from the ''[Package]'' sections.
+
Optional. [[#Glob_patterns|Glob pattern]] for files to include in the archive. By default, all files are assumed.
  
−
'''configure''' = <shell-command>
+
<div id="archive-exclude"></div>
  
−
Shell command to configure sources before building, e.g, invoking the ''configure'' script in auto-tools-based projects. It is important to use [[#Predefined_options|predefined constants]], at least ''%(PREFIX)s'', during configuration to prepare valid Zero packages. If the source code does not require a configuration stage, this option could be omited.
+
'''exclude''' = ''GLOB'' [; ...]
  
−
  '''make''' = <shell-command>
+
Optional. Like the ''include'' option, but used for excluding files from the archive. In addition, various temporary files will be excluded, like ''.bak'' or ''.pyc''.
 +
<!-- Not yet implemented
 +
  '''langs''' = <lang-name> [; ...]
 +
include[<lang-name>] = <glob-pattern> [; ...]
 +
exclude[<lang-name>] = <glob-pattern> [; ...]
  
−
Shell command to make binaries from sources. If the source code does not require a making stage, this option could be omited.
+
Optional. A special form of ''include''/''exclude'' options that are intended to create separate, per locale, archives. If a language is mentioned in the ''langs'' list, but doesn't have any ''include[]''/''exclude[]'' options, ''include''/''exclude'' will be used (in that case, using the special [[#Predefined_constants|LANG]] constant makes sense).-->
  
−
'''install''' = <shell-command>
+
<div id="arch"></div>
  
−
Shell command to place files that are ready for distribution into the ''%(DISTDIR)s'' directory.
+
'''arch''' = ''ARCH''
  
−
=== [Maintain] ===
+
Optional. Makes sense only for binary archives, and can contain:
  
−
Various options that make sense only in the package-developer's environment.
+
* ''all'' for noarch (by default),
 +
* ''any'' for binaries to use the current architecture.
  
−
'''source''' = <url>
+
=== [Build] ===
  
−
While packaging 3rd-party applications, url to download sources tarball.
+
This section is required if software needs additional work in order to prepare a ready-to-use installation. It is important to use [[#Predefined_constants|predefined constants]] for options that contain shell commands. All shell commands will be executed from the {{Code|%(BUILDDIR)s}} directory.
  
−
'''patch''' = <path-to-patch> [patch-level] [; ...]
+
'''NOTE''' The commands in this section will be executed, not only in the developer's environment, but also in the user's, if a proper binary wasn't found; so move all development-related commands, like {{Code|autogen.sh}}, to the ''[Source]'' section.
  
−
If ''source'' option is used, 3rd-party sources might be patched.
+
<div id="build-requires"></div>
  
−
  '''exec''' = <shell-command>
+
  '''requires''' = ''DEPENDENCY'' [; ...]
  
−
How to bundle package. Option might be used, e.g., to execute {{Code|make dist}} command.
+
Optional. This defines what [[#Dependencies|dependencies]] should be present before building the software from sources. Note that common ''requires'' option values are not auto included in the build-time dependencies.
  
−
'''include''' = <glob-pattern> [; ...]
+
<div id="clean"></div>
−
'''exclude''' = <glob-pattern> [; ...]
 
  
−
If neither ''source'' nor ''exec'' options were used, all files will be bundled and these [[Activity Team/Zero Sugar/Packaging Guide#Glob patterns|glob patterns]] might be used to concretize selection.
+
'''clean''' = ''SHELL_COMMAND''
  
−
'''requires''' = <dependency> [(=|>=|<) <version>] [; ...]
+
Optional. Cleanup build environment before running ''configure'' command.
  
−
The packages that should be present before creating sources tarball. For example, if the ''exec'' command generates .c files from .vala, the vala dependency should be mentioned in the ''requires'' option.
+
<div id="configure"></div>
  
−
== Presets ==
+
'''configure''' = ''SHELL_COMMAND''
  
−
Instead of package sections (main ''[Package]'' section and sub package sections), special sections might be used. These sections extend standard ''[Package]'' options and might add special meaning of existed ones, see description for particular preset.
+
Optional. Shell command to configure sources before building, e.g., invoking the configure script in auto-tools-based projects. If the source code does not require a configuration stage, this option could be omitted.
  
−
=== [Activity] ===
+
<div id="build-make"></div>
  
−
This preset should be present only for activities (or for applications that could be used also as Activities, e.g., GCompris is a regular application but could be launched in Sugar mode).
+
'''make''' = ''SHELL_COMMAND''
  
−
Preset uses the same options as [Package] with these additions:
+
Optional. Shell command to make binaries from sources. If the source code does not require a making stage, this option could be omitted.
  
−
'''activity_version'''
+
<div id="install"></div>
  
−
Option is deprecated, ''version'' should be used instead.
+
'''install''' = ''SHELL_COMMAND''
  
−
'''bundle_id''' = <bundle-id>
+
Required. Shell command to place files that are ready for distribution into the {{Code|%(DESTDIR)s}} directory. If ''install'' is missing, the entire {{Code|%(BUILDDIR)s}} (excepting temporary files) will be copied.
  
−
See [[Development_Team/Almanac/Activity_Bundles#.info_file_format|activity.info file specification]]. Option will be deprecated after implementing 0sugar in glucose and switching to identifying activities by urls (like 0install feeds).
+
=== [Source] ===
  
−
'''icon''' = <icon-file-name-wo-suffix>
+
The section makes sense only while building sources bundles and is a replacement of former ''MANIFEST'' file in Sugar activity bundles.
  
−
Behaviour from activity.info is supported (value should not have ".svg" suffix, and icon file could be found only in activity subdirectory) but deprecated. Regular ''icon'' behaviour from [Package] section should be used instead.
+
<div id="source-exec"></div>
  
−
  '''exec''' = <shell-command>
+
  '''exec''' = ''SHELL_COMMAND''
  
−
Sugar will pass additional [[Development_Team/Low-level_Activity_API#Command_Line_Arguments| command line arguments]] to this command.
+
Optional. Execute an external program to create sources tarball. Option might be used, e.g., to run {{Code|make dist}} command.
  
−
'''mime_types''' = <mime-type> [; ...]
+
<div id="source-include"></div>
  
−
List of mime types supported by the activity. It's used when opening a file from the web or to present to the user a list of activities which can open a certain Journal object.
+
'''include''' = ''GLOB'' [; ...]
 +
'''exclude''' = ''GLOB'' [; ...]
  
−
'''tags''' = <tag> [; ...]
+
Optional. If the ''exec'' option was not used, all files will be bundled and these [[#Glob_patterns|glob patterns]] might be used to reify the selection.
  
−
Tags give more context in which to group the activity. This is used to allow users to find activities more easily in the Journal, the Home view, etc.
+
<div id="source-requires"></div>
  
−
=== [Application] ===
+
'''requires''' = ''DEPENDENCY'' [; ...]
  
−
If this preset exists, executable file will be created for native packages to launch ''main'' program or ''exec'' script. Executable file will be named by ''slug'' option value and placed to ''/usr/bin'' directory.
+
Optional. The [[#Dependencies|dependencies]] that should be present before creating sources tarball. For example, if the ''exec'' command generates .c files from .vala, the vala dependency should be mentioned in the ''requires'' option.
  
−
== Predefined options ==
+
=== Predefined constants ===
  
−
Options defined within ''[Build]'' section:
+
Constants defined within the ''[Build]'' section:
  
−
* ''BUILDDIR'' where the build happens
+
* ''BUILDDIR'' where the build happens, directory contains un-tarred sources bundle. This variable can be used in ''binding'' options as well. During the local build, it will point environment variables to the root of sources directory.
−
* ''SRCDIR'' path to directory with sources; for a custom (via 0compile) build, ''BUILDDIR'' and ''SRCDIR'' are different, while building on OBS, they are the same
+
* ''DESTDIR'' temporary path to place installed files before bundling them
−
* ''DISTDIR'' temporary path to place installed files before bundling them
 
 
* ''PREFIX'' should be used as installation prefix path, e.g., for {{Code|./configure --prefix}}
 
* ''PREFIX'' should be used as installation prefix path, e.g., for {{Code|./configure --prefix}}
 
* ''CFLAGS'' default gcc CFLAGS
 
* ''CFLAGS'' default gcc CFLAGS
 
* ''CXXFLAGS'' default gcc CXXFLAGS
 
* ''CXXFLAGS'' default gcc CXXFLAGS
  
−
In sections that contain ''langs'' option:
+
In sections that contain a ''langs'' option:
  
 
* ''LANG'' current language while building per language implementation
 
* ''LANG'' current language while building per language implementation
  
−
Also, during the ''0sugar build'' command invocation, ''0sugar'' exports the environment variables that should be used in ''exec'' options, for example, to implement a conditional build.
+
== Version numbers ==
 +
 
 +
A version number string has the following form:
 +
 
 +
Version := DottedList ("-" Modifier? DottedList?)*
 +
DottedList := (Integer ("." Integer)*)
 +
Modifier := "pre" | "rc" | "post"
 +
 
 +
Numerically, the modifiers come in the order "-pre" (pre-release), "-rc" (release candidate), "-" (no modifier name), "-post" (post-release or patch level). Versions are ordered like this:
 +
 
 +
0.1
 +
1
 +
1.0
 +
1.2-pre
 +
1.2-pre1
 +
1.2-rc1
 +
1.2
 +
1.2-0
 +
1.2-post
 +
1.2-post1-pre
 +
1.2-post1
 +
1.2.1-pre
 +
1.2.1.4
 +
1.2.2
 +
1.2.10
 +
3
 +
 
 +
== Software stability levels ==
 +
 
 +
The spec file also gives a stability rating for each implementation. The following levels are allowed (must be lowercase in the feed files):
 +
 
 +
* ''stable'',
 +
* ''testing'',
 +
* ''developer'',
 +
* ''buggy'',
 +
* ''insecure''.
 +
 
 +
Stability ratings are expected to change over time. When any new release is made, its stability should be set to testing. Users who have selected Help test new versions will then start using it. Other users will continue with the previous stable release. After a while (days, weeks or months, depending on the project) with no serious problems found, the implementation's stability can be changed to stable so that everyone will use it.
 +
 
 +
If problems are found, it can instead be marked as ''buggy'', or ''insecure'' to avoid selecting these versions while launching on users side. ''developer'' is like a more extreme version of ''testing'', where the program is expected to have bugs.
  
−
* ''ZSUGAR_<argument-in-upper-case>'' map ''0sugar'' long command line arguments
+
When to use ''buggy''? Don't mark old releases as buggy every time you do a new release, just because a few bugs have been fixed. People who have selected network connectivity automatically pickup the new version anyway, so marking an older version as ''buggy'' only affects people who have explicitly stated that they don't want to use the latest version, but would prefer to use an older release to save network use.
−
* ''SECTION_<section-name-in-upper-case>'' for every spec file section that will be processed
 
  
−
== Examples ==
+
== Dependencies ==
  
−
=== Python activity ===
+
Dependencies might be used to declare software that the current release depends on.
  
−
Python-based activity with standard Sugar Platform dependencies.
+
The format of a dependency string is:
  
−
  [Activity]
+
  ''DEPENDENCY'' [(<|<=|=|>=|>) ''VERSION'']
−
slug      = cartoon-builder
 
−
name      = Cartoon Builder
 
−
summary  = Create your own cell-animation sequences
 
−
license  = GPLv2+
 
−
homepage  = http://wiki.sugarlabs.org/go/Activities/Cartoon_Builder
 
−
icon      = activity/activity-cartoonbuilder.svg
 
−
category  = Games;Education
 
−
version  = 11.4.9-pre3
 
−
stability = testing
 
−
exec      = sugar-activity activity.CartoonBuilderActivity
 
  
−
=== Python library ===
+
The ''DEPENDENCY'' value is a GUID associated with dependency project, i.e., ''context'' value from dependency spec file. In general, it might be any software Sugar Network [http://node.sugarlabs.org/context Context], but current implementation assumes only GNU/Linux [http://node.sugarlabs.org/context?type=package packages].
  
−
Package python-based library that could be used as is, or as an activity dependency.
+
== Glob patterns ==
  
−
[Package]
+
The ''include'' and ''exclude'' options contain file patterns. A pattern could be of two types:
−
slug      = journal
 
−
summary  = Hight level library to create your own Journal-like activity
 
−
license  = GPLv3+
 
−
homepage  = http://wiki.sugarlabs.org/go/Activity_Team/Services/Journal
 
−
version  = 1
 
−
stability = testing
 
−
requires  = toolkit/python
 
−
binding  = PYTHONPATH
 
  
−
=== Vala library ===
+
* doesn't contain ''/'' or ''**'' substrings, will be applied only to file names
 +
* contains ''/'' or ''**'' substring, will be applied to the full file path (relative to the root), thus could affect several directory levels
  
−
Binary library with generating C files from Vala sources, creating library package, and devel, python binding sub-packages.
+
Only these pattern symbols are allowed:
  
−
[DEFAULT]
+
* ''*'' matches everything, except directory separator
−
slug      = env
+
* ''?'' matches any single character, except directory separator
−
summary  = Access to various sugar environment settings.
+
* ''**'' matches everything, including directory separator
−
license  = LGPLv3+
 
−
homepage  = http://wiki.sugarlabs.org/go/Activity_Team/Services/Env
 
−
version  = 0.9
 
−
stability = testing
 
−
 
−
[Package]
 
−
requires  = glib; gconf; libgee >= 0.5
 
−
binding  = LD_LIBRARY_PATH lib
 
−
include  = *.so.*
 
−
arch      = build
 
−
 
−
[Package/devel]
 
−
requires  = glib/devel; gconf/devel; libgee/devel
 
−
            %(slug)s
 
−
binding  = LD_LIBRARY_PATH lib
 
−
            PKG_CONFIG_PATH lib/pkgconfig
 
−
            VAPIDIR share/vala/vapi
 
−
exclude  = %(PYTHON_SITEDIR)s/**
 
−
            *.so.*
 
−
arch      = build
 
−
 
−
[Package/python]
 
−
requires  = python; %(slug)s
 
−
binding  = PYTHONPATH python
 
−
include  = %(PYTHON_SITEDIR)s/**
 
−
arch      = build
 
−
slots[python] = 2.5; 2.6; 2.7; 3.0
 
−
 
−
[Build]
 
−
requires  = glib/devel; gconf/devel; libgee/devel
 
−
            pkgconfig; cmake; make; gcc-c
 
−
build    = cmake -DCMAKE_INSTALL_PREFIX=%(PREFIX)s
 
−
                  -DPYTHON_SITEDIR=%(PYTHON_SITEDIR)s
 
−
                  -DCOMPONENTS="env"
 
−
                  -DBINDING=python
 
−
                  -DCMAKE_C_FLAGS:STRING="%(CFLAGS)s"
 
−
                  %(SRCDIR)s &&
 
−
            make
 
−
install  = make DESTDIR=%(DISTDIR)s install
 
−
 
−
[Maintain]
 
−
requires  = vala
 
−
exec      = make dist
 

Latest revision as of 18:00, 3 July 2013

Summary

The document describes software specification files format which is a superset on top of the Sugar activity bundles specification. This format is backwards compatible with activity.info files to make sure that software starts well from the regular Sugar Shell. But the major purpose of introducing new format is supporting software hosted on the Sugar Network. In particular, new format assumes the following functionality:

  • Support binary based software;
  • Provide information about software dependencies;
  • Introduce stability levels to make it possible (for interested in people) to run development versions using the same, like for stable releases, distribution channel;
  • Distribute not only Sugar activities, e.g., software libraries;
  • Include all required information to make it possible to reuse the same spec file on different software evolution phases, like, making sources tarball, building binaries on Sugar Labs instance of the Open Build Service, executing.

The format is partially based on the Zero Install specification since implementation code reuses Zero Install library in order to launch software on users side.

Spec file locations

There are two possible spec file locations (staring from the top directory of a distribution bundle):

  • /activity/activity.info
    for Sugar activities to make them capable to be launched from the regular Sugar Shell;
  • /sweets.recipe
    in the rest of cases.

Configuration sections

As activity.info files, new format is based on INI files and should contain at least one of the following sections.

Common options

Regardless of the software type, a recipe section (or one of them) should contain the following options. 

context = GUID

Required (but see the [Activity] section). The value which uniquely identifies a software project this particular version implements. This is a Sugar Network Context GUID. 

name = NAME

Optional. Free-form name. (It is equal to the implemented, by default.) 

summary = ONE_LINE_TEXT

Required. Short descriptive line. 

description = MULTI_LINE_TEXT

Optional. Long descriptive text. To wrap long text, all lines starting from the second, should start with spaces. This field is equal to summary by default. 

license = LICENSE [; ...]

Required. Short license names. The licenses should conform with the Activity Library licensing policy. 

homepage = URL

Required. Software project home page. 

icon = FILENAME

Optional (but see the [Activity] section). Path to the icon file starting from the path where the recipe file is located. 

tags = TAG [; ...]

Optional. Tags give more context by which to group the software. This is done to allow users to make search more easily. 

version = VERSION

Required. Current version of the software using special notation. Note, to make Sugar activity bundles compatible with pristine Sugar, use a limited format subset supported by the Sugar Shell. 

stability = LEVEL

Required. Stability level of the current version. Values conform to the below list. 

requires = DEPENDENCY [; ...]

Optional. List of dependencies that should exist at run-time before launching the release.

[Activity]

This section type should be present only in Sugar activities. 

activity_version = VERSION

Required. An alias of the version option. 

bundle_id = BUNDLE_ID

Required. An alias of the context option. 

icon = FILENAME_WITHOUT_SUFFIX

Required. Behaviour from activity.info is supported (value should not have a .svg suffix, and the icon file can be found only in the activity subdirectory) and, while deprecated, it needs to be used to not break backwards compatibility. For the remaining cases, the regular icon behaviour should be used instead. 

exec = SHELL_COMMAND

Required. Sugar will pass additional command line arguments to this command. 

mime_types = MIME_TYPE [; ...]

Optional. List of mime types supported by the activity. It's used when opening a file from the web, or to present to the user a list of activities that can open a certain Journal object.

[Archive]

This configuration section makes sense only while building binary distribution bundles from the sources. The section is optional for spec files that describe software assumed to be launched as-is, e.g., .xo bundles.

Each [Archive] section describes one particular binary bundle. There are might be several sections to define binaries for different cases:

  • To save storage space or bandwidth when some bundles will contain any-arch data that are common for all platforms, and another bundle will contain binaries for a particular platform;
  • Per language bundles, e.g., for media content.

All archive sections are named: 

Archive[:SUBNAME]

And contain the following options: 

include = GLOB [; ...]

Optional. Glob pattern for files to include in the archive. By default, all files are assumed. 

exclude = GLOB [; ...]

Optional. Like the include option, but used for excluding files from the archive. In addition, various temporary files will be excluded, like .bak or .pyc. 

arch = ARCH

Optional. Makes sense only for binary archives, and can contain:

  • all for noarch (by default),
  • any for binaries to use the current architecture.

[Build]

This section is required if software needs additional work in order to prepare a ready-to-use installation. It is important to use predefined constants for options that contain shell commands. All shell commands will be executed from the %(BUILDDIR)s directory.

NOTE The commands in this section will be executed, not only in the developer's environment, but also in the user's, if a proper binary wasn't found; so move all development-related commands, like autogen.sh, to the [Source] section. 

requires = DEPENDENCY [; ...]

Optional. This defines what dependencies should be present before building the software from sources. Note that common requires option values are not auto included in the build-time dependencies. 

clean = SHELL_COMMAND

Optional. Cleanup build environment before running configure command. 

configure = SHELL_COMMAND

Optional. Shell command to configure sources before building, e.g., invoking the configure script in auto-tools-based projects. If the source code does not require a configuration stage, this option could be omitted. 

make = SHELL_COMMAND

Optional. Shell command to make binaries from sources. If the source code does not require a making stage, this option could be omitted. 

install = SHELL_COMMAND

Required. Shell command to place files that are ready for distribution into the %(DESTDIR)s directory. If install is missing, the entire %(BUILDDIR)s (excepting temporary files) will be copied.

[Source]

The section makes sense only while building sources bundles and is a replacement of former MANIFEST file in Sugar activity bundles. 

exec = SHELL_COMMAND

Optional. Execute an external program to create sources tarball. Option might be used, e.g., to run make dist command. 

include = GLOB [; ...]
exclude = GLOB [; ...]

Optional. If the exec option was not used, all files will be bundled and these glob patterns might be used to reify the selection. 

requires = DEPENDENCY [; ...]

Optional. The dependencies that should be present before creating sources tarball. For example, if the exec command generates .c files from .vala, the vala dependency should be mentioned in the requires option.

Predefined constants

Constants defined within the [Build] section:

  • BUILDDIR where the build happens, directory contains un-tarred sources bundle. This variable can be used in binding options as well. During the local build, it will point environment variables to the root of sources directory.
  • DESTDIR temporary path to place installed files before bundling them
  • PREFIX should be used as installation prefix path, e.g., for ./configure --prefix
  • CFLAGS default gcc CFLAGS
  • CXXFLAGS default gcc CXXFLAGS

In sections that contain a langs option:

  • LANG current language while building per language implementation

Version numbers

A version number string has the following form: 

Version := DottedList ("-" Modifier? DottedList?)*
DottedList := (Integer ("." Integer)*)
Modifier := "pre" | "rc" | "post"

Numerically, the modifiers come in the order "-pre" (pre-release), "-rc" (release candidate), "-" (no modifier name), "-post" (post-release or patch level). Versions are ordered like this: 

0.1
1
1.0
1.2-pre
1.2-pre1
1.2-rc1
1.2
1.2-0
1.2-post
1.2-post1-pre
1.2-post1
1.2.1-pre
1.2.1.4
1.2.2
1.2.10
3

Software stability levels

The spec file also gives a stability rating for each implementation. The following levels are allowed (must be lowercase in the feed files):

  • stable,
  • testing,
  • developer,
  • buggy,
  • insecure.

Stability ratings are expected to change over time. When any new release is made, its stability should be set to testing. Users who have selected Help test new versions will then start using it. Other users will continue with the previous stable release. After a while (days, weeks or months, depending on the project) with no serious problems found, the implementation's stability can be changed to stable so that everyone will use it.

If problems are found, it can instead be marked as buggy, or insecure to avoid selecting these versions while launching on users side. developer is like a more extreme version of testing, where the program is expected to have bugs.

When to use buggy? Don't mark old releases as buggy every time you do a new release, just because a few bugs have been fixed. People who have selected network connectivity automatically pickup the new version anyway, so marking an older version as buggy only affects people who have explicitly stated that they don't want to use the latest version, but would prefer to use an older release to save network use.

Dependencies

Dependencies might be used to declare software that the current release depends on.

The format of a dependency string is: 

DEPENDENCY [(<|<=|=|>=|>) VERSION]

The DEPENDENCY value is a GUID associated with dependency project, i.e., context value from dependency spec file. In general, it might be any software Sugar Network Context, but current implementation assumes only GNU/Linux packages.

Glob patterns

The include and exclude options contain file patterns. A pattern could be of two types:

  • doesn't contain / or ** substrings, will be applied only to file names
  • contains / or ** substring, will be applied to the full file path (relative to the root), thus could affect several directory levels

Only these pattern symbols are allowed:

  • * matches everything, except directory separator
  • ? matches any single character, except directory separator
  • ** matches everything, including directory separator
Retrieved from "https://wiki.sugarlabs.org/index.php?title=Sugar_Network/Recipe_Specification&oldid=88603"