Difference between revisions of "Dh-make-mahara"

From Mahara Wiki

(Move from internal documentation)
(Source Control: gitpublic is meaningless)
Line 9: Line 9:
=== Source Control ===
=== Source Control ===
dh-make-mahara is in [;a=summary gitpublic]:
dh-make-mahara is in;a=summary
<pre>git clone git://</pre>
<pre>git clone git://</pre>

Latest revision as of 16:32, 7 September 2011

dh-make-mahara (DHMM) will build Debian packaging for a given Mahara checkout, and can be run again in a directory that has already been converted in order to install fixes to the debian packaging.

It installs all of the normal files, such as rules, control, postinst etc. Some of these files it expects to be the sole author of, and some of them are left to the maintainer to deal with. It also installs a couple of files that are not normally in debian packaging, but that it requires, such as debian/

When a fix to dh-make-mahara needs to be applied to an existing debianised Mahara, simply run dh-make-mahara on it again. It will show you the differences and ask if you really want to upgrade.

Getting dh-make-mahara

Source Control

dh-make-mahara is in;a=summary

git clone git://


Let's assume that you have a Mahara checkout for a client at $HOME/work/mahara-client.

Performing the Initial Debianisation

[email protected]:~$ --basepath $HOME/work/mahara-client
What name should be given to this Mahara installation? This should be a
short name, all in lower-case, that will be used for the debian package
name and filesystem paths.
Mahara Installation Name: client

Who is the maintainer for the installation?
Maintainer Name [Nigel McNie]: [Nigel McNie]

What is the e-mail address of the maintainer?
Maintainer E-mail [[email protected]]: [[email protected]]

Now at dhmm 0.2.4
[email protected]:~$ 

Some questions are asked, in order to set up the initial packaging.

You have to give a name for the installation, which will be used in the debian package name. You can specify this on the command line with the --name argument if you wish.

The maintainer question defaults will be automatically guessed from your environment - in particular, DEBFULLNAME and DEBEMAIL, if you have them set.

If you like, you can specify the --assume-defaults argument to dh-make-mahara, which will result in it asking you no questions:

[email protected]:~$ --basepath $HOME/work/mahara-client --name client --assume-defaults
Now at dhmm 0.2.4
[email protected]:~$ 

Version Numbers

The package will be given a version number of the Mahara upstream version as obtained from htdocs/lib/version.php. Every time the package is built, if the upstream version is incorrect then it will be corrected for you, and you will be given the chance to commit the change. You can run the sanity checker script manually if you like, to ensure you have got it correct:

[email protected]:~/work/mahara-client$ sh debian/
Debian changelog version is not equal to the upstream version, fixing this for you...
Done. Now git commit the result.
[email protected]:~/work/mahara-client$

Then you can commit the new changelog and run 'make' as normal.

Building and Installing the Package

You're largely done with dh-make-mahara at this point. Now you just need to customise the apache configuration as you see fit, then build and install the package.

To build the package for the first time, change to the $HOME/work/mahara-client directory. Before building the package, have a look in debian/apache.conf. This is the template file from which your apache configuration will be made. If you add more __MARKER__ placeholders in this file, a debconf question will be asked for you to fill in each one when the package is installed.

Once you are done playing with the apache config, run make:

[email protected]:~/work/mahara-client$ make
sh debian/
dpkg-buildpackage -rfakeroot -us -uc -b -tc
dpkg-buildpackage: source package mahara-site-client
dpkg-buildpackage: source version 1.0.0-1
dpkg-buildpackage: source changed by Nigel McNie <[email protected]>
dpkg-buildpackage: host architecture i386
 fakeroot debian/rules clean
make[1]: Entering directory `/home/nigel/work/mahara-client'
make[1]: Leaving directory `/home/nigel/work/mahara-client'
 debian/rules build
