obs/README: add overview with build_binpkg.py

Related: OS#2385
Change-Id: I1b741ad325e6541e6d59dfd50de66bee805e56fe
---
M scripts/obs/README
1 file changed, 19 insertions(+), 0 deletions(-)


git pull ssh://gerrit.osmocom.org:29418/osmo-ci refs/changes/05/29605/1

diff --git a/scripts/obs/README b/scripts/obs/README
index cd0955d..f761f1e 100644
--- a/scripts/obs/README
+++ b/scripts/obs/README
@@ -1,3 +1,22 @@
+Overview
+========
+This directory contains the following scripts, related to building Osmocom
+projects in OBS (Open Build Service) and building binary packages. Here is an
+overview of the scripts, run them with -h to get a more detailed description.
+
+* build_srcpkg.py: build one source package for an Osmocom project
+* update_obs_project.py: generate source packages and upload them to OBS
+* build_binpkg.py: build rpm/deb packages for one Osmocom project
+
+Docker
+------
+The above scripts have a -d parameter, that allows running them inside docker.
+This is how we run it in jenkins to avoid installing dependencies on the host.
+
+Note that when building binary packages, libosmocore socket tests and possibly
+others will fail unless docker has ipv6 configured:
+https://osmocom.org/issues/4700#note-3
+
 Usage Example: Submitting source packages to Osmocom's OBS build server
 =======================================================================
 

