Merge commit 'garage/master'
[wpasupplicant] / debian / README.source
1 Patch System
2 ============
3 The quilt patch system is used. `debian/rules patch` is necessary to replicate
4 the source tree that is used to produce resulting binary packages.
5
6 Manual Page Handling
7 ====================
8 In order to have the manual pages recreated at build time, they must be removed
9 from our package tree. We do this simply by omitting the prebuilt manual pages
10 from our SVN. When using svn-upgrade, this must be done manually post-upgrade
11 to avoid confusing subversion, or else if the debian/rules clean target is used
12 in the package svn working copy (default svn-buildpackage behaviour) the
13 prebuilt manual pages would be removed without subversion knowing about it.
14
15 svn revert wpa_supplicant/doc/docbook/*.5 wpa_supplicant/doc/docbook/*.8
16 svn delete wpa_supplicant/doc/docbook/*.5 wpa_supplicant/doc/docbook/*.8
17
18
19 Prebuilt manual pages are supplied upstream releases, but are not present in
20 git snapshots. Rebuilding the manual pages at build time yields two advantages:
21
22 1. No need to modify build rules when packaging git snapshots
23
24 2. Allows opportunity to patch in debian specific documentation to enhance user
25    experience
26
27
28 It is expected that dpkg-source will warn about their removal:
29
30 dpkg-source: building wpasupplicant using existing wpasupplicant_0.6.2.orig.tar.gz
31 dpkg-source: building wpasupplicant in wpasupplicant_0.6.2-1.diff.gz
32 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_supplicant.8
33 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_supplicant.conf.5
34 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_priv.8
35 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_passphrase.8
36 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_gui.8
37 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_cli.8
38 dpkg-source: warning: ignoring deletion of file wpa_supplicant/doc/docbook/wpa_background.8
39 dpkg-source: building wpasupplicant in wpasupplicant_0.6.2-1.dsc