integrate comments from Tanguy Ortolo and Jean Privat
[packaging-tutorial.git] / packaging-tutorial.tex
1 \documentclass[10pt,final]{beamer}
2 \mode<presentation>
3 \usetheme{debian}
4 \usepackage{debiantutorial}
5
6 \hypersetup{pdftitle={Debian Packaging Tutorial},bookmarks}
7 \title{Debian Packaging Tutorial}
8 \author[]{Lucas Nussbaum\\{\small\texttt{lucas@debian.org}}}
9 \date{\footnotesize version 0.1 - 2011-05-05}
10
11 \begin{document}
12
13 \frame{\titlepage}
14
15 \begin{frame}{About this tutorial}
16   \begin{itemize}
17   \item Goal: \textbf{tell you what you really need to know about Debian packaging}
18     \begin{itemize}
19       \hbr
20     \item Modify existing packages
21       \hbr
22     \item Create your own packages
23             \hbr
24     \item Interact with the Debian community
25       \hbr
26     \item Become a Debian power-user
27     \end{itemize}
28     \br
29   \item Covers the most important points, but is not complete
30     \begin{itemize}
31     \item You will need to read more documentation
32     \end{itemize}
33     \br
34   \item Most of the content also applies to Debian derivatives distributions
35     \begin{itemize}
36       \hbr
37     \item That includes Ubuntu
38     \end{itemize}
39   \end{itemize}
40 \end{frame}
41
42 \begin{frame}{Outline}
43   \tableofcontents[hideallsubsections]
44 \end{frame}
45
46 \section{Introduction}
47
48 \subsection{Debian}
49
50 \begin{frame}{Debian}
51         \begin{itemize}
52                 \item \textbf{GNU/Linux distribution}
53                         \br
54                 \item 1st major distro developed "openly in the spirit of GNU"
55                         \br
56                 \item \textbf{Non-commercial}, built collaboratively by more than 1000 volunteers
57                         \br
58                 \item 30000 binary packages ; 12 ports (inc. 2 non-Linux) ; 120 derivatives
59                         \br
60                 \item 3 main features:
61                         \begin{itemize}
62                                 \item \textbf{Quality} -- culture of technical excellence\\
63                                         {\small\sl We release when it's ready}
64                                         \hbr
65                                 \item \textbf{Freedom} -- devs and users bound by the \textsl{Social Contract}\\
66                                         Promoting the culture of Free Software since 1993
67                                         \hbr
68                                 \item \textbf{Independence} -- no (single) company babysitting Debian\\
69                                         And open decision-making process (\textsl{do-ocracy} + \textsl{democracy})
70                         \end{itemize}
71         \end{itemize}
72 \end{frame}
73
74
75
76 \subsection{The Deb package format}
77
78 \begin{frame}[fragile]{The Deb package format}
79   \begin{itemize}
80   \item One of the two most common packages format (with RPM)
81   \item A very powerful and convenient way to distribute software to users
82   \item \texttt{.deb} file: an \texttt{ar} archive
83     \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
84 $ ar tv wget_1.12-2.1_i386.deb
85 rw-r--r-- 0/0      4 Sep  5 15:43 2010 debian-binary
86 rw-r--r-- 0/0   2403 Sep  5 15:43 2010 control.tar.gz
87 rw-r--r-- 0/0 751613 Sep  5 15:43 2010 data.tar.gz
88     \end{lstlisting} % $
89     \begin{itemize}
90     \item \texttt{debian-binary}: version of the deb file format, \texttt{"2.0\textbackslash{}n"}
91     \item \texttt{control.tar.gz}: metadata about the package\\
92       {\small \texttt{\textbf{control}, md5sums, (pre|post)(rm|inst), triggers, shlibs}, \ldots}
93     \item \texttt{data.tar.gz}: data files of the package
94     \end{itemize}
95   \item You could create your \texttt{.deb} files manually\\
96     {\footnotesize \url{http://tldp.org/HOWTO/html\_single/Debian-Binary-Package-Building-HOWTO/}}
97   \item But most people don't do it that way
98   \end{itemize}
99   \hbr
100   \centerline{\textbf{This tutorial: create Debian packages, the Debian way}}
101 \end{frame}
102
103 \subsection{Tools you will need}
104 \begin{frame}{Tools you will need}
105   \begin{itemize}
106   \item A Debian (or Ubuntu) system (with root access)
107     \br
108   \item Some packages:
109     \begin{itemize}
110     \item \textbf{build-essential}: has dependencies on the packages that will
111       be assumed to be available on the developers' machine (no need to specify
112       them in the \texttt{Build-Depends:} control field of your package)
113       \begin{itemize}
114       \item includes a dependency on \textbf{dpkg-dev}, which contains basic
115         Debian-specific tools to create packages
116       \end{itemize}
117       \hbr
118     \item \textbf{devscripts}: contains many useful scripts for Debian
119       maintainers
120     \end{itemize}
121   \end{itemize}
122
123   \br
124   Many other tools will also be mentioned later, such as \textbf{debhelper},
125   \textbf{cdbs}, \textbf{quilt}, \textbf{pbuilder}, \textbf{sbuild},
126   \textbf{lintian}, \textbf{svn-buildpackage}, \textbf{git-buildpackage},
127   \ldots\\
128   Install them when you need them.
129 \end{frame}
130
131 \subsection{General packaging workflow}
132 \begin{frame}{General packaging workflow}
133   \begin{center}
134     \begin{tikzpicture}[
135       node1/.style={shape=rectangle,draw=rouge,fill=debianbackgroundblue,thick},
136       arr/.style={very thick}, command/.style={text=rouge,font=\ttfamily}, ]
137       
138       \node[node1] (www) at (0, 0) {Web};
139       \node[node1] (us) at (2.5, 0) {upstream source};
140       \node[node1] (da) at (-2.5, 0) {Debian mirror};
141       \node[node1] (sp) at (0, -2) {source package};
142       \draw[arr,<-,dashed,thick] (sp) -- (2.5,-2) node[right=0cm,text width=2.98cm,text centered,font=\small\sl] {where most of the manual work is done};
143       \node[node1] (bin) at (0, -4) {one or several binary packages};
144       \draw[arr,<-,dashed,thick] (bin) -- (3.5,-4) node[right,text centered,font=\small\ttfamily\sl] {.deb\normalfont};
145       \draw[arr,->] (us) -- (sp) node[pos=0.5,right,command] {dh\_make};
146       \draw[arr,->] (da) -- (sp) node[pos=0.5,left,command] {apt-get source};
147       \draw[arr,->] (www) -- (sp) node[pos=0.5,left,command] {dget};
148       \draw[arr,->] (sp) -- (bin) node[pos=0.5,right,text width=6cm] {\textttc{debuild} (build and test with \textttc{lintian}) or \textttc{dpkg-buildpackage}};
149       \draw[arr,->] (bin) -- (1,-6) node[pos=0.5,right] {install (\textttc{debi})};
150       % \draw[arr,->] (bin) -- (-1,-6) node[pos=0.5,left] {upload (\textttc{dput})};
151       \draw[transparent] (bin) -- (-1,-6) node[pos=0.5,left,opaque] {upload (\textttc{dput})};
152       \draw[arr,->,rounded corners] (bin) -- (-1,-6) -- (-4.5,-6) -- (-4.5,0) -- (da);
153       \useasboundingbox (-4,-6) rectangle (6,0); % hack hack hack
154     \end{tikzpicture}
155   \end{center}
156 \end{frame}
157
158 \section{Creating source packages}
159 \subsection{Source packages basics}
160 \begin{frame}{Source package}
161   \begin{itemize}
162   \item One source package can generate several binary packages\\
163     {\small e.g the \texttt{\bfseries libtar} source generates the
164       \texttt{\bfseries libtar} and \texttt{\bfseries libtar-dev} binary
165       packages} \hbr
166   \item Two kinds of packages: (if unsure, use non-native)
167     \begin{itemize}
168       \small
169     \item Native packages: software developed inside Debian (\textsl{dpkg}, \textsl{apt})
170     \item Non-native packages: software developed outside Debian
171     \end{itemize}
172     \hbr
173   \item Main file: \texttt{.dsc} (meta-data)
174     \hbr
175   \item Other files depending on the version of the source format
176     \begin{itemize}
177     \item 1.0 -- native: \texttt{package\_version.tar.gz}
178       \hbr
179     \item 1.0 -- non-native:
180       \begin{itemize}
181       \item \texttt{pkg\_ver.orig.tar.gz} : upstream source
182       \item \texttt{pkg\_debver.diff.gz} : patch to add Debian-specific changes
183       \end{itemize}
184       \hbr
185     \item 3.0 (quilt):
186       \begin{itemize}
187       \item \texttt{pkg\_ver.orig.tar.gz} : upstream source
188       \item \texttt{pkg\_debver.debian.tar.gz} : tarball with the Debian changes
189       \end{itemize}
190     \end{itemize}
191   \end{itemize}
192   \br
193   (See \texttt{dpkg-source(1)} for exact details)
194 \end{frame}
195
196 \begin{frame}[fragile]{Source package example (wget\_1.12-2.1.dsc)}
197   \begin{lstlisting}[basicstyle=\ttfamily\small]
198 Format: 3.0 (quilt)
199 Source: wget
200 Binary: wget
201 Architecture: any
202 Version: 1.12-2.1
203 Maintainer: Noel Kothe <noel@debian.org>
204 Homepage: http://www.gnu.org/software/wget/
205 Standards-Version: 3.8.4
206 Build-Depends: debhelper (>> 5.0.0), gettext, texinfo,
207  libssl-dev (>= 0.9.8), dpatch, info2man
208 Checksums-Sha1: 
209  50d4ed2441e67[..]1ee0e94248 2464747 wget_1.12.orig.tar.gz
210  d4c1c8bbe431d[..]dd7cef3611 48308 wget_1.12-2.1.debian.tar.gz
211 Checksums-Sha256: 
212  7578ed0974e12[..]dcba65b572 2464747 wget_1.12.orig.tar.gz
213  1e9b0c4c00eae[..]89c402ad78 48308 wget_1.12-2.1.debian.tar.gz
214 Files: 
215  141461b9c04e4[..]9d1f2abf83 2464747 wget_1.12.orig.tar.gz
216  e93123c934e3c[..]2f380278c2 48308 wget_1.12-2.1.debian.tar.gz
217 \end{lstlisting}
218 \end{frame}
219
220 \subsection{Retrieving source packages}
221 \begin{frame}{Retrieving an existing source package}
222   \begin{itemize}
223   \item From the Debian archive:
224     \begin{itemize}
225     \item \texttt{apt-get source \textsl{package}}
226     \item \texttt{apt-get source \textsl{package=version}}
227     \item \texttt{apt-get source \textsl{package/release}}
228     \end{itemize}
229     (You need \texttt{deb-src} lines in \texttt{sources.list})
230     \br
231   \item From the Internet:
232     \begin{itemize}
233     \item \texttt{dget \textsl{url-to.dsc}}
234     \item \texttt{dget http://snapshot.debian.org/archive/debian-archive/\\20090802T004153Z/debian/dists/bo/main/source/web/\\
235         wget\_1.4.4-6.dsc}\\ 
236       (\href{http://snapshot.debian.org/}{\ttfamily snapshot.d.o} provides all packages from Debian since 2005)
237     \end{itemize}
238     \br
239   \item Once downloaded, extract with \texttt{dpkg-source -x \textsl{file.dsc}}
240   \end{itemize}
241 \end{frame}
242
243 \subsection{Creating a basic source package}
244 \begin{frame}{Creating a basic source package}
245   \begin{itemize}
246   \item Download the upstream source\\
247     (\textsl{upstream source} = the one from the software's original developers)
248     \hbr
249   \item Rename to \texttt{<\textsl{source\_package}>\_<\textsl{upstream\_version}>.orig.tar.gz}\\
250     (example: \texttt{simgrid\_3.6.orig.tar.gz})
251     \hbr
252   \item Untar it
253     \hbr
254   \item \texttt{cd \textsl{upstream\_source} \&\& dh\_make} (from the \textbf{dh-make} package)
255     \hbr
256   \item There are some alternatives to \texttt{dh\_make} for specific sets of
257     packages: \textbf{dh-make-perl}, \textbf{dh-make-php}, \ldots \hbr
258   \item \texttt{debian/} directory created, with a lot of files in it
259   \end{itemize}
260 \end{frame}
261
262 \subsection{Files in debian/}
263 \begin{frame}{Files in debian/}
264   All the packaging work should be made by modifying files in \texttt{debian/}
265   \hbr
266   \begin{itemize}
267   \item Main files:
268     \begin{itemize}
269     \item \textbf{changelog} -- history of the Debian package
270     \item \textbf{copyright} -- copyright information for the package
271     \item \textbf{control} -- meta-data about the package (dependencies, etc)
272     \item \textbf{rules} -- specifies how to build the package
273     \end{itemize}
274     \hbr
275   \item Optional files:
276     \begin{itemize}
277     \item compat
278     \item watch
279     \item dh\_install* targets\\
280       {\small *.dirs, *.docs, *.manpages, \ldots}
281     \item maintainer scripts\\
282       {\small *.postinst, *.prerm, \ldots}
283     \item source/format
284     \item patches -- if you need to modify the upstream sources
285     \end{itemize}
286     \hbr
287   \item Most of the files use a format based on RFC 822 (mail headers)
288   \end{itemize}
289 \end{frame}
290
291 \begin{frame}[fragile]{debian/changelog}
292   \begin{itemize}
293   \item Lists the Debian packaging changes
294   \item Edited manually or with \texttt{dch}
295   \item Special format to automatically close Debian or Ubuntu bugs\\
296     Debian: \texttt{Closes:~\#595268} ; Ubuntu: \texttt{LP:~\#616929}
297   \item Installed as \texttt{/usr/share/doc/\textit{package}/changelog.Debian.gz}
298   \end{itemize}
299   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
300 mpich2 (1.2.1.1-5) unstable; urgency=low
301
302   * Use /usr/bin/python instead of /usr/bin/python2.5. Allow
303     to drop dependency on python2.5.  Closes: #595268
304   * Make /usr/bin/mpdroot setuid. This is the default after
305     the installation of mpich2 from source, too. LP: #616929
306     + Add corresponding lintian override.
307
308  -- Lucas Nussbaum <lucas@debian.org>  Wed, 15 Sep 2010 18:13:44 +0200
309 \end{lstlisting}
310 \end{frame}
311
312 \begin{frame}[fragile]{debian/copyright}
313   \hbr
314   \begin{itemize}
315   \item Copyright and license information for the source and the packaging
316   \item Traditionally written as a text file
317   \item New machine-readable format: \url{http://dep.debian.net/deps/dep5/}
318   \end{itemize}
319   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
320 Format: <VERSIONED_FORMAT_URL>
321 Upstream-Name: X Solitaire
322 Source: ftp://ftp.example.com/pub/games
323
324 Files: *
325 Copyright: Copyright 1998 John Doe <jdoe@example.com>
326 License: GPL-2+
327  This program is free software; you can redistribute it
328  [...]
329  .
330  On Debian systems, the full text of the GNU General Public
331  License version 2 can be found in the file
332  `/usr/share/common-licenses/GPL-2'.
333
334 Files: debian/*
335 Copyright: Copyright 1998 Jane Smith <jsmith@example.net>
336 License:
337  [LICENSE TEXT]
338 \end{lstlisting}
339 \end{frame}
340
341 \begin{frame}[fragile]{debian/control}
342   \hbr
343   \begin{itemize}
344   \item Package metadata
345     \begin{itemize}
346     \item For the source package itself
347     \item For each binary package built from this source
348     \end{itemize}
349     \hbr
350   \item Package name, section, priority, maintainer, uploaders,
351     build-dependencies, dependencies, description, homepage, \ldots \hbr
352   \item Documentation: Debian Policy chapter 5\\
353     \url{http://www.debian.org/doc/debian-policy/ch-controlfields.html}
354   \end{itemize}
355 \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
356 Source: wget
357 Section: web
358 Priority: important
359 Maintainer: Noel Kothe <noel@debian.org>
360 Build-Depends: debhelper (>> 5.0.0), gettext, texinfo,
361  libssl-dev (>= 0.9.8), dpatch, info2man
362 Standards-Version: 3.8.4
363 Homepage: http://www.gnu.org/software/wget/
364
365 Package: wget
366 Architecture: any
367 Depends: ${shlibs:Depends}, ${misc:Depends}
368 Description: retrieves files from the web
369  Wget is a network utility to retrieve files from the Web
370 \end{lstlisting}
371 \end{frame}
372
373 \begin{frame}{Architecture: all or any}
374   Two kinds of binary packages:
375   \hbr
376   \begin{itemize}
377   \item Packages with a different content on each Debian architecture
378     \begin{itemize}
379     \item Example: C program
380     \item \texttt{Architecture:\ any} in \texttt{debian/control}
381       \begin{itemize}
382       \item Or, if it only works on a subset of architectures:\\
383         \texttt{Architecture:\ amd64 i386 ia64 hurd-i386}
384       \end{itemize}
385     \item Packages for other architectures built by the Debian infrastructure
386     \item Named \texttt{\textsl{package}\_\textsl{version}\_\textsl{architecture}.deb}
387     \end{itemize}
388     \br
389   \item Packages with the same content on all architectures
390     \begin{itemize}
391     \item Example: Perl library
392     \item \texttt{Architecture:\ all} in \texttt{debian/control}
393     \item Named \texttt{\textsl{package}\_\textsl{version}\_\textbf{all}.deb}
394     \end{itemize}
395   \end{itemize}
396 \end{frame}
397
398 \begin{frame}[fragile]{debian/rules}
399   \hbr
400   \begin{itemize}
401   \item Makefile
402     \br
403   \item Interface used to build Debian packages
404     \br
405   \item Documented in Debian Policy, chapter 4.8\\
406     {\small \texttt{http://www.debian.org/doc/debian-policy/ch-source.html\#s-debianrules}}
407     \br
408   \item Five required targets:
409     \begin{itemize}
410     \item \texttt{build}: should perform all the configuration and compilation
411       \hbr
412     \item \texttt{binary, binary-arch, binary-indep}: build the binary packages
413       \begin{itemize}
414       \item \texttt{dpkg-buildpackage} will call \texttt{binary} to build all
415         the packages, or \texttt{binary-arch} to build only the
416         \texttt{Architecture:~any} packages
417       \end{itemize}
418       \hbr
419     \item \texttt{clean}: clean up the source directory
420     \end{itemize}
421   \end{itemize}
422 \end{frame}
423
424 \subsection{Packaging helpers}
425 \begin{frame}{Packaging helpers -- debhelper}
426   \begin{itemize}
427   \item You could write shell code in \texttt{debian/rules} directly
428     \begin{itemize}
429     \item See the \texttt{adduser} package for example
430     \end{itemize}
431     \hbr
432   \item Better practice (used by most packages): use a \textsl{Packaging helper}
433     \hbr
434   \item Most popular one: \textbf{debhelper} (used by 98\% of packages)
435     \hbr
436   \item Goals:
437     \begin{itemize}
438     \item Factor the common tasks in standard tools used by all packages
439     \item Fix some packaging bugs once for all packages
440     \end{itemize}
441     {\footnotesize dh\_installdirs, dh\_installchangelogs, dh\_installdocs,
442       dh\_installexamples, dh\_install, dh\_installdebconf, dh\_installinit,
443       dh\_link, dh\_strip, dh\_compress, dh\_fixperms, dh\_perl,
444       dh\_makeshlibs, dh\_installdeb, dh\_shlibdeps, dh\_gencontrol,
445       dh\_md5sums, dh\_builddeb, \ldots}
446     \begin{itemize}
447     \item Called from \texttt{debian/rules}
448     \item Configurable using command parameters or files in \texttt{debian/}
449     \end{itemize}
450     {\footnotesize \ttfamily dirs, package.docs, package.examples,
451       package.install, package.manpages, \ldots} \hbr
452   \item Third-party helpers for sets of packages: \textbf{python-support},
453     \textbf{dh\_ocaml}, \ldots \hbr
454   \item Gotcha: \texttt{debian/compat}: Debhelper compatibility version (use "7")
455   \end{itemize}
456 \end{frame}
457
458 \begin{frame}[fragile]{debian/rules using debhelper (1/2)}
459   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
460 #!/usr/bin/make -f
461
462 # Uncomment this to turn on verbose mode.
463 #export DH_VERBOSE=1
464
465 build: 
466         $(MAKE)
467         #docbook-to-man debian/packagename.sgml > packagename.1
468
469 clean: 
470         dh_testdir
471         dh_testroot
472         rm -f build-stamp configure-stamp
473         $(MAKE) clean
474         dh_clean 
475
476 install: build
477         dh_testdir
478         dh_testroot
479         dh_clean -k 
480         dh_installdirs
481         # Add here commands to install the package into debian/packagename.
482         $(MAKE) DESTDIR=$(CURDIR)/debian/packagename install
483 \end{lstlisting}
484 \end{frame}
485
486 \begin{frame}[fragile]{debian/rules using debhelper (2/2)}
487   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
488
489 # Build architecture-independent files here.
490 binary-indep: build install
491
492 # Build architecture-dependent files here.
493 binary-arch: build install
494         dh_testdir
495         dh_testroot
496         dh_installchangelogs 
497         dh_installdocs
498         dh_installexamples
499 #       dh_install
500         dh_installman
501         dh_link
502         dh_strip
503         dh_compress
504         dh_fixperms
505         dh_installdeb
506         dh_shlibdeps
507         dh_gencontrol
508         dh_md5sums
509         dh_builddeb
510
511 binary: binary-indep binary-arch
512 .PHONY: build clean binary-indep binary-arch binary install configure
513 \end{lstlisting}
514 \end{frame}
515
516 \begin{frame}[fragile]{CDBS}
517   \hbr
518   \begin{itemize}
519   \item Still a lot of redundancy between packages
520     \hbr
521   \item Second-level helpers that factor common funtionality
522     \begin{itemize}
523     \item Building with \texttt{./configure \&\& make \&\& make install} or CMake
524     \item Support for Perl, Python, Ruby, GNOME, KDE, Java, Haskell, \ldots
525     \end{itemize}
526     \hbr
527   \item CDBS:
528     \begin{itemize}
529     \item Introduced in 2005, based on advanced \textsl{GNU make} magic
530     \item Documentation: \texttt{/usr/share/doc/cdbs/}
531     \item But some people hate it:
532       \begin{itemize}
533       \item Sometimes difficult to customize package builds:\\
534         "\textsl{twisty maze of makefiles, environment vars and black magic}"
535       \item Slower than plain debhelper (many useless calls to \texttt{dh\_*})
536       \end{itemize}
537       \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
538 #!/usr/bin/make -f
539 include /usr/share/cdbs/1/rules/debhelper.mk
540 include /usr/share/cdbs/1/class/autotools.mk
541
542 # add an action after the build
543 build/mypackage::
544     /bin/bash debian/scripts/foo.sh
545       \end{lstlisting}
546     \end{itemize}
547   \end{itemize}
548 \end{frame}
549
550 \begin{frame}[fragile]{Dh (aka Debhelper 7, or dh7)}
551   \begin{itemize}
552   \item Introduced in 2008 as a \textsl{CDBS killer}
553     \hbr
554   \item \textbf{dh} command that calls \texttt{dh\_*}
555     \hbr
556   \item Simple \textsl{debian/rules}, listing only overrides
557     \hbr
558   \item Easier to customize than CDBS
559     \hbr
560   \item Doc: manpages (\texttt{debhelper(7)}, \texttt{dh(1)}) + slides from DebConf'9 talk\\
561     \url{http://kitenet.net/~joey/talks/debhelper/debhelper-slides.pdf}
562     \br
563     \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
564 #!/usr/bin/make -f
565 %:
566     dh $@
567
568 override_dh_auto_configure:
569      dh_auto_configure -- --with-kitchen-sink
570
571 override_dh_auto_build:
572      make world
573
574     \end{lstlisting}
575   \end{itemize} %$
576 \end{frame}
577
578 \begin{frame}{Classic debhelper vs CDBS vs dh}
579   \hbr
580   \begin{itemize}
581   \item Market shares: (feb'11)\\
582     Classic debhelper: 45\% \hskip 1em CDBS: 24\% \hskip 1em  dh: 29\%
583     \hbr
584   \item Which one should I learn?
585     \begin{itemize}
586     \item Probably all of them
587     \item You need to know debhelper to use dh and CDBS
588     \item You might have to modify CDBS packages
589     \end{itemize}
590     \hbr
591   \item Which one should I use for a new package?
592     \begin{itemize}
593     \item \textbf{dh} (only solution with an increasing market share)
594     \end{itemize}
595   \end{itemize}
596   
597   \hbr
598   \begin{center}
599     \begin{tikzpicture}
600 \begin{axis}[small,label style={font=\footnotesize},xlabel={\small Time},ylabel={\small Market share (\%)},
601         date coordinates in=x,height=4.85cm,width=9cm,xticklabel={\month/\year},
602              legend style={font=\footnotesize,at={(1.02,1)},anchor=north west},max space between ticks=82,try min ticks=5,ymin=0]
603         \addplot[mark=none,blue,thick] table[x=date,y=dh] {cdbs-dh7.txt};
604         \addplot[mark=none,red,thick] table[x=date,y=dh7] {cdbs-dh7.txt};
605         \addplot[mark=none,green,thick] table[x=date,y=cdbs] {cdbs-dh7.txt};
606         \legend{debhelper, dh, CDBS}
607 \end{axis}
608 \end{tikzpicture}
609 \end{center}
610
611 \end{frame}
612
613 \section{Building and testing packages}
614 \subsection{Building packages}
615 \begin{frame}{Building packages}
616   \begin{itemize}
617   \item \textttc{apt-get build-dep mypackage}\\
618     Installs the \textsl{build-dependencies} (for a package in the archive)
619     
620     \br
621   \item \textttc{debuild}: build, test with \texttt{lintian}, sign with GPG
622     \br
623   \item Also possible to call \textttc{dpkg-buildpackage} directly
624     \begin{itemize}
625     \item Usually with \texttt{dpkg-buildpackage -us -uc}
626     \end{itemize}
627     \br
628   \item It is better to build packages in a clean \& minimal environment
629     \begin{itemize}
630     \item \textttc{pbuilder} -- helper to build packages in a \textsl{chroot}\\
631       Good documentation: \url{https://wiki.ubuntu.com/PbuilderHowto}
632       \hbr
633     \item \textttc{schroot} and \textttc{sbuild}: used on the Debian build daemons\\
634       (not as easy to use as \texttt{pbuilder})
635     \end{itemize}
636     \br
637   \item Generate \texttt{.deb} files and a \texttt{.changes} file
638     \begin{itemize}
639     \item \texttt{.changes}: describes what was built ; used to upload the package
640     \end{itemize}
641   \end{itemize}
642 \end{frame}
643 \subsection{Installing and testing packages}
644 \begin{frame}{Installing and testing packages}
645   \begin{itemize}
646   \item Install the package locally: \textttc{debi} (will use \texttt{.changes}
647     to know what to install) \br
648   \item List the content of the package: \texttt{{\color{rouge}debc}
649       ../mypackage<TAB>.changes} \br
650   \item Compare the package with a previous version:\\
651     \texttt{{\color{rouge}debdiff} ../mypackage\_1\_*.changes ../mypackage\_2\_*.changes}\\
652     or to compare the sources:\\
653     \texttt{{\color{rouge}debdiff} ../mypackage\_1\_*.dsc ../mypackage\_2\_*.dsc}\\
654     \br
655   \item Check the package with \texttt{lintian} (static analyzer):\\
656     \texttt{{\color{rouge}lintian} ../mypackage<TAB>.changes}\\
657     \texttt{lintian -i}: gives more information about the errors \br
658   \item Upload the package to Debian (\textttc{dput}) (needs configuration) \br
659   \item Manage a private Debian archive with \textttc{reprepro}\\
660     Documentation: \url{http://mirrorer.alioth.debian.org/}
661   \end{itemize}
662 \end{frame}
663 \section{Practical session 1: modifying the grep package}
664 \begin{frame}{Practical session 1: modifying the grep package}
665   \begin{enumerate}
666   \item Go to \url{http://ftp.debian.org/debian/pool/main/g/grep/} and
667     download version 2.6.3-3 of the package
668   \item Look at the files in \texttt{debian/}.
669     \begin{itemize}
670     \item               How many binary packages are generated by this source package?
671     \item               Which packaging helper does this package use?
672     \end{itemize}
673   \item Build the package
674   \item We are now going to modify the package. Add a changelog entry and increase the version number.
675   \item Now disable perl-regexp support (it is a \texttt{./configure} option)
676   \item Rebuild the package
677   \item Compare the original and the new package with debdiff
678   \item Install the newly built package
679   \item Cry if you messed up ;)
680   \end{enumerate}
681 \end{frame}
682
683 \section{Advanced packaging topics}
684 \subsection{Modifying the upstream source}
685 \begin{frame}{Modifying the upstream source}
686   Often needed:
687   \begin{itemize}
688   \item Fix bugs or add customizations that are specific to Debian
689     \hbr
690   \item Backport fixes from a newer upstream release
691   \end{itemize}
692   \br
693   Several methods to do it:
694   \begin{itemize}
695   \item Modifying the files directly
696     \begin{itemize}
697     \item Simple
698     \item But no way to track and document the changes
699     \end{itemize}
700     \hbr
701   \item Using patch systems
702     \begin{itemize}
703     \item Eases contributing your changes to upstream
704     \item Helps sharing the fixes with derivatives
705     \item Gives more exposure to the changes\\
706       \url{http://patch-tracker.debian.org/}
707     \end{itemize}
708   \end{itemize}
709 \end{frame}
710
711 \begin{frame}{Patch systems}
712   \begin{itemize}
713   \item Principle: changes are stored as patches in \texttt{debian/patches/}
714     \br
715   \item Applied and unapplied during build
716     \br
717   \item Past: several implementations -- \textsl{simple-patchsys} (\textsl{cdbs}),
718     \textsl{dpatch}, \textbf{\textsl{quilt}}
719     \begin{itemize}
720   \item Each supports two \texttt{debian/rules} targets:
721     \begin{itemize}
722     \item \texttt{debian/rules patch}: apply all patches
723     \item \texttt{debian/rules unpatch}: de-apply all patches
724     \end{itemize}
725           \hbr
726   \item More documentation: \url{http://wiki.debian.org/debian/patches}
727   \end{itemize}
728   \br
729   \item \textbf{New source package format with built-in patch system: 3.0 (quilt)}
730   \begin{itemize}
731   \item Recommended solution
732           \hbr
733   \item You need to learn \textsl{quilt}\\
734     \url{http://pkg-perl.alioth.debian.org/howto/quilt.html}
735     
736   \end{itemize}
737   \end{itemize}
738 \end{frame}
739
740 \begin{frame}[fragile]{Documentation of patches}
741   \begin{itemize}
742           \item Standard headers at the beginning of the patch
743     \hbr
744   \item Documented in DEP-3 - Patch Tagging Guidelines\\
745     \url{http://dep.debian.net/deps/dep3/}
746   \end{itemize}
747   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
748 Description: Fix widget frobnication speeds
749  Frobnicating widgets too quickly tended to cause explosions.
750 Forwarded: http://lists.example.com/2010/03/1234.html
751 Author: John Doe <johndoe-guest@users.alioth.debian.org>
752 Applied-Upstream: 1.2, http://bzr.foo.com/frobnicator/revision/123
753 Last-Update: 2010-03-29
754
755 --- a/src/widgets.c
756 +++ b/src/widgets.c
757 @@ -101,9 +101,6 @@ struct {
758 \end{lstlisting}
759 \begin{itemize}
760 \item All patches are published on \url{http://patch-tracker.debian.org/}
761 \end{itemize}
762 \end{frame}
763
764 \subsection{Doing things during installation and removal}
765 \begin{frame}{Doing things during installation and removal}
766   \begin{itemize}
767   \item Decompressing the package is sometimes not enough
768     \hbr
769   \item Create/remove system users, start/stop services, manage \textsl{alternatives}
770     \hbr
771   \item Done in \textsl{maintainer scripts}\\
772     \texttt{preinst, postinst, prerm, postrm}
773     \hbr
774   \item Documentation:
775     \begin{itemize}
776     \item Debian Policy Manual, chapter 6\\
777       {\footnotesize \url{http://www.debian.org/doc/debian-policy/ch-maintainerscripts.html}}
778       
779       \hbr
780     \item Debian Developer's Reference, chapter 6.4\\
781       {\scriptsize \url{http://www.debian.org/doc/developers-reference/best-pkging-practices.html}}
782       \hbr
783     \item {\footnotesize \url{http://people.debian.org/~srivasta/MaintainerScripts.html}}
784     \end{itemize}
785     \br
786   \item Prompting the user
787     \begin{itemize}
788     \item Must be done with \textbf{debconf}
789       \hbr
790     \item Documentation: \texttt{debconf-devel(7)} (\texttt{debconf-doc} package)
791     \end{itemize}
792   \end{itemize}
793 \end{frame}
794
795 \begin{frame}[fragile]{Monitoring upstream versions}
796   \begin{itemize}
797   \item Specify where to look in \texttt{debian/watch} (see \texttt{uscan(1)})
798     \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
799 version=3
800
801 http://tmrc.mit.edu/mirror/twisted/Twisted/(\d\.\d)/ \
802   Twisted-([\d\.]*)\.tar\.bz2
803     \end{lstlisting}
804     \br
805   \item Debian infrastructure that makes use of \texttt{debian/watch}:\\
806     \textbf{Debian External Health Status}\\
807     \url{http://dehs.alioth.debian.org/}
808     \br
809   \item Maintainer warned by emails sent to the Packages Tracking System
810     \br
811   \item \texttt{uscan}: run a manual check
812     \br
813   \item \texttt{uupdate}: try to update your package to the latest upstream version
814   \end{itemize}
815 \end{frame}
816
817 \subsection{Packaging with a VCS (SVN, Git \& friends)}
818 \begin{frame}[fragile]{Packaging with a VCS (SVN, Git \& friends)}
819   \begin{itemize}
820   \item Several tools to help manage branches and tags for your packaging work:\\
821     \texttt{svn-buildpackage}, \texttt{git-buildpackage}
822     \hbr
823   \item Example: \texttt{git-buildpackage}
824     \begin{itemize}
825     \item \texttt{upstream} branch to track upstream with \texttt{upstream/\textsl{version}} tags
826     \item \texttt{master} branch tracks the Debian package
827     \item \texttt{debian/\textsl{version}} tags for each upload
828     \item \texttt{pristine-tar} branch to be able to rebuild the upstream tarball
829     \end{itemize}
830     \hbr
831   \item \texttt{Vcs-*} fields in \texttt{debian/control} to locate the repository
832   \end{itemize}
833   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
834 Vcs-Browser: http://git.debian.org/?p=devscripts/devscripts.git
835 Vcs-Git: git://git.debian.org/devscripts/devscripts.git
836
837 Vcs-Browser: http://svn.debian.org/viewsvn/pkg-perl/trunk/libwww-perl/
838 Vcs-Svn: svn://svn.debian.org/pkg-perl/trunk/libwww-perl
839   \end{lstlisting}
840   \begin{itemize}
841   \item VCS-agnostic interface: \texttt{debcheckout}, \texttt{debcommit},
842     \texttt{debrelease}\\
843     \texttt{debcheckout devscripts} $\rightarrow$ check out the source package
844     from Git
845 \end{itemize}
846 \end{frame}
847
848 \section{Maintaining packages in Debian}
849 \subsection{Several ways to contribute to Debian}
850 \begin{frame}{Several ways to contribute to Debian}
851   \begin{itemize}
852   \item \textbf{Worst} way to contribute:
853     \begin{itemize}
854     \item Package your own application
855     \item Get it into Debian
856     \item Disappear
857     \end{itemize}
858     \br
859   \item Bring new software to Debian
860     \begin{itemize}
861     \item Only if it's interesting/useful enough, please
862     \item Are there alternatives already packaged in Debian?
863     \end{itemize}
864     \br
865   \item Adopt existing unmaintained packages (\textsl{orphaned packages})
866     \begin{itemize}
867     \item Many unmaintained packages in Debian
868     \item Including some that you use daily!
869     \end{itemize}
870     \br
871   \item Get involved in packaging teams
872     \begin{itemize}
873     \item Many teams that focus on set of packages, and need help
874     \item Full list on \url{http://wiki.debian.org/Teams}
875     \item An excellent way to work with more experienced contributors
876     \end{itemize}
877   \end{itemize}
878 \end{frame}
879
880 \subsection{More interested in Ubuntu?}
881 \begin{frame}{More interested in Ubuntu?}
882   \begin{itemize}
883   \item Ubuntu mainly manages the divergence with Debian
884     \br
885   \item No real focus on specific packages\\
886     Instead, collaboration with Debian teams
887     \br
888   \item Usually recommend uploading new packages to Debian first\\
889     \url{https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages}
890     \br
891   \item Possibly a better plan:
892     \begin{itemize}
893     \item Get involved in a Debian team and act as a bridge with Ubuntu
894       \hbr
895     \item Help reduce divergence, triage bugs in Launchpad
896       \hbr
897     \item Many Debian tools can help:
898       \begin{itemize}
899       \item Ubuntu column on the Developer' packages overview
900       \item Ubuntu box on the Packages Tracking System
901       \item Receive launchpad bugmail via the PTS
902       \end{itemize}
903     \end{itemize}
904   \end{itemize}
905 \end{frame}
906
907 \subsection{Adopting orphaned packages}
908 \begin{frame}{Adopting orphaned packages}
909   \begin{itemize}
910   \item Full list: \url{http://www.debian.org/devel/wnpp/}
911     \hbr
912   \item Installed on your machine: \texttt{wnpp-alert}
913     \hbr
914   \item Different states:
915     \begin{itemize}
916     \item \textbf{O}rphaned: the package is unmaintained\\
917       Feel free to adopt it
918     \item \textbf{RFA}: \textbf{R}equest \textbf{F}or \textbf{A}dopter\\
919       Maintainer looking for adopter, but continues work in the meantime\\
920       Feel free to adopt it. A mail to the current maintainer is polite
921     \item \textbf{ITA}: \textbf{I}ntent \textbf{T}o \textbf{A}dopt\\
922       Someone intends to adopt the package\\
923       You could propose your help!
924     \item \textbf{RFH}: (\textbf{R}equest \textbf{F}or \textbf{H}elp\\
925       The maintainer is looking for help
926     \end{itemize}
927     \hbr
928   \item Some unmaintained packages not detected \arr not orphaned yet
929     \hbr
930   \item When in doubt, ask \texttt{debian-qa@lists.debian.org} \\
931     or \texttt{\#debian-qa} on \texttt{irc.debian.org}
932     
933   \end{itemize}
934 \end{frame}
935
936 \section{Resources}
937 \subsection{Where to find help?}
938 \begin{frame}{Where to find help?}
939   Help you will need:
940   \begin{itemize}
941   \item Various advices and answers to your questions, code reviews
942   \item Sponsorship of your uploads, when your package is ready
943   \end{itemize}
944   \br
945   You can get help from:
946   \begin{itemize}
947   \item Other members of a packaging team: the best solution
948     \begin{itemize}
949     \item They know the specifics of your package
950     \item You can become a member of the team
951     \item See \url{http://wiki.debian.org/Teams}
952     \end{itemize}
953     \hbr
954   \item The Debian Mentors group (if your package doesn't fit in a team)
955     \begin{itemize}
956     \item \url{http://wiki.debian.org/DebianMentorsFaq}
957     \item Mailing list: \url{debian-mentors@lists.debian.org}\\
958             {\small (also a good way to learn by accident)}
959     \item IRC: \texttt{\#debian-mentors} on \texttt{irc.debian.org}
960     \item \url{http://mentors.debian.net/}
961     \end{itemize}
962   \end{itemize}
963 \end{frame}
964
965 \subsection{Official documentation}
966 \begin{frame}{Official documentation}
967   \begin{itemize}
968   \item Debian Developers' Corner\\
969     \url{http://www.debian.org/devel/}\\
970     {\small Links to many resources about Debian development}
971     \br
972   \item Debian New Maintainers' Guide\\
973     \url{http://www.debian.org/doc/maint-guide/}\\
974     {\small An introduction to Debian packaging, but could use an update}
975     \br
976   \item Debian Developer's Reference\\
977     \url{http://www.debian.org/doc/developers-reference/}\\
978     {\small Mostly about Debian procedures, but also some best packaging practices (part 6)}
979     \br
980   \item Debian Policy\\
981     \url{http://www.debian.org/doc/debian-policy/}\\
982     
983     {\small \begin{itemize}
984       \item \small All the requirements that every package must satisfy
985       \item \small Specific policies for Perl, Java, Python, \ldots
986       \end{itemize}}
987     \br
988     
989   \item Ubuntu Packaging Guide\\
990     \url{https://wiki.ubuntu.com/PackagingGuide}
991   \end{itemize}
992 \end{frame}
993
994 \begin{frame}{Debian dashboards for maintainers}
995   \begin{itemize}
996           \item \textbf{Source package centric}: Packages Tracking System\\
997     \url{http://packages.qa.debian.org/dpkg}
998     \br
999   \item \textbf{Maintainer/team centric}: Developer's Packages Overview\\
1000     \url{http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers@lists.alioth.debian.org}
1001   \end{itemize}
1002 \end{frame}
1003
1004 \section{Conclusion}
1005 \subsection{Conclusion}
1006 \begin{frame}{Conclusion}
1007   \begin{itemize}
1008   \item You now have a full overview of Debian packaging
1009     \br
1010   \item But you will need to read more documentation
1011     \br
1012   \item Best practices have evolved over the years
1013     \begin{itemize}
1014     \item If not sure, use the \textbf{dh} packaging helper, and the \textbf{3.0 (quilt)} format
1015     \end{itemize}
1016     \br
1017   \item Things that were not covered in this tutorial:
1018     \begin{itemize}
1019         \item UCF -- manage user changes to configuration files when upgrading
1020                 \hbr
1021         \item Debian development organization:
1022                 \begin{itemize}
1023                         \item Bug Tracking System (BTS)
1024                         \item Suites: stable, testing, unstable, experimental, security, volatile, backports, \ldots
1025                         \item Debian Blends -- subsets of Debian targetting specific groups
1026                 \end{itemize}
1027                 \end{itemize}
1028   \end{itemize}
1029   \vfill
1030   \centerline{\large Feedback: \textbf{lucas@debian.org}}
1031 \end{frame}
1032
1033 \subsection{Legal stuff}
1034 \begin{frame}{Legal stuff}
1035
1036   Copyright \copyright 2011 Lucas Nussbaum -- lucas@debian.org
1037   \br
1038
1039   {\small 
1040     \textbf{This document is free software}: you can redistribute it and/or modify
1041     it under either (at your option):
1042     \hbr
1043     \begin{itemize}
1044     \item The terms of the GNU General Public License as published by the Free
1045       Software Foundation, either version 3 of the License, or
1046       (at your option) any later version.\\
1047       \url{http://www.gnu.org/licenses/gpl.html} \br
1048     \item The terms of the Creative Commons Attribution-ShareAlike 3.0 Unported
1049       License.\\ 
1050       \url{http://creativecommons.org/licenses/by-sa/3.0/}
1051     \end{itemize}
1052   }
1053 \end{frame}
1054
1055 \subsection{Latest version \& source code}
1056 \begin{frame}{Latest version \& source code}
1057   \begin{itemize}
1058   \item Latest version:\\
1059     {\footnotesize \url{http://git.debian.org/?p=users/lucas/packaging-tutorial.git;a=blob\_plain;f=packaging-tutorial.pdf;hb=refs/heads/pdf}}
1060   \end{itemize}
1061   
1062   \begin{itemize}
1063   \item Contribute:\\
1064     \texttt{git clone git://git.debian.org/\~{}lucas/packaging-tutorial.git}\\
1065     \hbr
1066     Or over HTTP: \url{http://git.debian.org/?p=users/lucas/packaging-tutorial.git}
1067     \br
1068   \item Feedback: \href{mailto:lucas@debian.org}{\textbf{\texttt{lucas@debian.org}}}
1069   \end{itemize}
1070 \end{frame}
1071
1072 \section{Practical session 2: packaging GNUjump}
1073 \begin{frame}{Practical session 2: packaging GNUjump}
1074 \begin{enumerate}
1075         \item Download GNUjump 1.0.6 from
1076                 \url{http://ftp.gnu.org/gnu/gnujump/1.0.6/gnujump-1.0.6.tar.gz}
1077                 \br
1078         \item Create a Debian package for it
1079                 \begin{itemize}
1080                         \item Install build-dependencies so that you can build the package
1081                         \item Get a basic working package
1082                         \item Finish filling \texttt{debian/control} and other files
1083                 \end{itemize}
1084                 \br
1085         \item Enjoy
1086 \end{enumerate}
1087 \centerline{\includegraphics[width=5cm]{figs/gnujump.png}}
1088 \end{frame}
1089
1090 \section{Practical session 3: packaging a Java library}
1091 \begin{frame}{Practical session 3: packaging a Java library}
1092 \begin{enumerate}
1093         \item Take a quick look at some documentation about Java packaging:\\
1094                 \begin{itemize}
1095                 \item \url{http://wiki.debian.org/Java}
1096                 \item \url{http://wiki.debian.org/Java/Packaging}
1097                 \item \url{http://www.debian.org/doc/packaging-manuals/java-policy/}
1098                 \item \url{http://pkg-java.alioth.debian.org/docs/tutorial.html}
1099                 \item Paper and slides from a Debconf10 talk about javahelper:\\
1100                         {\footnotesize
1101                         \url{http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-paper.pdf}\\
1102                         \url{http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-slides.pdf}}
1103                 \end{itemize}
1104                 \br
1105         \item Download IRClib from \url{http://moepii.sourceforge.net/}
1106                 \br
1107         \item Package it
1108 \end{enumerate}
1109 \end{frame}
1110
1111 \backupbegin
1112
1113 \backupend
1114
1115 \end{document}