make[1]: Entering directory `/home/nigel/work/mahara-client'
make[1]: Nothing to be done for `build'.
make[1]: Leaving directory `/home/nigel/work/mahara-client'
 fakeroot debian/rules binary
make[1]: Entering directory `/home/nigel/work/mahara-client'
dpkg-deb: building package `mahara-site-client' in `../mahara-site-client_1.0.0-1_all.deb'.
make[1]: Leaving directory `/home/nigel/work/mahara-client'
 dpkg-genchanges -b >../mahara-site-client_1.0.0-1_i386.changes
dpkg-genchanges: binary-only upload - not including any source code
 fakeroot debian/rules clean
make[1]: Entering directory `/home/nigel/work/mahara-client'
make[1]: Leaving directory `/home/nigel/work/mahara-client'
dpkg-buildpackage: binary only upload (no source included)
[email protected]:~/work/mahara-client$ 

The package will be in the parent directory. You can run lintian on it if you want - it will most likely moan about some included license files, and that the first release of a package should close an ITP bug, which is a debianism that can be ignored.

Copy it to wherever you're installing the package and install it. You will be asked debconf questions for the database details, and for any markers that are in your apache config - likely at least server name.

Upgrading the Package

Now let's assume you have new changes you wish to roll out. You need to increment the version of the debian package, and build the package again:

[email protected]:~/work/mahara-client$ dch -i
[edit the changelog]
[email protected]:~/work/mahara-client$ make

What happens when I want to change the apache configuration?

Changing the apache configuration involves rebuilding the package, just as with any other upgrade. If you add a new __MARKER__ in your apache config, when you install the package you will be asked to fill in the value for that question, as you would expect.

If you remove a marker, the question template will still remain in debian/templates, as will the db_input line in debian/config. If you're really sure, you can edit those files and remove them, but if you're not sure then at least if you put the marker back later, debconf on any server you upgrade the package on will still know the value for it.

How do I make the questions more user friendly?

Simply run the apache templater manually, then edit debian/templates to change the wording of the questions:

[email protected]:~/work/mahara-client$ sh debian/
[email protected]:~/work/mahara-client$ vim debian/templates

What happens if there is a bug in a part of the debian packaging that DHMM is responsible for?

You need to fix, or get someone else to fix, the bug in dh-make-mahara itself. Then run the new version against your installation. dh-make-mahara will show you a diff of changes between the new and old packaging, and if you accept, it will apply them.

Here is an example where there was a bug in the postinst. Running the fixed version of dh-make-mahara against the existing codebase imported the fix:

[email protected]:~$ --basepath $HOME/work/mahara-client
diff -u /home/nigel/work/mahara-client/debian-pre-dhmm/postinst /home/nigel/work/mahara-client/debian/postinst
--- /home/nigel/work/mahara-client/debian-pre-dhmm/postinst	2008-02-08 17:26:52.000000000 +1300
+++ /home/nigel/work/mahara-client/debian/postinst	2008-02-08 17:26:52.000000000 +1300
@@ -73,13 +73,13 @@
-            cp /var/lib/sitedata/mahara-site-client/apache.conf.working /etc/apache2/sites-available/mahara-site-client.conf
+            mv /var/lib/sitedata/mahara-site-client/apache.conf.working /etc/apache2/sites-available/mahara-site-client.conf
             if [ "$ENABLE_SITE" != "" ]; then
                 a2ensite mahara-site-client.conf
         elif [ -d /etc/apache/conf.d ]; then
-            cp /var/lib/sitedata/mahara-site-client/apache.conf.working /etc/apache/conf.d/mahara-site-client.conf
+            mv /var/lib/sitedata/mahara-site-client/apache.conf.working /etc/apache/conf.d/mahara-site-client.conf
             echo "[strange] apache or apache2 config directories not detected. I left your"
             echo "config file in /var/lib/sitedata/mahara-site-client"
Does this diff look ok?: y
Upgraded to dhmm 0.0.2
[email protected]:~$