Permalink
Browse files

Add README file with package documentation

  • Loading branch information...
athos-ribeiro committed Aug 13, 2018
1 parent 028ba5f commit 6f3dca53756523ce11fcf1b6c60bb09b7171cf60
Showing with 31 additions and 0 deletions.
  1. +31 −0 README.md
View
@@ -0,0 +1,31 @@
## What is in this repository?
This is an [Open Build Service (OBS) Source
Service](https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.source_service.html)
to allow clang builds for Debian packages.
An OBS instance using this package to rebuild Debian Unstable packages against
clang is available at [irill8.siege.inria.fr](https://irill8.siege.inria.fr).
## How to use this package?
Since this Source Service is supposed to be used in `buildtime` mode, it must be available
to the OBS project as a package (just build this package in your OBS project and make sure
the `Use for Build Flag` is enabled).
Then, you must activate the source service for the target package. To do so,
read [OBS Source Service
documentation](https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.source_service.html).
In short, you need to add a `_service` file to the target package working
directory with the following content:
```
<services>
<service name="clang_build" mode="buildtime" />
</services>
```
and trigger the target package build.
Check the build log, searching for `Running build time source services...` to
make sure your source service was triggered.

0 comments on commit 6f3dca5

Please sign in to comment.