Difference between revisions of "Documentation Team/Obsolete/Services Wrap native packages HOWTO"

From Sugar Labs
Jump to navigation Jump to search
m (link updates)
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<noinclude>{{GoogleTrans-en}}{{TOCright}}
+
{{Obsolete | Was only draft content.}}
−
[[Category:Activity Team]]
+
 
 +
<noinclude>
 +
[[Category:Services/Documentation]]
 
</noinclude>
 
</noinclude>
  
 
== Introduction ==
 
== Introduction ==
  
−
The purpose of this Guide is describe how to simplify process of usage, by activity developers, packages that are not included to Sugar Platform but well packaged to various GNU/Linux distributions.
+
The purpose of this Guide is to describe how to simplify the usage by activity or service developers of packages that are not included in the [[0.86/Platform_Components|Sugar Platform]] but are well packaged by various GNU/Linux distributions.
 +
 
 +
== Workflows ==
 +
 
 +
* If the service you are planing to use already exists on http://download.sugarlabs.org/services/, just add its name to the ''requires'' field in your [[Documentation Team/Services/Activity Developers Guide|activity]] or [[Documentation Team/Services/Service Developers Guide|service]] ''.info'' file.
 +
* Otherwise, read the rest of this document to learn how to create a service that represents a native package.
 +
 
 +
== Detailed description ==
 +
 
 +
To use native packages, they should be wrapped into services. Such services are lightweight and contain only the appropriate information about native packages. By having service wrappers, we can collect all distro-specific information in one place, because various GNU/Linux distributions could have different names for the same upstream application.
 +
 
 +
=== Prime distributions list ===
 +
 
 +
