Changes

no edit summary
Line 34: Line 34:  
== Dictionary ==
 
== Dictionary ==
   −
A list of terms to understand basic conceptions.
+
A list of terms to understand the basic concepts of ''Sweets''.
   −
'''Zero Install''', '''0install'''<br>
+
;Zero Install, 0install
Decentralized cross-distribution software installation system that ''Sweets'' is based on.
+
:Decentralized cross-distribution software installation system that ''Sweets'' is based on.
   −
'''Sweets'''<br>
+
;Sweets
Package management wrapper around ''Zero Install''.
+
:Package management wrapper around ''Zero Install''.
   −
'''sweet''', '''sweet project'''<br>
+
;sweet, sweet project
Distribution entities in ''Sweets'', i.e., packages. In other words, software projects that have ''recipe'' files in their sources that are being released via ''Sweets''.
+
:Distribution entities in ''Sweets'', i.e., packages. In other words, software projects that have ''recipe'' files in their sources that are being released via ''Sweets''.
   −
'''feed'''<br>
+
;feed
A file in [http://0install.net/interface-spec.html XML notation] that contains information about all possible variants of a software, i.e., ''implementations'', that can be launched.
+
:A file in [http://0install.net/interface-spec.html XML notation] that contains information about all possible variants of the software, i.e., ''implementations'', that can be launched.
   −
'''interface'''<br>
+
;interface
This is the corner stone of ''Zero Install'' and, thus, ''Sweets'' as well. To make a ''feed'' useful for other people, they are placed somewhere ([[Platform_Team/Infrastructure|http://sweets.sugarlabs.org]] in case of ''Sweets'') in the Internet for being accessible via HTTP/FTP. The full Web url, such as http://0install.net/2006/interfaces/ZeroInstall-GUI.xml, is an unique identifier of a distribution entity within ''Zero Install''/''Sweets'' and named the ''interface''.  
+
:This is the cornerstone of ''Zero Install'' and, thus, ''Sweets'', as well. To make a ''feed'' useful for other people, they are placed somewhere on the Internet to be accessible via HTTP/FTP ([[Platform_Team/Infrastructure|http://sweets.sugarlabs.org]] for the ''Sweets'' case). The full Web url, such as http://0install.net/2006/interfaces/ZeroInstall-GUI.xml, is a unique identifier of a distribution entity within ''Zero Install''/''Sweets''. This powerful identifier is named the ''interface''.  
Only this url is needed to run software from everywhere if there is a connection to the Internet.
+
:This url is all that is needed to run software from everywhere there is a connection to the Internet.
   −
'''implementation'''<br>
+
;implementation
One or several bundles that contain one particular implementation of software projects that are being distributed via ''Zero Install''. ''Implementations'' are being [[Platform_Team/Recipe_Specification|attributed]] with versions, stability levels, targeted machine architectures and OS types. It is possible to have several implementations for the same software version if there are differences between launching them on different OSes or machine architectures. Another important attribute of ''implementations'' are dependencies of this particular ''implementation'', formed as a list of ''interfaces''. ''Feeds'' contain information about all existed implementations to let ''Zero Install'' choose the right one on the client side taking into account tons of details like machine architecture, OS type, stability levels or dependency restrictions.
+
:One or several bundles that contain one particular implementation of software projects that are being distributed via ''Zero Install''. ''Implementations'' are [[Platform_Team/Recipe_Specification|attributed]] with versions, stability levels, targeted machine architectures, and OS types. It is possible to have several implementations for the same software version if there are differences between launching them on different OSes or machine architectures. Another important attribute of ''implementations'' are dependencies of this particular ''implementation'', formed as a list of ''interfaces''. ''Feeds'' contain information about all existing implementations in order to let ''Zero Install'' choose the right one on the client side, taking into account tons of details, like machine architecture, OS type, stability levels, or dependency restrictions.
   −
'''recipe'''<br>
+
;recipe
On ''Zero Install'' level, developers work with ''feeds'' manually. In case of ''Sweets'', the regular way is [[Platform_Team/Recipe_Specification|using]] ''recipes'' (but it is still possible to fallback to ''feeds'' all time). In short, it is an analog of spec files in GNU/Linux distributions, e.g., RPM {{Code|.spec}} files or {{Code|debian/}} directories in Debian. ''Recipes'' do not specify ready-to-launch ''implementations'' like ''feeds'' do, but only describe the last software version. The ''feed'' will be generated automatically on [[Platform_Team/Infrastructure|a server]] (with preserving the history of versions) after [[Platform_Team/Guide/Sweets_Packaging|releasing]] new version of the software.
+
:On the ''Zero Install'' level, developers work with ''feeds'' manually. In the ''Sweets'' case, the regular way is to [[Platform_Team/Recipe_Specification|use ''recipes'']] (but it is still possible to fallback to using ''feeds'' at any time). In short, it is an analog of spec files in GNU/Linux distributions, e.g., RPM {{Code|.spec}} files or {{Code|debian/}} directories in Debian. ''Recipes'' do not specify ready-to-launch ''implementations'' like ''feeds'' do, but rather, only describe the lastest software version. The ''feed'' will be generated automatically on [[Platform_Team/Infrastructure|a server]] (along with preserving the history of versions) after [[Platform_Team/Guide/Sweets_Packaging|releasing]] a new version of the software.
   −
'''Short form for sweet interfaces'''<br>
+
;Short form for sweet interfaces
Within ''Sweets'', it is possible to omit {{Code|http://sweets.sugarlabs.org/}} prefix for sweet ''interfaces'' to make usage more expressive, e.g., in ''recipe'' files. It is all time possible to use full ''interfaces''.
+
:Within ''Sweets'', it is possible to omit the {{Code|http://sweets.sugarlabs.org/}} prefix for sweet ''interfaces'' so as to make usage more expressive, e.g., in ''recipe'' files. It is always possible to use the full ''interfaces''.
   −
'''Implemented interfaces'''<br>
+
;Implemented interfaces
One particular ''sweet'' implements, [[Platform_Team/Recipe_Specification#Common_options|according]] to ''recipe'' files, one or several ''interfaces''. The reason to have several ''interfaces'' is that the same ''sweet'' might represent it self, e.g., http://sweets.sugarlabs.org/~alsroot/browse, and the upstream ''sweet'' that was used as a basis for current one, e.g., http://sweets.sugarlabs.org/browse. Further on client side, it will be possible to get implementations from {{Code|~alsroot/browse}} while launching {{Code|browse}} ''sweet''.
+
:One particular ''sweet'' implements one or several ''interfaces'' [[Platform_Team/Recipe_Specification#Common_options|according]] to its ''recipe'' files. The reason for having several ''interfaces'' is that the same ''sweet'' might represent itself, e.g., http://sweets.sugarlabs.org/~alsroot/browse, and the upstream ''sweet'' that was used as a basis for the current one, e.g., http://sweets.sugarlabs.org/browse. Furthermore, on the client side, it will be possible to get implementations from {{Code|~alsroot/browse}} while launching {{Code|browse}} ''sweet''.
   −
'''Associated interfaces'''<br>
+
;Associated interfaces
''Associated interfaces'' is the different way to setup upstream-downstream relations between ''interfaces''. If a ''recipe'' file [[Platform_Team/Recipe_Specification#Common_options|mentions]] some ''interfaces'' as ''associated'', ''implementations'' from these interfaces will be added to the ''implementations'' list of the current one. For example, if http://sweets.sugarlabs.org/sdk/sugar (pure ''sweet'' Sugar Shell) ''interface'' contains http://sweets.sugarlabs.org/base/sugar (an alias to natively packaged Sugar Shell) as an ''associated interface'', while launching {{Code|sdk/sugar}} it will be possible to run natively packaged sugar that came from the {{Code|base/sugar}}.
+
:''Associated interfaces'' is the alternate way to setup upstream-downstream relations between ''interfaces''. If a ''recipe'' file [[Platform_Team/Recipe_Specification#Common_options|mentions]] some ''interfaces'' as ''associated'', ''implementations'' from these interfaces will be added to the ''implementations'' list of the current one. For example, if the http://sweets.sugarlabs.org/sdk/sugar ''interface'' (the pure ''sweet'' Sugar Shell) contains http://sweets.sugarlabs.org/base/sugar (an alias to the natively packaged Sugar Shell) as an ''associated interface'', it will be possible while launching {{Code|sdk/sugar}}, to run natively packaged sugar that came from {{Code|base/sugar}}.
   −
'''local sweet'''<br>
+
;local sweet
It is an important high-level conception in ''Sweets'' that is intended to make development process of ''sweet'' projects more comfortable. Technically, it is sources of ''sweet'' project (i.e., with a ''recipe'' file) placed somewhere to files system and registered in local ''Sweets'' as a one ''implementation'' for ''interfaces'' it ''implements''. It is all time possible to run this ''local sweet'' directly be using the full files system path as an ''interface'', but the most useful feature is reusing ''local implementation'' in regular ''Sweets'' workflow. For example, if sugar-toolkit sources were cloned to {{Code|~/src/sugar-toolkit}} directory, while running {{Code|sugar}} ''sweet'', it will be possible to reuse local sugar-toolkit sources as a regular ''implementation''.
+
:It is an important high-level concept in ''Sweets'', which is intended to make the development process of ''sweet'' projects more comfortable. Technically, it is the source software of the ''sweet'' project (i.e., with a ''recipe'' file) placed somewhere in the file system and registered in the local ''Sweets'' instance as a single ''implementation'' for ''interfaces'' it ''implements''. It is always possible to run this ''local sweet'' directly by using the full filesystem path as an ''interface'', but its most useful feature is reuse of the ''local implementation'' in routine ''Sweets'' workflows. For example, if sugar-toolkit sources were cloned to the {{Code|~/src/sugar-toolkit}} directory, then while running a {{Code|sugar}} ''sweet'', it would become possible to reuse local sugar-toolkit sources as a regular ''implementation''.
   −
'''sweet package'''<br>
+
;sweet package
Using http://packages.sugarlabs.org Web UI, it is possible to create a repository with native packages from released ''sweets''.
+
:Using the http://packages.sugarlabs.org Web UI, it is possible to create a repository with native packages from released ''sweets''.
   −
'''Sweets Distribution'''<br>
+
;Sweets Distribution
It is a [http://download.sugarlabs.org/packages/SweetsDistribution:/ repository] with Glucose and Fructose ''sweet packages'' based on {{Code|sdk/}} ''sweets''.
+
:It is a [http://download.sugarlabs.org/packages/SweetsDistribution:/ repository] with Glucose and Fructose ''sweet packages'' based on {{Code|sdk/}} ''sweets''.
    
== Further reading ==
 
== Further reading ==