Line 1: |
Line 1: |
− | This guide describes how to use [[Platform_Team/Doers_environment|Doers environment]] for developing core modules. | + | This guide describes how to use Sugar Labs' Packaging Management System. See also [[Platform_Team/Sweets|introduction page]] and [[Platform_Team/Guide/Sweets_Packaging|Packaging guide]]. |
| | | |
− | == Requirements == | + | == Installation == |
| | | |
− | * Install PackageKit and PackageKit authentication agent from native packages. On Debian based systems, these packages are {{Code|packagekit}} and {{Code|packagekit-gnome}} (for Gnome Desktop Environment).
| + | === Required packages === |
− | * PackageKit authentication agent should be launched to let {{Code|sweets}} command install dependencies. Usually it is being started after being logged in to DE session (it isn't for Sugar session).
| |
− | * Download and launch [http://download.sugarlabs.org/packages/0sugar/sweets.sh self-extracted installer].
| |
− | * Installer will add {{Code|~/.local/bin}} directory to the {{Code|PATH}}. So, relogin from X session to take into account new {{Code|PATH}}.
| |
| | | |
− | == Clone the sources ==
| + | First, install PackageKit related packages. The following command will also install Polkit authentication agent for Gnome sessions (if you start sugar emulator from Gnome Desktop Environment). |
| | | |
− | To checkout sugar project sources: | + | {{Note/important|Important notes for XO users:|Some XO images might mount {{Code|/var/cache/yum}} to the tmpfs. With this limited cache capacity, it will be mostly impossible to install anything of large size from the Fedora repositories. To work around this limitation, become a {{Code|root}} user and enter the {{Code|umount /var/cache/yum}} command in the Terminal activity or a console. To persist this change for subsequent boots, remove the corresponding line from the {{Code|/etc/fstab}} file.}} |
| | | |
− | sweets --deep clone sugar | + | Fedora specific instructions: |
| + | sudo yum install gnome-packagekit |
| | | |
− | Where {{Code|--deep}} says {{Code|sweets}} process all dependencies.
| + | Debian and Ubuntu (starting from 11.10) based distributions specific instructions: |
| | | |
− | Each project will be placed to to default {{Code|~/sweets}} directory. These are regular sources clones with one exception, each project contains [[Platform Team/Recipe Specification|sweets.recipe]] spec file.
| + | sudo apt-get install gnome-packagekit |
− | Projects might be cloned in regular way, {{Code|sweets clone}} is just a convenient method since some of projects are gitorious forks.
| |
| | | |
− | == Launch sugar ==
| + | Ubuntu (before 11.10) based distributions specific instructions: |
| | | |
− | To launch sugar session:
| + | sudo apt-get install packagekit-gnome |
| | | |
− | sweets sugar
| + | After installing PackageKit, you need to restart the DBus system bus. The easiest way is to just restart the machine. |
| | | |
− | or to run from Xephyr:
| + | === Install === |
| | | |
− | sweets sugar:emulator
| + | Enter in the Terminal activity, or any other terminal: |
| | | |
− | During the first launch, sources will be build. To rebuild them at any time:
| + | wget http://download.sugarlabs.org/sweets/sweets/installer.sh |
| + | sh installer.sh |
| | | |
− | sweets -ff make ''sweet''
| + | Relogin from X session to take into account the new PATH environment variable value. |
| | | |
− | === Run sweets from X session ===
| + | Alternatively, {{Code|sweets}} might be run from the [[Platform_Team/Guide/Sweets_Packaging#Run_Sweets_from_sources|sources]]. |
| | | |
− | Place sweets invocation to {{Code|~/.xsession}} file:
| + | === Upgrade === |
| | | |
− | PATH=$HOME/.local/bin:$PATH
| + | Enter in the Terminal activity, or any other terminal: |
− | sweets sugar
| |
| | | |
− | and create {{Code|/usr/share/xsessions/sweets.desktop}} desktop file: | + | sweets upgrade |
| + | |
| + | == Usage == |
| + | |
| + | Read the [[Platform_Team/Sweets/Glossary|Sweets Glossary]] to understand the basic concept (and [[Platform_Team/Infrastructure|overview]] of the bigger picture). The rest of the text will operate with the following terms: |
| + | |
| + | * {{Code|''SWEET''}}, the full ''interface'' URL, like {{Code|http://sweets.sugarlabs.org/sdk/sugar}}, or the short one, like {{Code|sdk/sugar}}; |
| + | * {{Code|''COMMAND''}}, ''sweet'''s command that indicates how to run a particular ''sweet''; by default, ''sweet''s have only the {{Code|run}} command, but it is possible to have several commands; |
| + | * {{Code|''VERSION''}}, ''sweet'''s version |
| + | |
| + | See the [[Platform_Team/Guide/Sugar_via_Sweets|Sugar via Sweets]] guide for real examples of how to use ''Sweets'' to run Sugar Shell. |
| + | |
| + | === Launch === |
| + | |
| + | To launch a ''sweet'' with verbatim passing of optional {{Code|ARGUMENTS}}: |
| + | |
| + | sweets ''<SWEET>'' [''<ARGUMENTS>''] |
| + | |
| + | Sometimes ''sweet''s support several launching commands; it is possible to specify one during the launch: |
| + | |
| + | sweets ''<SWEET>'':''<COMMAND>'' |
| + | |
| + | To run a particular, but not the latest, version: |
| + | |
| + | sweets ''<SWEET>'' ''=''|''>=''|''<='' ''<VERSION>'' |
| + | |
| + | To get the full list of available versions: |
| + | |
| + | sweets status ''<SWEET>'' -v |
| + | |
| + | To get information, e.g., a list of supported commands, about a ''sweet'': |
| + | |
| + | sweets show ''<SWEET>'' |
| + | |
| + | === Troubleshooting === |
| + | |
| + | After getting any unpredictable Sweets behaviour, read the following notes. |
| + | |
| + | '''Keep feeds up-to-date''' |
| + | |
| + | ''Feeds'' are being updated from time to time. After experiencing any problems, and for refreshing the local ''feeds'' cache, it will be useful to re-download ''feeds''. Use, once, the {{Code|-R}} command line argument for the launch command (make sure that {{Code|-R}} goes before the {{Code|SWEET}}, because using it afterwards will cause passing it as a {{Code|SWEET}}'s argument): |
| + | |
| + | sweets -R ''<SWEET>'' |
| + | |
| + | '''Analyze dependencies tree''' |
| | | |
− | [Desktop Entry]
| + | If {{Code|sweets}} can't find a proper ''implementation'', see the {{Code|e}} lines in the output of: |
− | Encoding=UTF-8
| |
− | Name=Sweets
| |
− | GenericName=Sweets
| |
− | Exec=/etc/X11/Xsession
| |
− | Type=Application
| |
| | | |
− | == Develop ==
| + | sweets status ''<SWEET>'' -vdd |
| | | |
− | Cloned projects will be built according to {{Code|[Build]}} section commands in recipe files. In general, for autotools based projects, there is no further need in {{Code|sweets}} command, just run {{Code|make install}} to build current sources and copy them to the directory that was specified by {{Code|sweets}} on configure stage.
| + | '''Keep the system in consistent state''' |
| | | |
− | For glucose projects, there is no need even in calling {{Code|make}} command, python code will be reused from original place (see {{Code|binding}} options in recipe files), change the code and restart sugar.
| + | Asking Sweets to launch a sweets might mean installing new packages via PackageKit. In most cases, PackageKit can handle possible issues with native packages and, at worst, will fail as well, in order to stop any further Sweets operations. Nevertheless, it can be useful to keep unbroken native packages. |
| | | |
− | For activities, follow regular activity developing procedure - clone them to {{Code|~/Activities}} directory and run from sugar shell.
| + | === Search === |
| | | |
− | == Upgrade ==
| + | It is possible to search ''sweet''s among locally known ones and those registered on http://sweets.sugarlabs.org (not yet implemented). The search is based on the [http://xapian.org/ Xapian] search engine. Thus, it is possible to use Xapian's [http://xapian.org/docs/queryparser.html query language]. |
| | | |
− | To upgrade sweets to the recent version:
| + | For command format is: |
| | | |
− | sweets upgrade | + | sweets search ''<QUERY>'' |
| + | |
| + | Notice that [http://xapian.org/docs/queryparser.html#partially-entered-query-matching partial] search is enabled. So, the query {{Code|tele}} will be treated as {{Code|tele*}} to search all words that start from {{Code|tele}}. |
| + | |
| + | {{Code|sweets}} supports the following search [http://xapian.org/docs/queryparser.html#searching-within-a-probabilistic-field prefixes] based on [[Platform_Team/Recipe_Specification|recipe options]]: |
| + | |
| + | * '''interface''' the first interface from the implementations list, e.g., {{Code|http://sweets.sugarlabs.org/sdk/sugar}}; |
| + | * '''sweet''' the first interface from the implementations list in short Sweets notations, e.g., {{Code|sdk/sugar}}; |
| + | * '''implement''' the list of implemented interfaces; |
| + | * '''associate''' the list of associated interfaces; |
| + | * '''name''' the short name of a sweet; |
| + | * '''summary''' sweet's summary; |
| + | * '''description''' long sweet's description; |
| + | * '''category''' list of category names; |
| + | * '''license''' list of licenses; |
| + | * '''type''' sweet's type, which might be {{Code|library}}, {{Code|application}} or {{Code|activity}}; |
| + | * '''keep''' if activity, that a sweet is representing, is favorited; |
| + | * '''tags''' the list of sweet's tags; |
| + | * '''mime_types''' the list of activity MIME types, that a sweet is representing or supports. |
| + | |
| + | So, it is possible to search only among particular sweet attributes, like {{Code|name:telepathy}} to search only among particular sweet names. |
| + | |
| + | {{Code|sweets}} support additional notation for exact searching in the form of {{Code|''prefix''<nowiki>:=</nowiki>''string''}}. For example the query {{Code|name<nowiki>:=</nowiki>sugar}} will find ''sweet''s only with exactly {{Code|sugar}} as a name and omit names like {{Code|sugar-base}}. If the search string contains spaces, wrap it within double quotes, {{Code|name<nowiki>:=</nowiki>"Sugar Commander"}}. Note, wildcards do not work in the exact search case where asterisks will be treated literally. |
| | | |
| == Current limitations == | | == Current limitations == |
| | | |
− | * Glucose needs to be patched, thus these are gitorious forks.
| + | * For now, {{Code|sweets}} knows only enough about the glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE. |
− | * Packages cannot be build from sources without cloning
| |
− | * For now, {{Code|sweets}} knowns only about glucose dependencies to install them from native packages in Debian, Ubuntu, Fedora, Mandriva, openSUSE and Gentoo. | |
| * Activities can't reuse sweets benefits. | | * Activities can't reuse sweets benefits. |
| + | |
| + | == Feedback == |
| + | |
| + | {{:Platform_Team/Sweets/Feedback}} |