According to http://distrowatch.com/, there are several distributions whose names could be mentioned in a service. The following table is a list of primary distributions from the top 100 for year 2009 (excluding source-based and special distributions), in most cases, their names will be the same in all derivative distributions.
 +
 
 +
{| border=1 cellpadding=3 style="border: 1px solid white; border-collapse: collapse; background: #e3e4e5;"
 +
|-style="background:#787878; color: white;"
 +
! Popularity
 +
! Name in service.info
 +
! Packages
 +
! Sugar support
 +
|-
 +
|2
 +
|[http://distrowatch.com/fedora fedora]
 +
|[http://rpm.pbone.net/index.php3/stat/2/simple/2 RPM (yum)]
 +
|[[Fedora|yes]]
 +
|-
 +
|4
 +
|[http://distrowatch.com/suse suse]
 +
|[http://rpm.pbone.net/index.php3/stat/2/simple/2 RPM]
 +
|[http://en.opensuse.org/Sugar yes]
 +
|-
 +
|5
 +
|[http://distrowatch.com/debian debian]
 +
|[http://www.debian.org/distrib/packages#search_packages DEB]
 +
|[[Debian|yes]]
 +
|-
 +
|6
 +
|[http://distrowatch.com/mandriva mandriva]
 +
|[http://maint.mandriva.com/ RPM (urpmi)]
 +
|[[Mandriva|yes]]
 +
|-
 +
|7
 +
|[http://distrowatch.com/puppy puppy]
 +
|PET
 +
|no
 +
|-
 +
|10
 +
|[http://distrowatch.com/arch archlinux]
 +
|[http://www.archlinux.org/packages/ Pacman]
 +
|[http://wiki.archlinux.org/index.php/Sugar yes]
 +
|-
 +
|13
 +
|[http://distrowatch.com/slackware slackware]
 +
|TXZ
 +
|no
 +
|-
 +
|38
 +
|[http://distrowatch.com/moblin moblin]
 +
|RPM
 +
|no
 +
|-
 +
|40
 +
|[http://distrowatch.com/frugalware frugalware]
 +
|FPM (TAR.BZ2)
 +
|no
 +
|-
 +
|41
 +
|[http://distrowatch.com/pardus pardus]
 +
|PiSi
 +
|no
 +
|-
 +
|74
 +
|[http://distrowatch.com/altlinux altlinux]
 +
|[http://www.sisyphus.ru:1080/en/packages/ RPM (APT)]
 +
|[[ALT Linux|yes]]
 +
|-
 +
|89
 +
|[http://distrowatch.com/turbolinux turbolinux]
 +
|RPM
 +
|no
 +
|-
 +
|91
 +
|[http://distrowatch.com/crux crux]
 +
|TAR.GZ
 +
|no
 +
|-
 +
|96
 +
|[http://distrowatch.com/linuxconsole linuxconsole]
 +
|LCM
 +
|no
 +
|-
 +
|99
 +
|[http://distrowatch.com/yoper yoper]
 +
|RPM
 +
|no
 +
|-
 +
|}
 +
 
 +
Package wrappers are regular services, so read the [[Documentation_Team/Services/Service_Developers_Guide|Service Developers Guide]] first.
 +
 
 +
== service.info file ==
 +
 
 +
In addition to the [[Documentation_Team/Services/Service_Developers_Guide#service.info_file|standard]] ''service.info'' file, the wrappers' file contains the following:
 +
 
 +
* ''Service'' section contains only
 +
** name
 +
** summary
 +
** description
 +
** homepage
 +
* It should contain one or more ''Distro:<name>'' sections
 +
* ''Distro:'' section with name ''*'', describes common distro parameters.
 +
 
 +
Each ''Distro:'' section
 +
 
 +
* should contain a ''name'' field which is a local package name for the service,
 +
* an optional ''buildtime-name'' field, which goes to the buildtime.xml feed, by default ''name'' will be used.
 +
* Applications could contain a ''main'' field with a full path to the exec file (which could be different for different distributions).
 +
 
 +
== Workflow ==
 +
 
 +
* Create a [[#service.info file|service.info]] file.
 +
* Add a ''Distro:*'' section with common distro parameters.
 +
* Add ''Distro:<name>'' sections, at least for [[#Prime_distributions_list|sugar supported]] distributions.
 +
* Execute ''0sugar push'' to upload changes to the server.
 +
* If a service's application is not well packaged, please consider the possibility of [[Documentation_Team/Services/Service_Developers_Guide|adding]] source and binary service implementations.
 +
 
 +
== Known issues ==
 +
 
 +
* In RO mode (check if some package is installed), 0install can work only with deb and rpm based distributions or, if PackageKit is installed, all distributions that current PackageKit version supports.
 +
* To install packages, the system should have PackageKit.

Latest revision as of 14:13, 3 July 2012

Stop hand.png NOTE:
The content of this page is considered
DEPRECATED and OBSOLETE
It is preserved for historical research, along with its talk page.
Was only draft content.


Introduction

The purpose of this Guide is to describe how to simplify the usage by activity or service developers of packages that are not included in the Sugar Platform but are well packaged by various GNU/Linux distributions.

Workflows

  • If the service you are planing to use already exists on http://download.sugarlabs.org/services/, just add its name to the requires field in your activity or service .info file.
  • Otherwise, read the rest of this document to learn how to create a service that represents a native package.

Detailed description

To use native packages, they should be wrapped into services. Such services are lightweight and contain only the appropriate information about native packages. By having service wrappers, we can collect all distro-specific information in one place, because various GNU/Linux distributions could have different names for the same upstream application.

Prime distributions list

According to http://distrowatch.com/, there are several distributions whose names could be mentioned in a service. The following table is a list of primary distributions from the top 100 for year 2009 (excluding source-based and special distributions), in most cases, their names will be the same in all derivative distributions.

Popularity Name in service.info Packages Sugar support
2 fedora RPM (yum) yes
4 suse RPM yes
5 debian DEB yes
6 mandriva RPM (urpmi) yes
7 puppy PET no
10 archlinux Pacman yes
13 slackware TXZ no
38 moblin RPM no
40 frugalware FPM (TAR.BZ2) no
41 pardus PiSi no
74 altlinux RPM (APT) yes
89 turbolinux RPM no
91 crux TAR.GZ no
96 linuxconsole LCM no
99 yoper RPM no

Package wrappers are regular services, so read the Service Developers Guide first.

service.info file

In addition to the standard service.info file, the wrappers' file contains the following:

  • Service section contains only
    • name
    • summary
    • description
    • homepage
  • It should contain one or more Distro:<name> sections
  • Distro: section with name *, describes common distro parameters.

Each Distro: section

  • should contain a name field which is a local package name for the service,
  • an optional buildtime-name field, which goes to the buildtime.xml feed, by default name will be used.
  • Applications could contain a main field with a full path to the exec file (which could be different for different distributions).

Workflow

  • Create a service.info file.
  • Add a Distro:* section with common distro parameters.
  • Add Distro:<name> sections, at least for sugar supported distributions.
  • Execute 0sugar push to upload changes to the server.
  • If a service's application is not well packaged, please consider the possibility of adding source and binary service implementations.

Known issues

  • In RO mode (check if some package is installed), 0install can work only with deb and rpm based distributions or, if PackageKit is installed, all distributions that current PackageKit version supports.
  • To install packages, the system should have PackageKit.
Retrieved from "https://wiki.sugarlabs.org/index.php?title=Documentation_Team/Obsolete/Services_Wrap_native_packages_HOWTO&oldid=80466"