Difference between revisions of "Platform Team/Guide/Sweets Packaging"
| Line 7: | Line 7: | ||
== Prepare the environment == | == Prepare the environment == | ||
| − | Using [[Platform_Team/Guide/Sweets_Usage#Installation|Usage guide]]'s instructions, install the Sweets. In addition, Sweets might be used from sources: | + | Using the [[Platform_Team/Guide/Sweets_Usage#Installation|Usage guide]]'s instructions, install the Sweets. In addition, Sweets might be used from sources: |
git clone git://git.sugarlabs.org/sdk/sweets.git | git clone git://git.sugarlabs.org/sdk/sweets.git | ||
| Line 19: | Line 19: | ||
== Writing recipe files == | == Writing recipe files == | ||
| − | The recipe specification file is an analog of scenario files in regular GNU/Linux distributions, like {{Code|.spec}} files in RPM. It is the cornerstone of Sweets, everything on sweet project level depends on the recipe file. For activities, {{Code|activity/activity.info}}, an inherited recipe file name, is supported. | + | The recipe specification file is an analog of scenario files in regular GNU/Linux distributions, like {{Code|.spec}} files in RPM. It is the cornerstone of Sweets, everything on the sweet project level depends on the recipe file. For activities, {{Code|activity/activity.info}}, an inherited recipe file name, is supported. |
| − | On logical level, the | + | On a logical level, the entire Sweets infrastructure might be treated as a set of distribution bundles with sources that contain recipe files. Software projects are identified as Zero Install ''interfaces'' that contain information about which distribution bundle needs to be downloaded in order to launch a particular software version. That's not the full picture (there are binary bundles created based on sources), but it is useful for this topic's purpose. Read the [[#Development with Sweets|Development with Sweets]] section to learn about the available usage scenarios. |
| − | + | A recipe file is an [http://docs.python.org/library/configparser.html ini] format configuration file that might consist of several sections: | |
* One or more [[Platform_Team/Recipe_Specification#Use case sections|use case sections]]. | * One or more [[Platform_Team/Recipe_Specification#Use case sections|use case sections]]. | ||
| Line 30: | Line 30: | ||
* Optional {{Code|[DEFAULT]}} section with common options that are accessible from all other sections. | * Optional {{Code|[DEFAULT]}} section with common options that are accessible from all other sections. | ||
| − | These files need to be placed | + | These files need to be placed in the root sources directory with names {{Code|sweets.recipe}} or {{Code|activity/activity.info}} for Sugar activities. |
== Development with Sweets == | == Development with Sweets == | ||
| − | Source bundles might be used on a client side not only indirectly, via {{Code|sweets}} command for example, but also explicitly. Sources might be bundled, emailed, etc. In | + | Source bundles might be used on a client side not only indirectly, via {{Code|sweets}} command for example, but also explicitly. Sources might be bundled, emailed, etc. In this case, it is no different from {{Code|.xo}} files. To make sources useful within Sweets, the local directory with sources might be used in several cases: |
* Applications might be launched from sources, {{Code|sweets ''<path-to-sources>''}; | * Applications might be launched from sources, {{Code|sweets ''<path-to-sources>''}; | ||
* To reuse sources as dependencies for other sweets, source directory needs to be registered in Sweets, {{Code|sweets checkout ''<path-to-sources>''}}; applications might be checked out as well. | * To reuse sources as dependencies for other sweets, source directory needs to be registered in Sweets, {{Code|sweets checkout ''<path-to-sources>''}}; applications might be checked out as well. | ||
| − | Checking out will register a ''sweet'' in the local ''Sweets'' instance as a single ''implementation'' for ''interfaces'' it ''implements''. This feature is especially useful for libraries, for example, if the sugar-toolkit sources, which implement the {{Code|sdk/sugar-toolkit}} ''interface'', were cloned to the {{Code|~/src/sugar-toolkit}} directory, then, while running a {{Code|sdk/sugar}} ''sweet'', it would become possible to reuse local sugar-toolkit sources as a regular ''implementation'' of the {{Code|sdk/sugar-toolkit}} dependency of {{Code|sdk/sugar}}. | + | Checking out will register a ''sweet'' in the local ''Sweets'' instance as a single ''implementation'' for the ''interfaces'' it ''implements''. This feature is especially useful for libraries, for example, if the sugar-toolkit sources, which implement the {{Code|sdk/sugar-toolkit}} ''interface'', were cloned to the {{Code|~/src/sugar-toolkit}} directory, then, while running a {{Code|sdk/sugar}} ''sweet'', it would become possible to reuse local sugar-toolkit sources as a regular ''implementation'' of the {{Code|sdk/sugar-toolkit}} dependency of {{Code|sdk/sugar}}. |
== Feedback == | == Feedback == | ||
Revision as of 13:35, 30 September 2011
Summary
This guide describes how to prepare software projects to be distributed via Sugar Labs' Packaging Management System, Sweets.
Make sure that you read the introduction page and Usage guide. To understand conceptual ideas, read the Glossary.
Prepare the environment
Using the Usage guide's instructions, install the Sweets. In addition, Sweets might be used from sources:
git clone git://git.sugarlabs.org/sdk/sweets.git cd sweets git submodule init git submodule update ./sweets upgrade
The command ./sweets upgrade might require relogin from the X session to take into account the new PATH value.
Writing recipe files
The recipe specification file is an analog of scenario files in regular GNU/Linux distributions, like .spec files in RPM. It is the cornerstone of Sweets, everything on the sweet project level depends on the recipe file. For activities, activity/activity.info, an inherited recipe file name, is supported.
On a logical level, the entire Sweets infrastructure might be treated as a set of distribution bundles with sources that contain recipe files. Software projects are identified as Zero Install interfaces that contain information about which distribution bundle needs to be downloaded in order to launch a particular software version. That's not the full picture (there are binary bundles created based on sources), but it is useful for this topic's purpose. Read the Development with Sweets section to learn about the available usage scenarios.
A recipe file is an ini format configuration file that might consist of several sections:
- One or more use case sections.
- Optional archive sections.
- Optional auxiliary sections.
- Optional
[DEFAULT]section with common options that are accessible from all other sections.
These files need to be placed in the root sources directory with names sweets.recipe or activity/activity.info for Sugar activities.
Development with Sweets
Source bundles might be used on a client side not only indirectly, via sweets command for example, but also explicitly. Sources might be bundled, emailed, etc. In this case, it is no different from .xo files. To make sources useful within Sweets, the local directory with sources might be used in several cases:
- Applications might be launched from sources, {{Code|sweets <path-to-sources>};
- To reuse sources as dependencies for other sweets, source directory needs to be registered in Sweets,
sweets checkout <path-to-sources>; applications might be checked out as well.
Checking out will register a sweet in the local Sweets instance as a single implementation for the interfaces it implements. This feature is especially useful for libraries, for example, if the sugar-toolkit sources, which implement the sdk/sugar-toolkit interface, were cloned to the ~/src/sugar-toolkit directory, then, while running a sdk/sugar sweet, it would become possible to reuse local sugar-toolkit sources as a regular implementation of the sdk/sugar-toolkit dependency of sdk/sugar.
Feedback
- Submit your bug report.
- Ask your question on IRC channels, #sugar (not logged) or #sugar-newbies (logged).