Skip to content

Commit 6f3dca5

Browse files
committed
Add README file with package documentation
1 parent 028ba5f commit 6f3dca5

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## What is in this repository?
2+
3+
This is an [Open Build Service (OBS) Source
4+
Service](https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.source_service.html)
5+
to allow clang builds for Debian packages.
6+
7+
An OBS instance using this package to rebuild Debian Unstable packages against
8+
clang is available at [irill8.siege.inria.fr](https://irill8.siege.inria.fr).
9+
10+
## How to use this package?
11+
12+
Since this Source Service is supposed to be used in `buildtime` mode, it must be available
13+
to the OBS project as a package (just build this package in your OBS project and make sure
14+
the `Use for Build Flag` is enabled).
15+
16+
Then, you must activate the source service for the target package. To do so,
17+
read [OBS Source Service
18+
documentation](https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.source_service.html).
19+
In short, you need to add a `_service` file to the target package working
20+
directory with the following content:
21+
22+
```
23+
<services>
24+
<service name="clang_build" mode="buildtime" />
25+
</services>
26+
```
27+
28+
and trigger the target package build.
29+
30+
Check the build log, searching for `Running build time source services...` to
31+
make sure your source service was triggered.

0 commit comments

Comments
 (0)