From 2036d2ee1ead7dff2933a8335248af256e6deba3 Mon Sep 17 00:00:00 2001 From: Santiago Rodriguez <santi@trisquel.info> Date: Wed, 24 Jun 2015 22:04:43 +0200 Subject: [PATCH] README.md : updated to show the current workflow --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d61aba61..aa86fa65 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## Introduction -This set of scripts are helpers that modify and compile those packages coming +This set of scripts are helpers that modify and create the source packages coming from the Ubuntu upstream which need it. It might be because they contain non-free stuff, references to Ubuntu that need to be changed, or because we want the package to work our way. @@ -9,20 +9,29 @@ This helpers are similar to some of those in the [gNewSense](http://www.gnewsens some ideas and even some lines from them. If you plan to build an Ubuntu derivative of your own, we suggest you to use Builder instead of this helpers. -All packages in this list are in the appropriate blacklist in the repository -updater, so they never enter into the repo from upstream and need to be -compiled with this helpers and pushed into reprepro. This helpers also need -to be run by hand - and the results tested - any time the repo watchdog warns -about pending updates from upstream. +Once a new package is added, it takes priority over the original one from Ubuntu, +so they never enter into the repo from upstream and need to be +compiled with this helpers and pushed into reprepro. -To add a package to the list, just copy one - `make-apache2` is a good template - -and rename it to `make-sourcePackageName`. To send the file back to us, or to -include any modification into the current scripts, use `bzr diff` and send -the output as an attachment to trisquel-devel@listas.trisquel.info. You need -to join the mailing list to send messages to it. +To add a package to the list, follow the [CONTRIBUTING](https://devel.trisquel.info/trisquel/package-helpers/blob/belenos/CONTRIBUTING.md) guidelines. + +## Steps + +Those are the steps done by the helpers: + +1. Create local apt configuration, so you don't need to be root to run the helpers +2. Get the ubuntu and trisquel gpg keys +3. Get the source packages from their original repo +4. Uncompress them +5. Apply the changes described in the helper +6. Re-package it, adding "triquel$VERSION" version string ## Recommendations +* You don't need to use sudo in order to run those scripts, but some extra packages are needed: + + `sudo apt-get install dpkg-dev sed git rpl devscripts quilt patch` + * Take care to use the right sourcePackageName, many source packages produce several binary packages. `apt-cache showsrc binary-package` can help you. * If possible, use sed to replace chains in the upstream source without the @@ -32,9 +41,8 @@ it at the `DATA/sourcePackageName` directory would actually be shown to the user. Avoid replacing copyright statements! * Try to write your replacements in a way they might work in future versions of the upstream package. Well written regexps and sed will help with that. -* Some of this packages require the lsb to match Trisquel values. Edit the -`/etc/lsb_release` accordingly, or run the helpers in a Trisquel box. -* You can - and maybe should - run this scripts inside a chroot. +* You can test your changes by doing them inside the _PACKAGES/sourcePackageName/source/_ directory, +and running `dpkg-source -b .`, before being added to the helper script ## Netinstall @@ -54,3 +62,4 @@ To generate the images, we run the following scripts: Then we push the results into the Trisquel repository and run the script `make-debian-installer` to build the final images. + -- GitLab