MeeGo wiki - User contributions [en]

Obstag

2012-06-12T13:26:00Z

Fvennetier: Replaced content with "OBS Light has moved! It's now located at openSUSE: [http://en.opensuse.org/openSUSE:OBS_Light_Obstag http://en.opensuse.org/openSUSE:OBS_Light_Obstag]"

OBS Light has moved! It's now located at openSUSE:
[http://en.opensuse.org/openSUSE:OBS_Light_Obstag http://en.opensuse.org/openSUSE:OBS_Light_Obstag]

OBS Light Manual

2012-06-12T12:34:48Z

Fvennetier: Replaced content with "OBS Light has moved! It's now located at openSUSE: [http://en.opensuse.org/openSUSE:OBS_Light_Manual http://en.opensuse.org/openSUSE:OBS_Light_Manual]"

OBS Light has moved! It's now located at openSUSE:
[http://en.opensuse.org/openSUSE:OBS_Light_Manual http://en.opensuse.org/openSUSE:OBS_Light_Manual]

OBS Light FAQ

2012-06-12T12:33:57Z

Fvennetier: Replaced content with "OBS Light has moved! It's now located at openSUSE: [http://en.opensuse.org/openSUSE:OBS_Light_FAQ http://en.opensuse.org/openSUSE:OBS_Light_FAQ]"

OBS Light has moved! It's now located at openSUSE:
[http://en.opensuse.org/openSUSE:OBS_Light_FAQ http://en.opensuse.org/openSUSE:OBS_Light_FAQ]

OBS Light Installation

2012-06-12T12:33:10Z

Fvennetier: Replaced content with "OBS Light has moved! It's now located at openSUSE: [http://en.opensuse.org/openSUSE:OBS_Light_Installation http://en.opensuse.org/openSUSE:OBS_Light_Installation]"

OBS Light has moved! It's now located at openSUSE:
[http://en.opensuse.org/openSUSE:OBS_Light_Installation http://en.opensuse.org/openSUSE:OBS_Light_Installation]

OBS Light

2012-06-12T12:31:36Z

Fvennetier:

OBS Light has moved! It's now located at openSUSE:
[http://en.opensuse.org/openSUSE:OBS_Light http://en.opensuse.org/openSUSE:OBS_Light]

OBS Light

2012-06-12T12:21:08Z

Fvennetier: Replaced content with "#REDIRECT [http://en.opensuse.org/openSUSE:OBS_Light]"

#REDIRECT [http://en.opensuse.org/openSUSE:OBS_Light]

OBS Light FAQ

2012-05-31T16:59:37Z

Fvennetier:

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

Each OBS project has its own directory in '''~/OBSLight/ObsProjects/''', each MIC project has its own directory in '''~/OBSLight/MicProjects/'''.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/ObslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running, there is a button under the progress bar.
* A log file is written in <tt>~/OBSLight/obslight.log</tt>.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the project filesystem? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your project filesystem's zypper configuration, you have two choices:
* First one, use an URL and an alias:
## obslight filesystem repositories add <repository_url> <repository_alias> <project_alias>
obslight filesystem repositories add http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ MeeGo_non-oss MeeGo_1.2_oss
* Second one, add the repository of another local project:
## obslight filesystem repositories add from <source_project_alias> <project_alias>
obslight filesystem repositories add from MeeGo_1.2_non-oss MeeGo_1.2_oss

== How to create a new package ? (from an existing SPEC file) ==
=== Requirements ===
* A project on an OBS server (public or [http://susestudio.com/a/e0uuBG/meego-obs private]) where you have maintainer rights (for example your home project), and with a [http://en.opensuse.org/openSUSE:Build_Service_Tutorial#Step_Three.C2.A0.E2.80.93_Choose_build_targets build target] already configured.
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK).
* A valid SPEC file, named <tt>program.spec</tt>.

=== Procedure ===
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI or ''osc'' first.
# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button (on the left-bottom).
#* Select a server from the list or configure a new one.
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project without "''':'''", we suggest suffixing with the architecture).
#* You should now see a list of packages, with the one you created in web UI.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken'' (because it has no files).
#* In the right panel, select tab ''Local directory'', click ''Import file''.
#* Select your SPEC file and archive (and YAML file if you have one).
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded, and the package starts to build on the OBS server.

== How to prepare a Spec file using Spectacle ? ==
*Official documentation: [[Spectacle]]
*Why using Spectacle: [[Packaging/Guidelines#Writing_a_package_from_scratch]]

=== Generate a YAML file from scratch ===
==== Manually ====
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file. Just replace "<tt>^^^</tt>" occurrences by which seems appropriate, and got to the [[#Customize_the_Spec_and_YAML_files | Spec and YAML customization section]].

==== Automatically ====
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle] can analyze source archives and generate an appropriate YAML file, but has no documentation.

=== Generate a YAML file from a Spec file ===
If you already have a Spec file for your program, you may still want to create a YAML file in order to standardize or simplify it. Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file. Notice that the conversion is not perfect, and you may lost information.

=== Customize the Spec and YAML files ===
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml
Complete list of Spectacle options is here: [[Spectacle#Syntax_of_spectacle_YAML | Syntax of spectacle YAML]]

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

== Help I have updated and broken my OBS server appliance ==
The move to OBS 2.3 seems to be far less transparent that it should.
But the facilities offered by the V 2.3 are valuable and move to it is worthwhile. 
You will find here how I did it, it might work for you but it is without guaranty.
'''Do a snapshot of your appliance before starting'''. 
[[HowTo upgrade from OBS server 2.2 to 2.3]]

== How to add swap in OBS appliance ? ==
Connect as root, and run:
# Swap size in kilobytes
SWAPSIZE=524288
# Location of swap file
SWAPFILE=/swapfile

dd if=/dev/zero of=$SWAPFILE bs=1k count=$SWAPSIZE
chmod 600 $SWAPFILE
mkswap -f $SWAPFILE $SWAPSIZE
swapon -v $SWAPFILE
If you want it to persist after reboot, add the following to /etc/fstab:
/swapfile swap swap defaults 0 0

= Links =
* [[OBS_Light | OBS Light main page]]
* [[OBS_Light_Installation | OBS Light installation]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-05-31T10:32:58Z

Fvennetier: /* For Ubuntu */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
To install ''obslight'':
# Add MeeGo tools repository, to get MIC
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
# Add OBS Light repository
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

# Refresh package database
zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
zypper in obslight

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface

# Add MeeGo tools repository, to get MIC
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
# Add OBS Light repository
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" | sudo tee -a "/etc/zypp/repos.d/Project_OBS_Light.repo" > /dev/null
echo "gpgcheck=0" | sudo tee -a "/etc/zypp/repos.d/tizen_tools.repo" > /dev/null

# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
sudo zypper in obslight

To install the GUI, you will need PySide:
sudo zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo
sudo zypper --gpg-auto-import-keys ref
sudo zypper in obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''', '''11.10''' and '''12.04'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./

# Ubuntu 11.10
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./

# Ubuntu 12.04
## MIC and dependencies
deb http://download.tizen.org/tools/xUbuntu_12.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_12.04/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Migration from old versions =
== OBS Light < 0.4.22 ==
Starting from OBS Light 0.4.22, MIC and its dependencies won't be maintained in OBS Light's repositories anymore. You will have to add official MIC repository to get MIC dependencies. Just remove the old repository and follow the appropriate procedure. Fedora users can keep using old repositories.
=== openSUSE 11.4 ===
sudo zypper rr Project_OBS_Light
and [[#For OpenSUSE 11.4]]
=== openSUSE 12.1 ===
sudo zypper rr Project_OBS_Light_openSUSE_12.1
and [[#For_OpenSUSE_12.1]]
=== Ubuntu ===
sudo rm /etc/apt/sources.list.d/obslight.list
and [[#For Ubuntu]].

== OBS Light appliance < 0.4.52 ==
If you are using [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance] older than 0.4.52, and you don't want to download the latest version, you can update it doing the following:
# Remove old openSUSE 12.1 specific OBS Light repository
sudo zypper rr Project_OBS_Light_openSUSE_12.1
# Add Tizen Tools and OBS Light repositories
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Update MIC and OBS Light
sudo zypper up mic obslight obslight-gui
(same procedure as [[#For_openSUSE_12.1 | for openSUSE 12.1]])

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Manual

2012-04-12T13:51:31Z

Fvennetier: /* Testing */

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

On the left panel you can see a list of MIC projects. Click ''New'' to add one, you will be asked for a name, and an empty Kickstart file will be created.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

In this tab you can:
* change the generated image type
** ''fs'': a directory hierarchy containing the whole filesystem
** ''livecd'': a bootable image suitable for a CD
** ''liveusb'': a bootable image suitable for a USB key
** ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'')
** ''raw''
* change the architecture of the project (only i686 has been tested)
* open the directory of the project (with you default file browser)
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

In this tab you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

== <tt>"sudo: sorry, you must have a tty to run sudo"</tt> ==
This message may appear in logs if the '''requiretty''' option is set in sudo configuration file. Edit ''/etc/sudoers'' and comment out the following line:
Defaults requiretty

= Internals =
== ObsLight GUI ==
[[File: ObsLightGui_class_diagram.png|link=http://wiki.meego.com/images/ObsLightGui_class_diagram.png|OBS Light GUI class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/ObsLightGui_class_diagram.dia Dia source file]

== ObsLight command line ==
[[File: Doc_ObsLightCommandLine_class_diagram.png|link=http://wiki.meego.com/File:Doc_ObsLightCommandLine_class_diagram.png|OBS Light command line class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/Doc_ObsLightCommandLine_class_diagram.dia Dia source file]

== ObsLight API Manager ==
[[File: Doc_ObsLight_API_Manager_class_diagram.png|link=http://wiki.meego.com/File:Doc_ObsLight_API_Manager_class_diagram.png|OBS Light API Manager class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/Doc_ObsLight_API_Manager_class_diagram.dia Dia source file]

= Testing =
== Infrastructure ==
You can find in [https://meego.gitorious.org/meego-developer-tools/obs-light OBS Light Git repository] some configuration files for [http://vagrantup.com/ Vagrant] and [https://github.com/jedi4ever/veewee Veewee]. Using them, you can build reference virtual machines (Fedora 16, openSUSE 12.1 and Ubuntu 11.10) and run test suites on them.
# Make a copy of a base virtual machine
# Copy test script and associated files in a shared folder
# Run virtual machine
# Run test script inside virtual machine with SSH
# Get results from shared folder
# Destroy (or just stop in case of failure) virtual machine
The complete procedure is explained in a [https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/test/veewee/README README].

== Test scenarios ==
Currently we provide only one test scenario:
# install OBS Light
# configure a server
# import a project
# create project filesystem
# import some packages (vim, tzdata, fastinit)
# execute preparation step of these packages
# build the RPMs of these packages
This scenario is implemented in a shell script, available [https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/test/update_and_run_tests.sh here].

OBS Light Manual

2012-04-12T08:07:59Z

Fvennetier:

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

On the left panel you can see a list of MIC projects. Click ''New'' to add one, you will be asked for a name, and an empty Kickstart file will be created.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

In this tab you can:
* change the generated image type
** ''fs'': a directory hierarchy containing the whole filesystem
** ''livecd'': a bootable image suitable for a CD
** ''liveusb'': a bootable image suitable for a USB key
** ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'')
** ''raw''
* change the architecture of the project (only i686 has been tested)
* open the directory of the project (with you default file browser)
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

In this tab you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

== <tt>"sudo: sorry, you must have a tty to run sudo"</tt> ==
This message may appear in logs if the '''requiretty''' option is set in sudo configuration file. Edit ''/etc/sudoers'' and comment out the following line:
Defaults requiretty

= Internals =
== ObsLight GUI ==
[[File: ObsLightGui_class_diagram.png|link=http://wiki.meego.com/images/ObsLightGui_class_diagram.png|OBS Light GUI class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/ObsLightGui_class_diagram.dia Dia source file]

== ObsLight command line ==
[[File: Doc_ObsLightCommandLine_class_diagram.png|link=http://wiki.meego.com/File:Doc_ObsLightCommandLine_class_diagram.png|OBS Light command line class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/Doc_ObsLightCommandLine_class_diagram.dia Dia source file]

== ObsLight API Manager ==
[[File: Doc_ObsLight_API_Manager_class_diagram.png|link=http://wiki.meego.com/File:Doc_ObsLight_API_Manager_class_diagram.png|OBS Light API Manager class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/dia_Resource/Doc_ObsLight_API_Manager_class_diagram.dia Dia source file]

= Testing =
== Infrastructure ==
You can find in [https://meego.gitorious.org/meego-developer-tools/obs-light OBS Light Git repository] some configuration files for [http://vagrantup.com/ Vagrant] and [https://github.com/jedi4ever/veewee Veewee]. Using them, you can build reference virtual machines (Fedora 16, openSUSE 12.1 and Ubuntu 11.10) and run test suites on them. The procedure is explained in a [https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/test/veewee/README README].

== Scenanios ==
Currently we provide only one test scenario:
# install OBS Light
# configure a server
# import a project
# create project filesystem
# import some packages (vim, tzdata, fastinit)
# execute preparation step of these packages
# build the RPMs of these packages
This scenario is implemented in a shell script, available [https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/test/update_and_run_tests.sh here].

OBS Light Installation

2012-04-05T12:28:37Z

Fvennetier: /* For OpenSUSE 12.1 */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
To install ''obslight'':
# Add MeeGo tools repository, to get MIC
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
# Add OBS Light repository
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

# Refresh package database
zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
zypper in obslight

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface

# Add MeeGo tools repository, to get MIC
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
# Add OBS Light repository
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" | sudo tee -a "/etc/zypp/repos.d/Project_OBS_Light.repo" > /dev/null
echo "gpgcheck=0" | sudo tee -a "/etc/zypp/repos.d/tizen_tools.repo" > /dev/null

# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
sudo zypper in obslight

To install the GUI, you will need PySide:
sudo zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo
sudo zypper --gpg-auto-import-keys ref
sudo zypper in obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./

# Ubuntu 11.10
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Migration from old versions =
== OBS Light < 0.4.22 ==
Starting from OBS Light 0.4.22, MIC and its dependencies won't be maintained in OBS Light's repositories anymore. You will have to add official MIC repository to get MIC dependencies. Just remove the old repository and follow the appropriate procedure. Fedora users can keep using old repositories.
=== openSUSE 11.4 ===
sudo zypper rr Project_OBS_Light
and [[#For OpenSUSE 11.4]]
=== openSUSE 12.1 ===
sudo zypper rr Project_OBS_Light_openSUSE_12.1
and [[#For_OpenSUSE_12.1]]
=== Ubuntu ===
sudo rm /etc/apt/sources.list.d/obslight.list
and [[#For Ubuntu]].

== OBS Light appliance < 0.4.52 ==
If you are using [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance] older than 0.4.52, and you don't want to download the latest version, you can update it doing the following:
# Remove old openSUSE 12.1 specific OBS Light repository
sudo zypper rr Project_OBS_Light_openSUSE_12.1
# Add Tizen Tools and OBS Light repositories
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Update MIC and OBS Light
sudo zypper up mic obslight obslight-gui
(same procedure as [[#For_openSUSE_12.1 | for openSUSE 12.1]])

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-04-05T12:24:19Z

Fvennetier: /* For OpenSUSE 12.1 */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
To install ''obslight'':
# Add MeeGo tools repository, to get MIC
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
# Add OBS Light repository
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

# Refresh package database
zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
zypper in obslight

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface

# Add MeeGo tools repository, to get MIC
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
# Add OBS Light repository
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> "/etc/zypp/repos.d/Project_OBS_Light.repo"
echo "gpgcheck=0" >> "/etc/zypp/repos.d/tizen_tools.repo"

# Refresh package database
zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
zypper in obslight-gui

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./

# Ubuntu 11.10
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Migration from old versions =
== OBS Light < 0.4.22 ==
Starting from OBS Light 0.4.22, MIC and its dependencies won't be maintained in OBS Light's repositories anymore. You will have to add official MIC repository to get MIC dependencies. Just remove the old repository and follow the appropriate procedure. Fedora users can keep using old repositories.
=== openSUSE 11.4 ===
sudo zypper rr Project_OBS_Light
and [[#For OpenSUSE 11.4]]
=== openSUSE 12.1 ===
sudo zypper rr Project_OBS_Light_openSUSE_12.1
and [[#For_OpenSUSE_12.1]]
=== Ubuntu ===
sudo rm /etc/apt/sources.list.d/obslight.list
and [[#For Ubuntu]].

== OBS Light appliance < 0.4.52 ==
If you are using [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance] older than 0.4.52, and you don't want to download the latest version, you can update it doing the following:
# Remove old openSUSE 12.1 specific OBS Light repository
sudo zypper rr Project_OBS_Light_openSUSE_12.1
# Add Tizen Tools and OBS Light repositories
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Update MIC and OBS Light
sudo zypper up mic obslight obslight-gui
(same procedure as [[#For_openSUSE_12.1 | for openSUSE 12.1]])

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-04-04T15:17:30Z

Fvennetier: /* Packaged versions */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
To install ''obslight'':
# Add MeeGo tools repository, to get MIC
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
# Add OBS Light repository
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

# Refresh package database
zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
zypper in obslight

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface

# Add MeeGo tools repository, to get MIC
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
# Add OBS Light repository
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> "/etc/zypp/repos.d/Project_OBS_Light.repo"

# Refresh package database
zypper --gpg-auto-import-keys ref
# Install OBS Light (without GUI)
zypper in obslight-gui

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./

# Ubuntu 11.10
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Migration from old versions =
== OBS Light < 0.4.22 ==
Starting from OBS Light 0.4.22, MIC and its dependencies won't be maintained in OBS Light's repositories anymore. You will have to add official MIC repository to get MIC dependencies. Just remove the old repository and follow the appropriate procedure. Fedora users can keep using old repositories.
=== openSUSE 11.4 ===
sudo zypper rr Project_OBS_Light
and [[#For OpenSUSE 11.4]]
=== openSUSE 12.1 ===
sudo zypper rr Project_OBS_Light_openSUSE_12.1
and [[#For_OpenSUSE_12.1]]
=== Ubuntu ===
sudo rm /etc/apt/sources.list.d/obslight.list
and [[#For Ubuntu]].

== OBS Light appliance < 0.4.52 ==
If you are using [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance] older than 0.4.52, and you don't want to download the latest version, you can update it doing the following:
# Remove old openSUSE 12.1 specific OBS Light repository
sudo zypper rr Project_OBS_Light_openSUSE_12.1
# Add Tizen Tools and OBS Light repositories
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Update MIC and OBS Light
sudo zypper up mic obslight obslight-gui
(same procedure as [[#For_openSUSE_12.1 | for openSUSE 12.1]])

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-04-02T11:45:28Z

Fvennetier: Changed ObsLightDeliverable -> OBS Light Installation

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

Each OBS project has its own directory in '''~/OBSLight/ObsProjects/''', each MIC project has its own directory in '''~/OBSLight/MicProjects/'''.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/ObslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running, there is a button under the progress bar.
* A log file is written in <tt>~/OBSLight/obslight.log</tt>.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the project filesystem? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your project filesystem's zypper configuration, you have two choices:
* First one, use an URL and an alias:
## obslight filesystem repositories add <repository_url> <repository_alias> <project_alias>
obslight filesystem repositories add http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ MeeGo_non-oss MeeGo_1.2_oss
* Second one, add the repository of another local project:
## obslight filesystem repositories add from <source_project_alias> <project_alias>
obslight filesystem repositories add from MeeGo_1.2_non-oss MeeGo_1.2_oss

== How to create a new package ? (from an existing SPEC file) ==
=== Requirements ===
* A project on an OBS server (public or [http://susestudio.com/a/e0uuBG/meego-obs private]) where you have maintainer rights (for example your home project), and with a [http://en.opensuse.org/openSUSE:Build_Service_Tutorial#Step_Three.C2.A0.E2.80.93_Choose_build_targets build target] already configured.
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK).
* A valid SPEC file, named <tt>program.spec</tt>.

=== Procedure ===
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI or ''osc'' first.
# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button (on the left-bottom).
#* Select a server from the list or configure a new one.
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project without "''':'''", we suggest suffixing with the architecture).
#* You should now see a list of packages, with the one you created in web UI.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken'' (because it has no files).
#* In the right panel, select tab ''Local directory'', click ''Import file''.
#* Select your SPEC file and archive (and YAML file if you have one).
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded, and the package starts to build on the OBS server.

== How to prepare a Spec file using Spectacle ? ==
*Official documentation: [[Spectacle]]
*Why using Spectacle: [[Packaging/Guidelines#Writing_a_package_from_scratch]]

=== Generate a YAML file from scratch ===
==== Manually ====
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file. Just replace "<tt>^^^</tt>" occurrences by which seems appropriate, and got to the [[#Customize_the_Spec_and_YAML_files | Spec and YAML customization section]].

==== Automatically ====
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle] can analyze source archives and generate an appropriate YAML file, but has no documentation.

=== Generate a YAML file from a Spec file ===
If you already have a Spec file for your program, you may still want to create a YAML file in order to standardize or simplify it. Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file. Notice that the conversion is not perfect, and you may lost information.

=== Customize the Spec and YAML files ===
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml
Complete list of Spectacle options is here: [[Spectacle#Syntax_of_spectacle_YAML | Syntax of spectacle YAML]]

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[OBS_Light_Installation | OBS Light installation]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light

2012-04-02T11:42:23Z

Fvennetier: Changed ObsLightDeliverable -> OBS Light Installation

[[File:OBSLightWiki.png‎ ]]
[http://blynt.canalblog.com/ Blynt]

= Why should I use OBS Light ?=
* I want to create a [https://meego.com/ MeeGo-based] distribution for my target ([https://meego.com/devices/smart-tv Smart TV], [https://meego.com/devices/in-vehicle In-Vehicle], [https://meego.com/devices/media-phone Media phone], [https://meego.com/devices/netbook Netbook], [https://meego.com/devices/handset Handset] ...).
* I want to include private code into my [https://meego.com/ MeeGo-based] distribution.
* I want to be fast from the beginning of my project to the first boot of my target.
* I want to use the same tools throughout my development cycle.

= Why not use OBS Light ?=
OBS Light is targeting the development of variants of MeeGo distribution (or any OBS build distro) to either add extra features to a MeeGo product or adapt a MeeGo distribution to different hardware configurations.
It is not an another SDK, if you want to develop applications for a MeeGo product you should have a look at the [https://meego.com/developers MeeGo SDK] which likely will better fit your need.

= What is OBS Light ?=
The project 'OBS Light' (or also obslight) , creates an encapsulation of OBS which presents a lighter face of OBS that we have called OBS light which could be delivered (if desired) with a pre-packaged MeeGo TV stack (or any other MeeGo vertical) released on a DVD image. The name was chosen to express that it remains an OBS base development process, but which is lighter to use, the idea of seeing the project as a light to guide the user in the flow of tools such as OBS, OSC, MIC, ... only came later. Once you will also see it incorrectly spell as 'OBS Lite'.

If you have (or are thinking about) selecting MeeGo but you cannot put all the code you want to build on OBS, the public, cloud-based MeeGo building tool, or if you are more comfortable with the tradition of local build tools based on a chroot than with a full cloud-based system like OBS, you might find the learning curve a bit steep.

While OBS will provide you with a very powerful and adapted tool for your long-term needs, the entry cost can be perceived to be too high.
This issue is particularly strongly perceived in the TV or IVI segments where recompilation of the Linux kernel and adding drivers is required even during the very early phases of a project and compiling in the public domain is out of the question.

In a second phase we hope to add a simple UI to it. It reuses the osc command line tools delivered with OBS to which a set of extra plugins have been added, including an extension of mic. All this remains compatible with a full implementation of OBS. It will be published under License: GPLv2.

The osc plugin for automatic patch creation are designed to be reusable in a full OBS environment.

The coding is under work and changes are likely to occur during the development process.

Note that under the hood, OBS light still is 100% OBS code and the building process is the same as what you could achieve by running your own private OBS.
OBS Light mainly pre-configures an OBS with a few osc plugins to ease the learning curve.

Note that some OBS feature are hidden to simplify the learning phase. As the service is run locally, you can mix Open Source and private code should you need to do so.

= How to test or use OBS Light? =
You can find a OBS Light appliance, build in [http://susestudio.com suse studio]:
http://susestudio.com/a/e0uuBG/meego-obs-light

* uptodate Build for various distros can be found in the [[OBS Light Installation]] page.

* Videos training and intro [http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training Starting with OBS Light]

= Where is the information about OBS Light? =
* [[OBS_Light_Manual | OBS Light manual]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* You can file bugs on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla]. The bug list for the project can be reached [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light here]. To easily file a new bug, use [https://bugs.meego.com/enter_bug.cgi?product=Development%20Tools this link]

All discussions are run on the MeeGo-distribution-tools mailing list.
http://lists.meego.com/listinfo/meego-distribution-tools

= Where can I find a private OBS appliance? =
You can find a OBS appliance, build in [http://susestudio.com suse studio]:
http://susegallery.com/a/e0uuBG/meego-obs

For more information about private OBS: http://en.opensuse.org/openSUSE:Build_Service_private_instance

You can Download the boot strap of Meego 1.2.0 here (saveOBS.tar.aa -> saveOBS.tar.ba).
http://www.cc-e.co.uk/Meego/MeeGo-1.2.0/
reassembled the file
cat saveOBS.tar.?? >> saveOBS.tar.gz
Thanks to Julien Snell and Cocom for the ftp server.
http://www.cc-e.co.uk

= What difference between OBS and OBS Light? =
OBS Light use an OBS server.
{|
| || '''OBS Light''' || '''Full OBS'''
|-
| Cross compilation || Yes || Yes
|-
| Local and remote reference || Yes || Yes
|-
| Automatic creation of patch || Yes || Not Yet (will if the same osc plugin is loaded)
|-
| Bootable Image creation || Yes || Add on
|-
| Integrated version control || Hidden || Yes
|-
| Multi-user || Hidden || Yes
|-
| Multi-target by project || Hidden || Yes
|-
| Auto built || Hidden || Yes
|-
| Signing service || Hidden || Yes
|}

Initial Specifications (final implementation have differed from the initial concept) :[[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/SpecOBSLight-1_V-0-6.pdf SpecOBSLight-1_V-0-6]]

= Where is the OBS Light code? =
GIT: https://meego.gitorious.org/meego-developer-tools/obs-light

OBS: https://build.pub.meego.com/project/show?project=Project%3AOBS_Light

ObsLightDeliverable

2012-04-02T11:39:30Z

Fvennetier: moved ObsLightDeliverable to OBS Light Installation: New title is more understandable.

#REDIRECT [[OBS Light Installation]]

OBS Light Installation

2012-04-02T11:39:30Z

Fvennetier: moved ObsLightDeliverable to OBS Light Installation: New title is more understandable.

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
You will also need MIC, which is hosted [http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/ here].
To install ''obslight'':
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

zypper --gpg-auto-import-keys ref
zypper in obslight
To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
You will also need MIC, which is hosted [http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ here].
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo

optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> "/etc/zypp/repos.d/Project_OBS_Light.repo"

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo

zypper --gpg-auto-import-keys ref
zypper in obslight obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./

# Ubuntu 11.10
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Migration from old versions =
== OBS Light < 0.4.22 ==
Starting from OBS Light 0.4.22, MIC and its dependencies won't be maintained in OBS Light's repositories anymore. You will have to add official MIC repository to get MIC dependencies. Just remove the old repository and follow the appropriate procedure. Fedora users can keep using old repositories.
=== openSUSE 11.4 ===
sudo zypper rr Project_OBS_Light
and [[#For OpenSUSE 11.4]]
=== openSUSE 12.1 ===
sudo zypper rr Project_OBS_Light_openSUSE_12.1
and [[#For_OpenSUSE_12.1]]
=== Ubuntu ===
sudo rm /etc/apt/sources.list.d/obslight.list
and [[#For Ubuntu]].

== OBS Light appliance < 0.4.52 ==
If you are using [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance] older than 0.4.52, and you don't want to download the latest version, you can update it doing the following:
# Remove old openSUSE 12.1 specific OBS Light repository
sudo zypper rr Project_OBS_Light_openSUSE_12.1
# Add Tizen Tools and OBS Light repositories
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Update MIC and OBS Light
sudo zypper up mic obslight obslight-gui
(same procedure as [[#For_openSUSE_12.1 | for openSUSE 12.1]])

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-04-02T09:23:38Z

Fvennetier:

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
You will also need MIC, which is hosted [http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/ here].
To install ''obslight'':
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

zypper --gpg-auto-import-keys ref
zypper in obslight
To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
You will also need MIC, which is hosted [http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ here].
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo

optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> "/etc/zypp/repos.d/Project_OBS_Light.repo"

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo

zypper --gpg-auto-import-keys ref
zypper in obslight obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./

# Ubuntu 11.10
## MIC and dependencies
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
## OBS Light
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Migration from old versions =
== OBS Light < 0.4.22 ==
Starting from OBS Light 0.4.22, MIC and its dependencies won't be maintained in OBS Light's repositories anymore. You will have to add official MIC repository to get MIC dependencies. Just remove the old repository and follow the appropriate procedure. Fedora users can keep using old repositories.
=== openSUSE 11.4 ===
sudo zypper rr Project_OBS_Light
and [[#For OpenSUSE 11.4]]
=== openSUSE 12.1 ===
sudo zypper rr Project_OBS_Light_openSUSE_12.1
and [[#For_OpenSUSE_12.1]]
=== Ubuntu ===
sudo rm /etc/apt/sources.list.d/obslight.list
and [[#For Ubuntu]].

== OBS Light appliance < 0.4.52 ==
If you are using [http://susestudio.com/a/e0uuBG/meego-obs-light OBS Light appliance] older than 0.4.52, and you don't want to download the latest version, you can update it doing the following:
# Remove old openSUSE 12.1 specific OBS Light repository
sudo zypper rr Project_OBS_Light_openSUSE_12.1
# Add Tizen Tools and OBS Light repositories
sudo zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
sudo zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_12.1/Project:OBS_Light.repo
# Refresh package database
sudo zypper --gpg-auto-import-keys ref
# Update MIC and OBS Light
sudo zypper up mic obslight obslight-gui
(same procedure as [[#For_openSUSE_12.1 | for openSUSE 12.1]])

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-03-30T14:08:18Z

Fvennetier: /* Packaged versions */

= OBS Light Deliverable =
== Introduction ==
[[OBS Light]] project deliverable which are available are listed on this page. Publication of the information will follow the progress of the implementation (yes, we do publish early draft versions, using them is at your risk)

== Packaged versions ==
Packaged versions of the OBS Light client (still in development) are available for OpenSUSE and Ubuntu.
=== For OpenSUSE 11.4 ===
The repository is [http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
You will also need MIC, which is hosted [http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/ here].
To install ''obslight'':
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE_11.4/devel:tools:building.repo
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light/openSUSE_11.4/Project:OBS_Light.repo
optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> /etc/zypp/repos.d/Project_OBS_Light.repo

zypper --gpg-auto-import-keys ref
zypper in obslight
To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/cgoncalves:/pyside:/shiboken/openSUSE_11.4/ PySide
zypper --gpg-auto-import-keys ref
zypper in obslight-gui

=== For OpenSUSE 12.1 ===
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]]
* ''obslight-gui'', which contains the graphical user interface
You will also need MIC, which is hosted [http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ here].
zypper ar -f http://download.meego.com/live/devel:/tools:/building/openSUSE12.1/ tizen_tools
zypper ar -f http://repo.pub.meego.com/Project:/OBS_Light:/openSUSE:/12.1/openSUSE_12.1/Project:OBS_Light:openSUSE:12.1.repo

optional, to disable GPG checks and prevent "File 'repomd.xml' from repository 'OBS_Light' is unsigned" messages
echo "gpgcheck=0" >> "/etc/zypp/repos.d/Project_OBS_Light_openSUSE_12.1.repo"

To install the GUI, you will need PySide:
zypper ar -f http://download.opensuse.org/repositories/home:/Fisiu:/pyside/openSUSE_12.1/home:Fisiu:pyside.repo

zypper --gpg-auto-import-keys ref
zypper in obslight obslight-gui

=== For Ubuntu ===
The repositories are [http://repo.pub.meego.com/Project:/OBS_Light/ here]. Available Ubuntu versions are '''10.04''' and '''11.10'''.
There is only one package, ''obslight'', which contains the commandline, the GUI and the utilities. Add the following line to your '''/etc/apt/sources.list''' file (or to a new file '''/etc/apt/sources.list.d/obslight.list'''):
# Ubuntu 10.04
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_10.04/ ./
deb http://download.meego.com/live/devel:/tools:/building/Ubuntu_10.04/ ./

# Ubuntu 11.10
deb http://repo.pub.meego.com/Project:/OBS_Light/Ubuntu_11.10/ ./
deb http://download.meego.com/live/devel:/tools:/building/xUbuntu_11.10/ ./
You also need a recent version of [http://www.pyside.org/ PySide]:
sudo apt-add-repository ppa:pyside/ppa
If you have Ubuntu 10.04 and an old version of '''osc''' (< 0.132) we suggest also adding:
deb http://download.opensuse.org/repositories/openSUSE:/Tools/xUbuntu_10.04/ ./
Refresh the APT database and install OBS Light:
sudo apt-get update
sudo apt-get install obslight
Add yourself to the '''users''' group:
sudo usermod -a -G users `whoami`
You should log out so that the system takes into account your new group.
If you don't want to log out, you can use "''newgrp users''" before running obslight (but it will only work in the current console).

=== For Fedora 16 ===
The repository is [http://repo.pub.meego.com//Project:/OBS_Light/Fedora_16/ here].
There are 2 packages:
* ''obslight'', which contains the API, a commandline client, and [[obstag | obstag, obs2obscopy and obsextractgroups]].
* ''obslight-gui'', which contains the graphical user interface.

Execute the following commands:
# Add OBS Light repository
sudo wget http://repo.pub.meego.com/Project:/OBS_Light/Fedora_16/Project:OBS_Light.repo -O /etc/yum.repos.d/Project_OBS_Light.repo
# Deactivate GPG check
sudo sed -r -i "s/(gpgcheck)=1/\1=0/" /etc/yum.repos.d/Project_OBS_Light.repo
# Update repository cache
sudo yum makecache
# Install OBS Light
sudo yum install obslight obslight-gui
# Add yourself to the "users" group
sudo usermod -a -G users `whoami`

== Usage ==
To get a brief overview of all available commands, just type:
obslight --help

== OBS Tagging and Project copying ==
One of the problem that any user of a private OBS will quickly face, is the need to tag specific version of a project and allow the copy of the project from an OBS to an other OBS or from one project to an other project.

More details on obstag and obs2obscopy can be found [[obstag | here]]

= Links =
* [[OBS Light | OBS Light main page]]
* [[OBS_Light_FAQ | OBS Light Frequently Asked Questions]]
* [[OBS_Light_Manual | OBS Light Manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light Installation

2012-03-30T13:20:54Z

Fvennetier: /* For OpenSUSE 12.1 */

OBS Light Installation

2012-03-30T10:38:17Z

Fvennetier: /* Packaged versions */

User:Fvennetier/OBS Light MIC

2012-03-30T07:27:47Z

Fvennetier: Blanked the page

User:Fvennetier/OBS Light Create new package

2012-03-30T07:24:46Z

Fvennetier: Blanked the page

OBS Light FAQ

2012-03-26T13:36:45Z

Fvennetier: /* How to prepare a Spec file using Spectacle ? */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

Each OBS project has its own directory in '''~/OBSLight/ObsProjects/''', each MIC project has its own directory in '''~/OBSLight/MicProjects/'''.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/ObslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running, there is a button under the progress bar.
* A log file is written in <tt>~/OBSLight/obslight.log</tt>.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the project filesystem? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your project filesystem's zypper configuration, you have two choices:
* First one, use an URL and an alias:
## obslight filesystem repositories add <repository_url> <repository_alias> <project_alias>
obslight filesystem repositories add http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ MeeGo_non-oss MeeGo_1.2_oss
* Second one, add the repository of another local project:
## obslight filesystem repositories add from <source_project_alias> <project_alias>
obslight filesystem repositories add from MeeGo_1.2_non-oss MeeGo_1.2_oss

== How to create a new package ? (from an existing SPEC file) ==
=== Requirements ===
* A project on an OBS server (public or [http://susestudio.com/a/e0uuBG/meego-obs private]) where you have maintainer rights (for example your home project), and with a [http://en.opensuse.org/openSUSE:Build_Service_Tutorial#Step_Three.C2.A0.E2.80.93_Choose_build_targets build target] already configured.
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK).
* A valid SPEC file, named <tt>program.spec</tt>.

=== Procedure ===
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI or ''osc'' first.
# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button (on the left-bottom).
#* Select a server from the list or configure a new one.
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project without "''':'''", we suggest suffixing with the architecture).
#* You should now see a list of packages, with the one you created in web UI.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken'' (because it has no files).
#* In the right panel, select tab ''Local directory'', click ''Import file''.
#* Select your SPEC file and archive (and YAML file if you have one).
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded, and the package starts to build on the OBS server.

== How to prepare a Spec file using Spectacle ? ==
*Official documentation: [[Spectacle]]
*Why using Spectacle: [[Packaging/Guidelines#Writing_a_package_from_scratch]]

=== Generate a YAML file from scratch ===
==== Manually ====
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file. Just replace "<tt>^^^</tt>" occurrences by which seems appropriate, and got to the [[#Customize_the_Spec_and_YAML_files | Spec and YAML customization section]].

==== Automatically ====
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle] can analyze source archives and generate an appropriate YAML file, but has no documentation.

=== Generate a YAML file from a Spec file ===
If you already have a Spec file for your program, you may still want to create a YAML file in order to standardize or simplify it. Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file. Notice that the conversion is not perfect, and you may lost information.

=== Customize the Spec and YAML files ===
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml
Complete list of Spectacle options is here: [[Spectacle#Syntax_of_spectacle_YAML | Syntax of spectacle YAML]]

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-03-26T13:26:58Z

Fvennetier: /* How to create a new package ? (from an existing SPEC file) */

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

Each OBS project has its own directory in '''~/OBSLight/ObsProjects/''', each MIC project has its own directory in '''~/OBSLight/MicProjects/'''.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/ObslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running, there is a button under the progress bar.
* A log file is written in <tt>~/OBSLight/obslight.log</tt>.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the project filesystem? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your project filesystem's zypper configuration, you have two choices:
* First one, use an URL and an alias:
## obslight filesystem repositories add <repository_url> <repository_alias> <project_alias>
obslight filesystem repositories add http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ MeeGo_non-oss MeeGo_1.2_oss
* Second one, add the repository of another local project:
## obslight filesystem repositories add from <source_project_alias> <project_alias>
obslight filesystem repositories add from MeeGo_1.2_non-oss MeeGo_1.2_oss

== How to create a new package ? (from an existing SPEC file) ==
=== Requirements ===
* A project on an OBS server (public or [http://susestudio.com/a/e0uuBG/meego-obs private]) where you have maintainer rights (for example your home project), and with a [http://en.opensuse.org/openSUSE:Build_Service_Tutorial#Step_Three.C2.A0.E2.80.93_Choose_build_targets build target] already configured.
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK).
* A valid SPEC file, named <tt>program.spec</tt>.

=== Procedure ===
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI or ''osc'' first.
# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button (on the left-bottom).
#* Select a server from the list or configure a new one.
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project without "''':'''", we suggest suffixing with the architecture).
#* You should now see a list of packages, with the one you created in web UI.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken'' (because it has no files).
#* In the right panel, select tab ''Local directory'', click ''Import file''.
#* Select your SPEC file and archive (and YAML file if you have one).
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded, and the package starts to build on the OBS server.

== How to prepare a Spec file using Spectacle ? ==
Official documentation: [[Spectacle]]

=== Generate a YAML file from scratch ===
==== Manually ====
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file. Just replace "<tt>^^^</tt>" occurrences by which seems appropriate, and got to the [[#Customize_the_Spec_and_YAML_files | Spec and YAML customization section]].

==== Automatically ====
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle] can analyze source archives and generate an appropriate YAML file, but has no documentation.

=== Generate a YAML file from a Spec file ===
Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file. Notice that the conversion is not perfect, and you may lost information.

=== Customize the Spec and YAML files ===
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml
Complete list of Spectacle options is here: [[Spectacle#Syntax_of_spectacle_YAML | Syntax of spectacle YAML]]

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

OBS Light FAQ

2012-03-23T11:33:11Z

Fvennetier:

= Frequently Asked Questions =
== Where does ''obslight'' store its data? ==
All data is stored in '''~/OBSLight''' and subdirectories.

Each OBS project has its own directory in '''~/OBSLight/ObsProjects/''', each MIC project has its own directory in '''~/OBSLight/MicProjects/'''.

== Is there a configuration file ? ==
Configuration file is '''~/OBSLight/ObslightConfig'''.

== How do I run OBS light server appliance on my Desktop ? ==
While running an OBS Light appliance is simple and easy and just requires 1GB of RAM allocated to the virtual machine, running an OBS server appliance can be much more demanding but running the OBS server server appliance on your desktop or laptop (a minimum 4GB of RAM is mandatory) via a virtual machine can be very handy during evaluation tests. 
The main advantage is that you do not need a special authorisation from your IT department to start playing but you need to allocate at least 2GB to the appliance and as many CPU cores that you can spare. You need to patch on the OBS server appliance ''(need to be root)'' the file '''/etc/sysconfig/obs-worker''' to set the variable OBS_WORKER_INSTANCES to 1 (default is zero) to limit the RAM resources requires by your appliance during build process.
If you plan to build large packages such as Chromium you will need more than 2GB of RAM allocated (actually on my desktop I have 16GB). 
You can overcome that limit with the addition of an obsworker appliance on a separate server. OBS Light project provides one pre-configured to work with and OBS Light server appliance. 
If you use the Bridge mode, external OBS work appliance will be detected and used automatically (NAT more would require a complex configuration). The Worker can be running on a more powerfull unit and speed the preparation work before for example leaving the office with a complete fully built project on a laptop.
You can stop the worker on the laptop by the command '''rcobsworker stop''' ''(need to be root)''. You can check that your OBS Worker appliance can see your OBS Light Server Appliance with the command '''slptool findsrvs obs.source_server''' 
As a general rule using the bridge mode is advisable. Note ''this is '''not''' the default option of VirtualBox''.
The NAT mode is interesting to run an OBS Light server via a VPN or for unconnected demos. In that case you will need to declare NAT rules in your Vitual Machine Manager redirecting the ports 80, 81 and 82 from your local host to your OBS appliance internal NAT address ''(with VitualBox under Linux rerouting port bellow 1000 is reserved for root only)''. 
Do not forget to add a host name "obslightserver" in your workstation pointing to the OBS Light server appliance IP address or localhost in the case of a NAT configuration.

== How to show the log ? ==
* From the menu: ''Window'' -> ''Show log''
* When a long operation is running, there is a button under the progress bar.
* A log file is written in <tt>~/OBSLight/obslight.log</tt>.

== Why does MeeGo's '''kernel''' package fail to build for ARM? ==
The '''kernel''' package has flags to prevent builds on ARM.
To compile an ARM kernel, you must use another package, for example the '''kernel-adaptation-n900''' package.

== How install the dependency of a package into the project filesystem? ==
If the project on your OBS doesn’t provide some dependencies and you must add a repository to your project filesystem's zypper configuration, you have two choices:
* First one, use an URL and an alias:
## obslight filesystem repositories add <repository_url> <repository_alias> <project_alias>
obslight filesystem repositories add http://download.meego.com/live/MeeGo:/1.2:/non-oss/MeeGo_1.2/ MeeGo_non-oss MeeGo_1.2_oss
* Second one, add the repository of another local project:
## obslight filesystem repositories add from <source_project_alias> <project_alias>
obslight filesystem repositories add from MeeGo_1.2_non-oss MeeGo_1.2_oss

== How to create a new package ? (from an existing SPEC file) ==
=== Requirements ===
* A project on an OBS server where you have maintainer rights (for example your home project).
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK).
* A valid SPEC file, named <tt>program.spec</tt>.

=== Procedure ===
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI or ''osc'' first.
# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button.
#* Select a server from the list or add a new one (not explained here).
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project, without "''':'''").
#* You should now see a list of packages, with the one you created in web UI.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken'' (because it has no files).
#* In the right panel, select tab ''Local directory'', click ''Import file''.
#* Select your SPEC file and archive (and YAML file if you have one).
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded on the OBS server, and the package starts to build.

== How to prepare a Spec file using Spectacle ? ==
Official documentation: [[Spectacle]]

=== Generate a YAML file from scratch ===
==== Manually ====
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file. Just replace "<tt>^^^</tt>" occurrences by which seems appropriate, and got to the [[#Customize_the_Spec_and_YAML_files | Spec and YAML customization section]].

==== Automatically ====
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle] can analyze source archives and generate an appropriate YAML file, but has no documentation.

=== Generate a YAML file from a Spec file ===
Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file. Notice that the conversion is not perfect, and you may lost information.

=== Customize the Spec and YAML files ===
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml
Complete list of Spectacle options is here: [[Spectacle#Syntax_of_spectacle_YAML | Syntax of spectacle YAML]]

== Where to send bug reports ? ==
Bugs are centralized on [https://bugs.meego.com/buglist.cgi?product=Development%20Tools&component=OBS%20Light MeeGo's bugzilla].

= Links =
* [[OBS_Light | OBS Light main page]]
* [[ObsLightDeliverable | OBS Light deliverables]]
* [[OBS_Light_Manual | OBS Light manual]]
* [https://meego.gitorious.org/meego-developer-tools/obs-light/ OBS Light project on Gitorious]
* [https://build.pub.meego.com/project/show?project=Project%3AOBS_Light OBS Light project on MeeGo build service]

User:Fvennetier/OBS Light Create new package

2012-03-23T10:53:43Z

Fvennetier:

= How to prepare a Spec file using Spectacle ? =
Official documentation: [[Spectacle]]

== Generate a YAML file from scratch ==
=== The manual way ===
Run the following command:
specify --new=your_package_name
It will create a new YAML file from a template, and ask you to edit the file.

=== The automatic way ===
[https://meego.gitorious.org/meego-developer-tools/autospectacle autospectacle]

== Generate a YAML file from a Spec file ==
Run the following command:
spec2spectacle your_package_name.spec
It will parse your Spec file, generate a YAML file, and generate a new Spec file from the YAML file.

== Customize the Spec and YAML files ==
Except from lines between "<tt># >> </tt>" and "<tt># << </tt>" tags, the content of the Spec file should not be modified by you, because it will be re-written by <tt>specify</tt> each time you modify the YAML file. So if you see a line you don't like, you have to find which option of the YAML file has generated it (or can prevent it to be generated), change it, and run the following command to update the Spec file:
specify your_package_name.yaml

== Create the package ==
[[OBS_Light_FAQ#How_to_create_a_new_package_.3F_.28from_an_existing_SPEC_file.29 | Procedure is there]]

User:Fvennetier/OBS Light Create new package

2012-03-23T09:42:22Z

Fvennetier:

OBS Light FAQ

2012-03-23T09:00:47Z

Fvennetier:

OBS Light FAQ

2012-03-22T17:26:15Z

Fvennetier: /* How to show the log ? */

OBS Light FAQ

2012-03-22T17:22:23Z

Fvennetier: /* How to show the log ? */

User:Fvennetier/OBS Light Create new package

2012-03-22T17:16:15Z

Fvennetier:

= How to create a new package using spectacle and a SPEC file ? =
Official documentation: [[Spectacle]]
== Requirements ==
* A project on an OBS server where you have maintainer rights (for example your home project)
* OBS Light [[ObsLightDeliverable | already installed on your computer]]
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK)
* A SPEC file, <tt>program.spec</tt>

== Prepare the SPEC file ==
* First you have to generate a YAML file:
spec2spectacle mypackage.spec
* Edit the generated YAML file, <tt>mypackage.yaml</tt>. You may have to complete some fields, for example the source file, which should look like ''%{name}-%{version}.tar.gz''.
* Re-generate the SPEC file
specify mypackage.yaml
* Now check the SPEC file, especially the script section. Your old scripts should have been surrounded by "'''# >> '''" and "'''# << '''" tags. '''%if''' macros have been removed.

== Create the package ==
[[OBS Light]] cannot create new packages at the moment. You have to use the web UI, or ''osc''.

# Using the web UI:
#* Go to the project you want to add your package to.
#* Go to ''Packages'' tab.
#* Click ''Create package''.
#* Give a name to the package (we recommend the same name as your program, in lower-case), a title and a description (optional but recommended).
# Now you should be able to import this package in [[OBS Light]].
#* Run <tt>obslightgui</tt>.
#* Click ''Import project'' button.
#* Select a server from the list or add a new one (not explained here).
#* Select your project in the list.
#* Select a target and an architecture.
#* Give an alias to the project (can be the name of the project, without "''':'''").
#* You should now see a list of packages, with the one you created earlier.
#* Select it and press ''finish''.
# The package is now imported into OBS Light, with status ''broken''.
#* In the right panel, tab ''Local directory'', click ''Import file''.
#* Select your SPEC file, YAML file and archive.
#* The files appear in the list with status ''Added''.
#* In the middle panel, click ''Commit changes'', and enter a commit message.
#* The files are uploaded on the OBS server, and the package starts to build.

User:Fvennetier/OBS Light Create new package

2012-03-22T16:34:31Z

Fvennetier:

User:Fvennetier/OBS Light Create new package

2012-03-22T16:09:16Z

Fvennetier: Created page with "= How to create a new package using spectacle and a SPEC file ? = Official documentation: Spectacle == Requirements == * An archive of your program, named like <tt>program-ve..."

= How to create a new package using spectacle and a SPEC file ? =
Official documentation: [[Spectacle]]
== Requirements ==
* An archive of your program, named like <tt>program-version.tar.gz</tt> (<tt>tar.bz2</tt> is OK)
* A SPEC file, <tt>program.spec</tt>

== Round-trip the SPEC file ==
* First you have to generate a YAML file:
spec2spectacle mypackage.spec
* Edit the generated YAML file, <tt>mypackage.yaml</tt>. You may have to complete some fields, for example the source file, which should look like ''%{name}-%{version}.tar.gz''.
* Re-generate the SPEC file
specify mypackage.yaml
* Now check the SPEC file, especially the script section. Your old scripts should have been surrounded by "'''# >> '''" and "'''# << '''" tags. '''%if''' macros have been removed.

OBS Light Installation

2012-03-20T13:52:22Z

Fvennetier: /* For OpenSUSE 12.1 */

OBS Light Installation

2012-03-15T11:15:37Z

Fvennetier: /* Packaged versions */

OBS Light Manual

2012-03-14T13:41:28Z

Fvennetier: /* Troubleshooting */

OBS Light Installation

2012-03-08T10:02:59Z

Fvennetier: /* OBS Light Deliverable */

OBS Light Installation

2012-03-07T17:05:38Z

Fvennetier: /* OBS Light Deliverable */

OBS Light Installation

2012-03-07T08:37:26Z

Fvennetier: /* Packaged versions */

File:Obslightgui 01.png

2012-03-01T10:19:18Z

Fvennetier: uploaded a new version of "File:Obslightgui 01.png": OBS Light 0.4.17

Main window of OBS Light GUI

OBS Light Manual

2012-03-01T09:08:38Z

Fvennetier: /* GUI */

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

On the left panel you can see a list of MIC projects. Click ''New'' to add one, you will be asked for a name, and an empty Kickstart file will be created.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

In this tab you can:
* change the generated image type
** ''fs'': a directory hierarchy containing the whole filesystem
** ''livecd'': a bootable image suitable for a CD
** ''liveusb'': a bootable image suitable for a USB key
** ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'')
** ''raw''
* change the architecture of the project (only i686 has been tested)
* open the directory of the project (with you default file browser)
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

In this tab you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

= Internals =
== GUI ==
[[File: ObsLightGui_class_diagram.png|link=http://wiki.meego.com/images/ObsLightGui_class_diagram.png|OBS Light GUI class diagram, click to see full size]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/ObsLightGui_class_diagram.dia Dia source file]

File:ObsLightGui class diagram.png

2012-03-01T09:02:13Z

Fvennetier: uploaded a new version of "File:ObsLightGui class diagram.png": Source: https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/ObsLightGui_class_diagram.dia

OBS Light GUI class diagram

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/ObsLightGui_class_diagram.dia Source]

OBS Light Manual

2012-02-28T12:38:51Z

Fvennetier:

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

On the left panel you can see a list of MIC projects. Click ''New'' to add one, you will be asked for a name, and an empty Kickstart file will be created.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

In this tab you can:
* change the generated image type
** ''fs'': a directory hierarchy containing the whole filesystem
** ''livecd'': a bootable image suitable for a CD
** ''liveusb'': a bootable image suitable for a USB key
** ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'')
** ''raw''
* change the architecture of the project (only i686 has been tested)
* open the directory of the project (with you default file browser)
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

In this tab you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

= Internals =
== GUI ==
[[File: ObsLightGui_class_diagram.png|600px|OBS Light GUI class diagram]]

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/ObsLightGui_class_diagram.dia Dia source file]

OBS Light FAQ

2012-02-28T08:47:38Z

Fvennetier:

OBS Light Manual

2012-02-28T08:12:29Z

Fvennetier: /* MIC projects tab */

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

On the left panel you can see a list of MIC projects. Click ''New'' to add one, you will be asked for a name, and an empty Kickstart file will be created.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

In this tab you can:
* change the generated image type
** ''fs'': a directory hierarchy containing the whole filesystem
** ''livecd'': a bootable image suitable for a CD
** ''liveusb'': a bootable image suitable for a USB key
** ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'')
** ''raw''
* change the architecture of the project (only i686 has been tested)
* open the directory of the project (with you default file browser)
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

In this tab you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

= Internals =
== GUI ==
[[File: ObsLightGui_class_diagram.png|600px|OBS Light GUI class diagram]]

File:ObsLightGui class diagram.png

2012-02-28T08:00:38Z

Fvennetier:

OBS Light GUI class diagram

[https://meego.gitorious.org/meego-developer-tools/obs-light/blobs/master/Doc/ObsLightGui_class_diagram.dia Source]

OBS Light Manual

2012-02-27T17:36:04Z

Fvennetier:

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

Here you can:
* change the generated image type
* change the architecture of the project (only i686 has been tested)
* open the directory of the project
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

Here you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).

= Internals =
== GUI ==
[[File: ObsLightGui_class_diagram.png|600px|OBS Light GUI class diagram]]

File:ObsLightGui class diagram.png

2012-02-27T17:33:52Z

Fvennetier: OBS Light GUI class diagram

OBS Light GUI class diagram

User:Fvennetier/OBS Light MIC

2012-02-27T16:17:56Z

Fvennetier: Created page with "== MIC projects == MIC is a tool to create and manipulate images for Linux distributions. OBS Light implements a GUI for the image creation part of mic. === Create a project ===..."

== MIC projects ==
MIC is a tool to create and manipulate images for Linux distributions. OBS Light implements a GUI for the image creation part of mic.

=== Create a project ===
# Press the ''New'' button and enter a name for your project.
# An empty Kickstart file is automatically created.
# If you already have your own Kickstart file, you can import it by pressing ''Import Kickstart file'' button. It will be parsed and copied in the project directory.

=== Customize the project ===
There are only two customizable parameters:
;Image Type
: The type of filesystem image that will be created. It can be
:* ''fs'': a directory hierarchy containing the whole filesystem
:* ''livecd'': a bootable image suitable for a CD
:* ''liveusb'': a bootable image suitable for a USB key
:* ''loop'': a filesystem image to be mounted with a loop device (with ''mount -o loop'').
:* ''raw''
;Architecture
: The architecture of packages that will be included in the filessystem. At the moment, the unique possibility is ''i686''.

=== Customize the Kickstart file ===

OBS Light Manual

2012-02-27T15:24:09Z

Fvennetier: /* Troubleshooting */

This is the user manual of the command-line and graphical interface of OBS Light.
* [[OBS_Light | OBS Light project]]
* [[OBS_Light_FAQ | Frequently Asked Questions]]
* [[ObsLightDeliverable | Installation]]
= General principles =
== Operation modes ==
OBS Light is available via command line (obslight) and a graphical user interface GUI (obslightgui).
Independently of that fact that you are using the command line or the GUI, you will get access to the same services.

== Videos training ==
We have created a set of video which will provide you a quick overview of how to start with OBS Light. 
They cover :
* Where to find the tool and information
* How to install OBS Light and get write access to an OBS
* Creation of you first project and package import
* Working in the project filesystem
* Auto creation of patch and upload to OBS

http://www.dailymotion.com/playlist/x1t5ll_dominigarfoll_obs-light-training

== Step by step ==
=== Get Login access to an OBS server ===
OBS Light is a simplified model to develop code via an OBS. It does not replace your OBS.

To use OBS Light you will need a login access to an OBS. You have two simple methods to get a login on an OBS:
* You can create a login on several "free" OBS :
** MeeGo Community https://build.pub.meego.com/
** OpenSUSE https://build.opensuse.org/
* Run your private OBS instance
** Select a ready made MeeGo OBS appliance (highly recommended) http://susestudio.com/a/e0uuBG/meego-obs
** Install your private full appliance (advanced users only) http://en.opensuse.org/openSUSE:Build_Service_private_instance

Once you have a login on an OBS instance, you will need to copy a project to play with. You can use the utilities ''obstag'' and ''obs2obscopy'' to achieve that in an easy way. See [[ Obstag ]].

=== Configure your OBS servers ===
OBS Light needs to know on which server you will connect to. As OBS Light does more than the osc tool, more information will be needed. You will be asked the following :
* OBS server web URL
* OBS server API URL
* OBS repository URL
* Login
* Password
* Alias (note that Alias will need to be different from any Alias already present in your osc configuration and OBS light will enforce that constrain). If you plan to use the import/export functions make sure that you use the same Alias on the sending and receiving hosts.

Even if these information are copied in ''.osrcrc'', they must be maintain via the OBS light command.

=== Import the package(s) to work on ===
After the configuration of one or more OBS servers, you will be able to import a package to work on.
You can also create an empty package would you like to.

OBS Light will create a local copy of that package on your workstation in a very similar way to what an osc checkout action would do.
As osc, OBS Light transparently keeps track directly of the links between the packages and the associated OBS servers.

=== Create the project filesystem ===
Once that you have loaded the packages, you can request the creation of a "chroot jail" (thereafter referred to as "filesystem" or "project filesystem"), where the packages can be built without interfering with the host's filesystem. The created filesystem is specific to the project and will not be recreated if it's already present.
During the creation of the filesystem, extra packages imposed by the build dependencies will be loaded automatically. If you are connected on a remote OBS that phase can take some time and may require a bit of patience.

OBS Light tries to load automatically the dependencies from the analysis of the .spec file in the RPM but that is not always possible. The user has the possibility to add manually extra file and/or packages to the filesystem.

Packages can be imported either from a project already present in OBS Light or from any URL.

=== Importing the code in the project filesystem ===
Once that the filesystem is created, the source from the package can be imported in the filesystem. During that process, OBS Light will load the extra package needed to build that specific imported source and will create a special git tree which will monitor any changes done by the user.

The user can directly open a window on the filesystem from OBS Light. The console program used by default can be defined in the OBS Light configuration file.
From there direct modification of the code in the filesystem is possible and local build can be run as often as desired.

=== Committing changes ===
When the user is happy of his change, he can request the change from the filesystem to be committed directly in the package.

A patch will be created and added to the package and configured in the .spec file by OBS Light.

=== Saving changes on the OBS server ===
Once that changes on a given project (which can work on one or multiple packages) achieve a stage which is worth to push on the OBS server. The user can simply request to save the project and OBS Light will commit the changes automatically.

== Example: patching MeeGo 1.2 ''kernel'' package ==

=== Step1: inform ''obslight'' about your OBS account ===
## synthax: obslight server add server_alias <server_alias> login <login> password <password> api_url <api_url> repository_url <repository_url> web_url <web_url>
;''server_alias''
: is the alias you want to use to refer to this server.
;''api_url''
: is the URL to the OBS control API. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 81.
;''repository_url''
: is the URL to the OBS package repositories. If you are using [http://susestudio.com/a/e0uuBG/meego-obs OBS appliance], it's probably on port 82.
;''web_url''
: is the URL to the OBS web interface.

=== Step2: create a local project related to your OBS project ===
* The project is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/'''
## synthax: obslight obsproject add <project_alias> <name_on_obs> <target> <arch> <server_alias>
obslight obsproject add MeeGo_1.2_oss MeeGo:1.2:oss standard i586 <server_alias>
;''project_alias''
: is the name you will use to refer to this project with the ''obslight'' command (e.g. ''MeeGo_1.2_oss'').
;''name_on_obs''
: is the name of the project on the OBS (e.g. ''MeeGo:1.2:oss'').
;''target''
: is the target against which we will build (''standard'' is the common name when there is only one).
;''arch''
: is the target architecture of the project.
;''server_alias''
: is the alias of the OBS server from which we get the project (which has been configured in first step).

=== Step3: add the kernel package to your local project ===
* The package is created in '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/'''
* In this directory, the package is manageable by osc.
## synthax: obslight package add package <package> project_alias <project_alias>
obslight package add package kernel project_alias MeeGo_1.2_oss
;''package''
: is the name of the package you want to work on (e.g. '''kernel''').
;''project_alias''
: is the name of the project you created in step2.

=== Step4: create the filesystem of the project ===
* The filesystem root directory is '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/aChroot/'''.
* zypper is included in the filesystem and your OBS project's repository is automatically added.
## synthax: obslight filesystem create <project_alias>
obslight filesystem create MeeGo_1.2_oss

=== Step5: add the source of the kernel package into your filesystem ===
* The source package is extracted in directory '''/root/rpmbuild/BUILD/kernel-X.X.X/linux-X.X.X'''.
* After the installation, a git repository is initialized in package's directory.
## synthax: obslight rpmbuild prepare package <package> project_alias <project_alias>
obslight rpmbuild prepare package kernel project_alias MeeGo_1.2_oss

=== Step6: work as you want into your filesystem ===
* The directory '''~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/''' is mounted into the chroot jail in '''/chrootTransfert/'''.
* Every script executed in ''aChroot'', is stored in '''/chrootTransfert/''' as '''runMe_YYYY-MM-DD_HHhMMmSS.sh'''.
## synthax: obslight filesystem enter package <package> project_alias <project_alias>
obslight filesystem enter package kernel project_alias MeeGo_1.2_oss

Now you are logged in the chroot jail.
In this example we just modify the kernel configuration.
$ cp configs/kernel-x86.config .config
$ make menuconfig

=== Step7: save your modifications ===
There are two methods.

==== Method1: by making a patch ====
$ cp .config config-x86
$ exit

## synthax: obslight rpmbuild createpatch <patch> package <package> project_alias <project_alias>
obslight rpmbuild createpatch myKernelPatch.patch package kernel project_alias MeeGo_1.2_oss

* The patch is automatically added to the local spec file.
* '''myKernelPatch.patch''' is automatically added to the local package directory.
* ''kernel package specific:'' you must move the patch application command '''%patchXXX -p1''' after the command line '''cp $RPM_SOURCE_DIR/config-* .''' in the local spec file
vi ~/OBSLight/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/kernel.spec

==== Method2: by copying the new configuration file in OSC directory ====
$ cp .config /chrootTransfert/config-x86
$ exit
cp ~/OBSLight/ObsProjects/MeeGo_1.2_oss/chrootTransfert/config-x86 ~/OBSLight/ObsProjects/MeeGo_1.2_oss/MeeGo:1.2:oss/kernel/

=== Step8: Upstream your modifications to the OBS server ===
* The command ''package commit'' checks the additions and deletions of files, before committing the package to the OBS server.
## synthax: obslight package commit <message> package <package> project_alias <project_alias>
obslight package commit "Patch kernel" package kernel project_alias MeeGo_1.2_oss

= Command-line =

The help is integrated in the tool. ''obslight help'' will give you an online help.

To get more detail on a specific command you can type ''obslight <command> help''.

$ obslight help
OBSlight:
Provides a tool to manage an OBS project on your local machine in command line
For informations, see the Help section
obslight --Help
The gui for OBSlight is obslightgui
A FAQ is available at:
*http://wiki.meego.com/OBS_Light_FAQ
For additional informations, see:
*http://wiki.meego.com/OBS_Light
Usage: OBSlight [global command] <command> [--command-options]

Type OBSlight <command> --Help to get Help on a specific command.
Commands:

server: Manage the OBS server
obsproject: Manage the OBSlight project
package: Manage the packages of OBSlight project
projectfilesystem (projectfs,filesystem,pfs) :
Manage the project filesystem of OBSlight project
rpmbuild (rb) : Manage the rpmbuild of the package into the project filesystem
man: print the man help document

global Options:

quiet (-quiet,--quiet) : run obslight in quiet mode
debug (-debug,--debug) : run obslight in debugger mode
version (--version) : show program's version number and exit
help (-h,-help,--help) : show this help message and exit
noaction: Execute command but do nothing

= Graphical interface =
The GUI is launched via the command ''obslightgui''.
Only the parameter ''--version'' is supported.

It has two main tabs: one for OBS projects, one for MIC projects

The buttons in each section apply to the relative section. They display a tool-tip when the mouse is positioned on them.
Button are grayed when there are not active or not yet implemented.

== OBS projects tab ==
[[File: Obslightgui_01.png|600px|OBS Light GUI main window]]

This tab allows you to manage an OBS project, its packages (and their files) and its filesystem.

It has 3 main areas:
* OBS project
* Packages
* local files and project filesystem (on a tab)

=== The project panel ===
The panel on the left displays the list of OBS projects locally configured, and information about the selected project.

{| border="1" cellpadding="5"
|
;New
: Create a new project. Currently you cannot create a new project from scratch using OBS Light, only import one.
;Import
: Import a project from an OBS server.
;Delete
: Delete the selected project. The project will be removed locally but will remain on the OBS server.
;Modify
: Modify the selected project configuration.
|
;Save
: Save the selected project to a file.
;Load
: Load a project from a file.
|}

=== The package panel ===
The panel on the middle displays the list of packages of the selected project, and information about the selected package.

{| border="1" cellpadding="5"
|
;New
: Create a new package. Currently you cannot create a new package from scratch using OBS Light, only import one.
;Import
: Import a package from an OBS project.
;Delete
: Delete the selected package(s). The packages will be removed locally but will remain on the OBS server.
;Modify
: Modify the package title and description. Currently not available.
|
;Update files
: Checkout/update files from the OBS (''osc update'' equivalent).
;Commit changes
: Commit changes to the OBS (''osc commit'' equivalent).
;Repair OSC directory
: Repair the OSC working copy of a package.
|
;Refresh status
: Refresh OBS and Local statuses.
|}

=== The file panel ===
The file panel has two tabs: '''Local directory''' and '''Project filesystem'''.

==== The local directory tab ====
This tab shows the list of files contained in the selected package.
{| border="1" cellpadding="5"
|colspan="2"|
;Open terminal
: Open a terminal in the package directory
;Package path
: Location of the package's OSC working copy
|-
| File-related buttons
| Patch-related buttons
|-
|
;New
: Create a new empty file. Currently not available.
;Import
: Add a file from your local filesystem to the package.
;Delete
: Delete the selected file from the package.
;Modify
: Launch an editor on the selected file.
|
;New
: Generate a patch from the changes made into the project filesystem, and add this patch to the package and in the yaml and/or spec files. This patch becomes the current patch of the package, until the next '%prep'.
;Import
: Import an external patch. Currently not available.
;Delete
: Delete a patch. Currently not available.
;Update
: Update the current patch with new modifications.
|}

==== The project filesystem tab ====
This tab shows the complete file tree of selected project's filesystem.
If a package is selected and it has previously been imported into the filesystem, its path is expanded by default.
{| border="1" cellpadding="5"
|colspan="3"|
;Open terminal
: Open a terminal in the filesystem, using '''chroot''', in the source directory of the current package if it is installed.
;Chroot path
: Location of the project filesystem.
|-
| Repository-related buttons
| Filesystem-related buttons
| Rpmbuild-related buttons
|-
|
;New
: Make a package repository accessible from zypper inside the filesystem, by URL.
;Import
: Make the package repository of another OBS Light project accessible from zypper inside the filesystem.
;Delete
: Delete a repository from the filesystem.
;Modify
: Modify the URL or alias of a repository.
|
;New
: Create the filesystem of the project.
;Import
: Not yet implemented.
;Delete
: Delete the filesystem
;Modify
: Not yet implemented.
|
;%prep
: Install the sources of a package into the filesystem, execute the %prep section of the spec file and do the first build.
;%build
: Execute the %build section of the spec file of the selected package, in an alternative rpmbuild directory.
;%install
: Execute the %install section of the spec file of the selected package, in an alternative rpmbuild directory.
;%files
: Build the source and binary RPMs of the selected package, in an alternative rpmbuild directory.
|}

== MIC projects tab ==
This tab allows you to manage a MIC (MeeGo Image Creator) project. You can change its architecture and image type, and edit its Kickstart file.

=== Project options ===
[[File: Obslightgui_mic_01.png|600px|OBS Light GUI main window - MIC project - Project options]]

Here you can:
* change the generated image type
* change the architecture of the project (only i686 has been tested)
* open the directory of the project
* import a Kickstart file (that will overwrite the current file)
* export the current Kickstart file
* launch the creation of the image

=== Kickstart options ===
[[File: Obslightgui_mic_02.png|600px|OBS Light GUI main window - MIC project - Kickstart options]]

Here you can add, delete or modify the different options of the project's Kickstart file. These options are documented [http://fedoraproject.org/wiki/Anaconda/Kickstart here].

* To add an option press the ''add'' button, and enter the full option line in the bottom text field, then press ''save''.
* To modify an option, select it, modify the bottom text field and press ''save''.
* To delete an option, select it, press ''delete'', and then ''save''.

Notice that some options may have aliases, which will appear on the same line in the option list.
The ''repo'' option will not be listed here, but in the [[OBS_Light_Manual#Repositories | Repositories]] tab.

=== Repositories ===
[[File: Obslightgui_mic_03.png|600px|OBS Light GUI main window - MIC project - Kickstart repositories]]

In this tab, you can add, delete, or modify Kickstart repositories.

* To add a repository, there are two possibilities:
** The repository is from an OBS project you worked on with OBS Light: press ''Import from OBS project'' and select the project.
** The repository is from an external project: press ''Add by URL'', and you will be asked for an URL and a name.
* To delete a repository, select it and press ''Delete''.
* To edit a repository, double-click on the cell of the property you want to edit (or simple click if it is a checkbox).
The changes are automatically saved.

=== Packages ===
[[File: Obslightgui_mic_04.png|600px|OBS Light GUI main window - MIC project - Kickstart packages]]

Here you can edit the package list of the project's Kickstart file.
Notice that multiple ''%package'' sections of original Kickstart file have been merged into one.

Each package has an ''Included'' parameter which tells if it should be included in the generated image. If ''Included'' is not checked, the package will be explicitly excluded in the Kickstart file (its name will be prefixed with '-').

=== Package groups ===
Here you can edit the list of package groups of the project's Kickstart file.
At the moment, no verification is done on package groups.

=== Scripts ===
[[File: Obslightgui_mic_06.png|600px|OBS Light GUI main window - MIC project - Kickstart scripts]]

Here you can add, delete or modify Kickstart scripts.

* To add a script, press ''Add'', write your script in the bottom text field, choose script options in the right panel, and press ''Save''.
* To delete a script, select it and press ''Delete''.
* To modify a script, select it, modify the script in the bottom text field or the script options in the right panel, and press ''Save''.

=== Overlay files ===
[[File: Obslightgui_mic_07.png|600px|OBS Light GUI main window - MIC project - Overlay files]]

Here you can add files that will be included in the project image.
* To add an overlay file, press ''Add'' and a file browser will appear. Browse to your file and validate. Then a text dialog will appear, enter the path were you want your file to be copied in the image. '''tar''' archives will be extracted at the location you selected, instead of simply being copied.
* To delete an overlay file, select it and press ''Delete''.

Implementation details:
* source files are first copied in MIC project's directory
* each overlay file will appear as a ''%post --nochoot'' script in the Kickstart file (but will be hidden in the ''Scripts'' tab).

= Troubleshooting =

== <tt>"Source package 'xxx' not found"</tt> or <tt>"Problem: nothing provides X needed by Y"</tt> ==
These message may appear in two situations:
* The package you are trying to build is missing a dependency. OBS Light is not capable of searching dependencies outside the project from which your package comes. You will need to configure an additional repository in the project filesystem, using command ''filesystem repositories add'' or [[OBS_Light_Manual#The_project_filesystem_tab | the repository-related buttons]] in the GUI.
* In an ARM project filesystem, zypper or libzypp are broken, they do not see '''noarch''' packages. This problem was reported with zypper 1.5.3 and libzypp 8.12.1. We suggest you to update your zypper version to 1.6+. For convenience, we pre-built zypper 1.6.15 and libzypp 9.10.2 to Meego 1.2.0.

=== How to install zypper 1.6.15 from our repository in an ARM project filesystem ===
==== From commandline ====
First add our repository to your filesystem's zypper configuration file:
obslight filesystem repositories add http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ "Zypper_1.6.15_backport" $ProjectName

Then chroot in the filesystem and update '''zypper''':
obslight filesystem enter $ProjectName
$ zypper update zypper
$ exit
==== From GUI ====
* ''Project filesystem'' tab, ''Repository''->''New'', URL http://repo.pub.meego.com/Project:/OBS_Light:/Zypper/MeeGo_1.2_OSS/ and alias "Zypper_1.6.15_backport"
* Then ''Project filesystem''->''Open terminal''
# zypper update zypper
# exit

== <tt>"error: Architecture is not included: armv8el"</tt> ==
The '''build''' package of your project filesystem does not support armv8el builds. Consider using another version, like the 2011.03.29 of MeeGo's repositories.

=== How to install '''build''' version 2011.03.29 in a MeeGo 1.2.0 project filesystem ===
First add the MeeGo building tools repository to your project filesystem's zypper configuration file:
obslight filesystem repositories add http://download.meego.com/live/Tools:/Building/MeeGo_1.2.0/ "Tools:Building_MeeGo_1.2.0" $ProjectName

Then chroot in the filesystem and update '''build''':
obslight filesystem enter $ProjectName
# zypper update build
# exit

== <tt>"chroot: failed to run command `sh': No such file or directory"</tt> ==
This appears when '''binfmt_misc''' is not or badly configured.
Launch qemu's binfmt configuration script (as root):
qemu-binfmt-conf.sh
If you still get the same message, try this (as root):
echo -1 > /proc/sys/fs/binfmt_misc/arm
echo ":arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:`which qemu-arm`:" > /proc/sys/fs/binfmt_misc/register

== gnomekeyring.IOError ==
This error appears on Ubuntu when running obslight from a console, without a graphical environment. At the moment, the only known solution is to run obslight only from a graphical environment (e.g. Gnome).