Difference between revisions of "Packaging Standards"

From WebOS Internals
Jump to navigation Jump to search
(added DeviceNames as part of version 2.4)
Line 5: Line 5:
 
Note that a package record in a Packages file starts with the "Package:" field, and ends with an empty line.
 
Note that a package record in a Packages file starts with the "Package:" field, and ends with an empty line.
  
−
==[RFC] Version 2.3==
+
 
 +
 
 
''NOTE1: New fields are in bold red''
 
''NOTE1: New fields are in bold red''
  
 
''NOTE2: Modified fields are in bold black''
 
''NOTE2: Modified fields are in bold black''
 +
 +
 +
 +
==[RFC] Version 2.4==
 +
 +
 +
{|class="wikitable" height:200px" border="1"
 +
! width="140" | Name
 +
! width="350" | Definition
 +
|-
 +
| Package || Package name in reverse-dns style
 +
|-
 +
| Size || Package size (in KB)
 +
|-
 +
| Status || Installed/Not-installed (and other stuff we don't use)
 +
|-
 +
| Architecture || all, armv7, armv6 or i686
 +
|-
 +
| Section || The category when there is no source data
 +
|-
 +
| Filename || Actual name of .ipk file
 +
|-
 +
| Depends || Actual package names of dependencies (comma-space separated, ignore contents of () at the end)
 +
|-
 +
| Maintainer || Group or individual responsible for maintenance
 +
|-
 +
| Version || In N:N(.N)*(-N)? format (see ipkg source for the different version parts)
 +
|-
 +
| Description || Title of the package
 +
|-
 +
| MD5Sum || MD5 checksum of package to verify downloaded file
 +
|-
 +
| Installed-Time || Timestamp of installation
 +
|-
 +
| Installed-Size || Size of installed package
 +
|-
 +
| Source ||  *See lower table*
 +
|}
 +
 +
 +
 +
{| class="wikitable" border="1"
 +
| valign="top" | Source
 +
{| class="wikitable" width="200"; border="1"
 +
| Title || Actual title of application
 +
|-
 +
| Source || Where to obtain source code
 +
|-
 +
| LastUpdated || Timestamp of last update
 +
|-
 +
| Feed || Package source feed
 +
|-
 +
| Type || Application, Patch, Service, Plugin, Linux Application, etc. ...
 +
|-
 +
| Category || Package category
 +
|-
 +
| Homepage || URL to package homepage
 +
|-
 +
| Icon || URL to icon image (assumed to be 64x64)
 +
|-
 +
| FullDescription || Actual description of package (html is allowed). Maximum size is 4096 characters.
 +
|-
 +
| Changelog || A brief description of the changes made to since the last release.
 +
|-
 +
| Screenshots || Array of URLs
 +
|-
 +
| License || Package license conditions
 +
|-
 +
| Price || Price in dollars and cents (e.g. "1.99")
 +
|-
 +
| PostInstallFlags || RestartLuna, RestartJava, RestartDevice
 +
|-
 +
| PostUpdateFlags || RestartLuna, RestartJava, RestartDevice
 +
|-
 +
| PostRemoveFlags || RestartLuna, RestartJava, RestartDevice
 +
|-
 +
| WebOSVersions || JSON array of compatible webOS versions (ex. ["1.1.0","1.2.0"])
 +
|-
 +
| <font color=red>'''DeviceNames'''</font> || <font color=red>'''JSON array of compatible webOS devices (ex. ["Pre","Pixi"])'''</font>
 +
|}
 +
|-
 +
|}
 +
 +
 +
==Version 2.3==
  
  

Revision as of 05:09, 22 July 2010

Warning This page will document the agreed packaging standards for webOS homebrew ipkg files and open standard ipkg feeds as well as act as a whiteboard for new revisions.

Please note, ipkg/libipkg has an internal, hard coded buffer of 8k to handle parsing the feed elements for each package. This means that description fields need to get reduced in length to prevent segfaults.

Note that a package record in a Packages file starts with the "Package:" field, and ends with an empty line.


NOTE1: New fields are in bold red

NOTE2: Modified fields are in bold black


[RFC] Version 2.4

Name Definition
Package Package name in reverse-dns style
Size Package size (in KB)
Status Installed/Not-installed (and other stuff we don't use)
Architecture all, armv7, armv6 or i686
Section The category when there is no source data
Filename Actual name of .ipk file
Depends Actual package names of dependencies (comma-space separated, ignore contents of () at the end)
Maintainer Group or individual responsible for maintenance
Version In N:N(.N)*(-N)? format (see ipkg source for the different version parts)
Description Title of the package
MD5Sum MD5 checksum of package to verify downloaded file
Installed-Time Timestamp of installation
Installed-Size Size of installed package
Source *See lower table*


Source
Title Actual title of application
Source Where to obtain source code
LastUpdated Timestamp of last update
Feed Package source feed
Type Application, Patch, Service, Plugin, Linux Application, etc. ...
Category Package category
Homepage URL to package homepage
Icon URL to icon image (assumed to be 64x64)
FullDescription Actual description of package (html is allowed). Maximum size is 4096 characters.
Changelog A brief description of the changes made to since the last release.
Screenshots Array of URLs
License Package license conditions
Price Price in dollars and cents (e.g. "1.99")
PostInstallFlags RestartLuna, RestartJava, RestartDevice
PostUpdateFlags RestartLuna, RestartJava, RestartDevice
PostRemoveFlags RestartLuna, RestartJava, RestartDevice
WebOSVersions JSON array of compatible webOS versions (ex. ["1.1.0","1.2.0"])
DeviceNames JSON array of compatible webOS devices (ex. ["Pre","Pixi"])


Version 2.3

Name Definition
Package Package name in reverse-dns style
Size Package size (in KB)
Status Installed/Not-installed (and other stuff we don't use)
Architecture all, armv7, armv6 or i686
Section The category when there is no source data
Filename Actual name of .ipk file
Depends Actual package names of dependencies (comma-space separated, ignore contents of () at the end)
Maintainer Group or individual responsible for maintenance
Version In N:N(.N)*(-N)? format (see ipkg source for the different version parts)
Description Title of the package
MD5Sum MD5 checksum of package to verify downloaded file
Installed-Time Timestamp of installation
Installed-Size Size of installed package
Source *See lower table*


Source
Title Actual title of application
Source Where to obtain source code
LastUpdated Timestamp of last update
Feed Package source feed
Type Application, Patch, Service, Plugin, Linux Application, etc. ...
Category Package category
Homepage URL to package homepage
Icon URL to icon image (assumed to be 64x64)
FullDescription Actual description of package (html is allowed). Maximum size is 4096 characters.
Changelog A brief description of the changes made to since the last release.
Screenshots Array of URLs
License Package license conditions
Price Price in dollars and cents (e.g. "1.99")
PostInstallFlags RestartLuna, RestartJava, RestartDevice
PostUpdateFlags RestartLuna, RestartJava, RestartDevice
PostRemoveFlags RestartLuna, RestartJava, RestartDevice
WebOSVersions JSON array of compatible webOS versions (ex. ["1.1.0","1.2.0"])


Version 2.2

Name Definition
Package Package name in reverse-dns style
Size Package size (in KB)
Status Installed/Not-installed (and other stuff we don't use)
Architecture all, armv7, armv6, or i686
Section The category when there is no source data
Filename Actual name of .ipk file
Depends Actual package names of dependencies (comma-space separated, ignore contents of () at the end)
Maintainer Group or individual responsible for maintenance
Version In N:N(.N)*(-N)? format (see ipkg source for the different version parts)
Description Title of the package
MD5Sum MD5 checksum of package to verify downloaded file
Installed-Time Timestamp of installation
Installed-Size Size of installed package
Source *See lower table*


Source
Title Actual title of application
Source Where to obtain source code
LastUpdated Timestamp of last update
Feed Package source feed
Type Application, Patch, Service, Plugin, Linux Application, etc. ...
Category Package category
Homepage URL to package homepage
Icon URL to icon image (assumed to be 64x64)
FullDescription Actual description of package (html is allowed). Maximum size is 4096 characters.
Screenshots Array of URLs
License Package license conditions
Price Price in dollars and cents (e.g. "1.99")
PostInstallFlags RestartLuna, RestartJava, RestartDevice
PostUpdateFlags RestartLuna, RestartJava, RestartDevice
PostRemoveFlags RestartLuna, RestartJava, RestartDevice

Version 2.1

Name Definition
Package Package name in reverse-dns style
Size Package size (in KB)
Status Installed/Not-installed (and other stuff we don't use)
Architecture all, armv7, armv6, or i686
Section The category when there is no source data
Filename Actual name of .ipk file
Depends Actual package names of dependencies (comma-space separated, ignore contents of () at the end)
Maintainer Group or individual responsible for maintenance
Version In N:N(.N)*(-N)? format (see ipkg source for the different version parts)
Description Title of the package
MD5Sum MD5 checksum of package to verify downloaded file
Installed-Time Timestamp of installation
Installed-Size Size of installed package
Source *See lower table*


Source
Title Actual title of application
Source Where to obtain source code
LastUpdated Timestamp of last update
Feed Package source feed
Type Application, Patch, Service, Plugin, Linux Application, etc. ...
Category Package category
Homepage URL to package homepage
Icon URL to icon image (assumed to be 64x64)
FullDescription Actual description of package (includes html?)
Screenshots Array of URLs
License Package license conditions
PostInstallFlags RestartLuna, RestartJava
PostRemoveFlags RestartLuna, RestartJava
Retrieved from "http://wiki.webos-internals.org/index.php?title=Packaging_Standards&oldid=10566"