summaryrefslogtreecommitdiff
path: root/HACKING
blob: 37c366cb55e2601462c7b6d8671d2a69f5209ba2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

This file is used to document items of interest to developers wishing to become
contributers to the kiki project.

=== Dependencies Policy ===
* The current approach in terms of library dependencies is as follows:

	1) It should work with libraries bundled with Debian on both
	Debian Wheezy and Debian Jessie.

	2) Development occurs on Jessie first, and then the build is
	backported to Wheezy.

	3) When backporting, it is preferred to use libraries available
	in Wheezy unless the effort would be too great and then it is
	prefered to use dependency versions that are already packaged for
	Jessie.

	4) Exceptions can be made for must-have features in libraries
	not packaged for Jessie.  In which case, it is prefered to use
	a version packaged for Sid, and if not available in Sid,
	Experimental, and if not Experimental, then whatever is currently
	available through cabal/hackage.  And finally as a last resort,
	whatever is available via git.

* This approach keeps the code base fresh without limiting it's ease of install
  and utility on existing systems.


Note about current dependency status:

Because cryptohash is already packaged for Wheezy and I want to avoid depending
a newer version of the library, I've backported the following to work with
cryptohash-0.7.5:

	crypto-pubkey-0.2.4 (needed to add conditional compilation)
	x509-v1.4.5         (changed only the constraint in the cabal file)