3c963f40d66b8dd99d289ccb6c92e8b93a196da8
[packaging-tutorial.git] / packaging-tutorial.tex
1 \documentclass[10pt,final]{beamer}
2 \mode<presentation>
3 \usetheme{debian}
4
5 %Translators:
6 %change debiantutorial to debiantutorial.$lang to use translated file, and
7 %append to this string all commands to load localisation packages, e.g.:
8 %\\usepackage{debiantutorial.fr} \\usepackage[french]{babel} \\frenchsetup{...}
9 \usepackage{debiantutorial}
10
11 \hypersetup{bookmarks}
12 \title{Debian Packaging Tutorial}
13 \author[]{Lucas Nussbaum\\{\small\texttt{lucas@debian.org}}}
14
15 %Translators:
16 %leave \\version unchanged: this will a variable containing the actual version
17 %To translate the date, use \\today or a string containing \\year, \\month, \\day
18 %(numeric values).
19 \date{\footnotesize version 0.5 -- 2012-01-14} % DATE - use debian/rules update-version-date
20
21 \begin{document}
22
23
24 \frame{\titlepage}
25
26 \begin{frame}{About this tutorial}
27   \begin{itemize}
28   \item Goal: \textbf{tell you what you really need to know about Debian packaging}
29     \begin{itemize}
30       \hbr
31     \item Modify existing packages
32       \hbr
33     \item Create your own packages
34             \hbr
35     \item Interact with the Debian community
36       \hbr
37     \item Become a Debian power-user
38     \end{itemize}
39     \br
40   \item Covers the most important points, but is not complete
41     \begin{itemize}
42     \item You will need to read more documentation
43     \end{itemize}
44     \br
45   \item Most of the content also applies to Debian derivatives distributions
46     \begin{itemize}
47       \hbr
48     \item That includes Ubuntu
49     \end{itemize}
50   \end{itemize}
51 \end{frame}
52
53 \begin{frame}{Outline}
54   \tableofcontents[hideallsubsections]
55 \end{frame}
56
57 \section{Introduction}
58
59 \subsection{Debian}
60
61 \begin{frame}{Debian}
62         \begin{itemize}
63                 \item \textbf{GNU/Linux distribution}
64                         \br
65                 \item 1st major distro developed ``openly in the spirit of GNU''
66                         \br
67                 \item \textbf{Non-commercial}, built collaboratively by over 1,000 volunteers
68                         \br
69                 \item 3 main features:
70                         \begin{itemize}
71                                 \item \textbf{Quality} -- culture of technical excellence\\
72                                         {\small\sl We release when it's ready}
73                                         \hbr
74                                 \item \textbf{Freedom} -- devs and users bound by the \textsl{Social Contract}\\
75                                         Promoting the culture of Free Software since 1993
76                                         \hbr
77                                 \item \textbf{Independence} -- no (single) company babysitting Debian\\
78                                         And open decision-making process (\textsl{do-ocracy} + \textsl{democracy})
79                         \end{itemize}
80                         \br
81                 \item \textbf{Amateur} in the best sense: done for the love of it
82         \end{itemize}
83 \end{frame}
84
85 \subsection{Debian packages}
86 \begin{frame}{Debian packages}
87 \begin{itemize}
88 \item \textbf{.deb} files (binary packages)
89         \br
90 \item A very powerful and convenient way to distribute software to users
91         \br
92 \item One of the two most common packages format (with RPM)
93         \br
94 \item Universal:
95         \begin{itemize}
96                 \item 30,000 binary packages in Debian\\
97                         $\rightarrow$ most of the available free software is packaged in Debian!
98                         \hbr
99                 \item For 12 ports (architectures), including 2 non-Linux (Hurd; KFreeBSD)
100                         \hbr
101                 \item Also used by 120 Debian derivatives distributions
102         \end{itemize}
103 \end{itemize}
104 \end{frame}
105
106
107 \subsection{The Deb package format}
108
109 \begin{frame}[fragile]{The Deb package format}
110   \begin{itemize}
111   \item \texttt{.deb} file: an \texttt{ar} archive
112     \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
113 $ ar tv wget_1.12-2.1_i386.deb
114 rw-r--r-- 0/0      4 Sep  5 15:43 2010 debian-binary
115 rw-r--r-- 0/0   2403 Sep  5 15:43 2010 control.tar.gz
116 rw-r--r-- 0/0 751613 Sep  5 15:43 2010 data.tar.gz
117     \end{lstlisting} % $
118     \begin{itemize}
119     \item \texttt{debian-binary}: version of the deb file format, \texttt{"2.0\textbackslash{}n"}
120     \item \texttt{control.tar.gz}: metadata about the package\\
121       {\small \texttt{\textbf{control}, md5sums, (pre|post)(rm|inst), triggers, shlibs}, \ldots}
122     \item \texttt{data.tar.gz}: data files of the package
123     \end{itemize}
124     \br
125   \item You could create your \texttt{.deb} files manually\\
126     {\footnotesize \url{http://tldp.org/HOWTO/html\_single/Debian-Binary-Package-Building-HOWTO/}}
127     \br
128   \item But most people don't do it that way
129   \end{itemize}
130   \br
131   \centerline{\textbf{This tutorial: create Debian packages, the Debian way}}
132 \end{frame}
133
134 \subsection{Tools you will need}
135 \begin{frame}{Tools you will need}
136   \begin{itemize}
137   \item A Debian (or Ubuntu) system (with root access)
138     \br
139   \item Some packages:
140     \begin{itemize}
141     \item \textbf{build-essential}: has dependencies on the packages that will
142       be assumed to be available on the developers' machine (no need to specify
143       them in the \texttt{Build-Depends:} control field of your package)
144       \begin{itemize}
145       \item includes a dependency on \textbf{dpkg-dev}, which contains basic
146         Debian-specific tools to create packages
147       \end{itemize}
148       \hbr
149     \item \textbf{devscripts}: contains many useful scripts for Debian
150       maintainers
151     \end{itemize}
152   \end{itemize}
153
154   \br
155   Many other tools will also be mentioned later, such as \textbf{debhelper},
156   \textbf{cdbs}, \textbf{quilt}, \textbf{pbuilder}, \textbf{sbuild},
157   \textbf{lintian}, \textbf{svn-buildpackage}, \textbf{git-buildpackage},
158   \ldots\\
159   Install them when you need them.
160 \end{frame}
161
162 \subsection{General packaging workflow}
163 \begin{frame}{General packaging workflow}
164   \begin{center}
165     \begin{tikzpicture}[
166       node1/.style={shape=rectangle,draw=rouge,fill=debianbackgroundblue,thick},
167       arr/.style={very thick}, command/.style={text=rouge,font=\ttfamily}, ]
168       
169       \node[node1] (www) at (0, 0) {Web};
170       \node[node1] (us) at (2.5, 0) {upstream source};
171       \node[node1] (da) at (-2.5, 0) {Debian mirror};
172       \node[node1] (sp) at (0, -2) {source package};
173       \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};
174       \node[node1] (bin) at (0, -4) {one or several binary packages};
175       \draw[arr,<-,dashed,thick] (bin) -- (3.5,-4) node[right,text centered,font=\small\ttfamily\sl] {.deb\normalfont};
176       \draw[arr,->] (us) -- (sp) node[pos=0.5,right,command] {dh\_make};
177       \draw[arr,->] (da) -- (sp) node[pos=0.5,left,command] {apt-get source};
178       \draw[arr,->] (www) -- (sp) node[pos=0.5,left,command] {dget};
179       \draw[arr,->] (sp) -- (bin) node[pos=0.5,right,text width=6cm] {\textttc{debuild} (build and test with \textttc{lintian}) or \textttc{dpkg-buildpackage}};
180       \draw[arr,->] (bin) -- (1,-6) node[pos=0.5,right] {install (\textttc{debi})};
181       % \draw[arr,->] (bin) -- (-1,-6) node[pos=0.5,left] {upload (\textttc{dput})};
182       \draw[transparent] (bin) -- (-1,-6) node[pos=0.5,left,opaque] {upload (\textttc{dput})};
183       \draw[arr,->,rounded corners] (bin) -- (-1,-6) -- (-4.5,-6) -- (-4.5,0) -- (da);
184       \useasboundingbox (-4,-6) rectangle (6,0); % hack hack hack
185     \end{tikzpicture}
186   \end{center}
187 \end{frame}
188
189 \subsection{Rebuilding dash}
190 \begin{frame}{Example: rebuilding dash}
191 \begin{enumerate}
192 \item Install packages needed to build dash, and devscripts\\
193   {\texttt{sudo apt-get build-dep dash}\\ (requires \texttt{deb-src} lines in \texttt{/etc/apt/sources.list})}\\
194   {\texttt{sudo apt-get install -{}-no-install-recommends devscripts}}
195   \hbr
196 \item Create a working directory, and get in it:\\
197  \texttt{mkdir /tmp/debian-tutorial ; cd /tmp/debian-tutorial}
198   \hbr
199 \item Grab the \texttt{dash} source package\\
200   \texttt{apt-get source dash}\\ 
201   {\small (This needs you to have \texttt{deb-src} lines in your \texttt{/etc/apt/sources.list})}
202   \hbr
203 \item Build the package\\
204   {\texttt{cd dash-*\\ debuild -us -uc}} ~~~(\texttt{-us -uc} disables signing the package with GPG)
205
206   \hbr
207 \item Check that it worked
208         \begin{itemize}
209                 \item  There are some new \texttt{.deb} files in the parent directory
210         \end{itemize}
211     \hbr
212 \item Look at the \texttt{debian/} directory
213         \begin{itemize}
214                 \item That's where the packaging work is done
215         \end{itemize}
216 \end{enumerate}
217 \end{frame}
218
219 \section{Creating source packages}
220 \subsection{Source packages basics}
221 \begin{frame}{Source package}
222   \begin{itemize}
223   \item One source package can generate several binary packages\\
224     {\small e.g the \texttt{\bfseries libtar} source generates the
225       \texttt{\bfseries libtar0} and \texttt{\bfseries libtar-dev} binary
226       packages} \hbr
227   \item Two kinds of packages: (if unsure, use non-native)
228     \begin{itemize}
229       \small
230     \item Native packages: normally for Debian specific software (\textsl{dpkg}, \textsl{apt})
231     \item Non-native packages: software developed outside Debian
232     \end{itemize}
233     \hbr
234   \item Main file: \texttt{.dsc} (meta-data)
235     \hbr
236   \item Other files depending on the version of the source format
237     \begin{itemize}
238     \item 1.0 -- native: \texttt{package\_version.tar.gz}
239       \hbr
240     \item 1.0 -- non-native:
241       \begin{itemize}
242       \item \texttt{pkg\_ver.orig.tar.gz} : upstream source
243       \item \texttt{pkg\_debver.diff.gz} : patch to add Debian-specific changes
244       \end{itemize}
245       \hbr
246     \item 3.0 (quilt):
247       \begin{itemize}
248       \item \texttt{pkg\_ver.orig.tar.gz} : upstream source
249       \item \texttt{pkg\_debver.debian.tar.gz} : tarball with the Debian changes
250       \end{itemize}
251     \end{itemize}
252   \end{itemize}
253   \hbr
254   (See \texttt{dpkg-source(1)} for exact details)
255 \end{frame}
256
257 \begin{frame}[fragile]{Source package example (wget\_1.12-2.1.dsc)}
258   \begin{lstlisting}[basicstyle=\ttfamily\small]
259 Format: 3.0 (quilt)
260 Source: wget
261 Binary: wget
262 Architecture: any
263 Version: 1.12-2.1
264 Maintainer: Noel Kothe <noel@debian.org>
265 Homepage: http://www.gnu.org/software/wget/
266 Standards-Version: 3.8.4
267 Build-Depends: debhelper (>> 5.0.0), gettext, texinfo,
268  libssl-dev (>= 0.9.8), dpatch, info2man
269 Checksums-Sha1: 
270  50d4ed2441e67[..]1ee0e94248 2464747 wget_1.12.orig.tar.gz
271  d4c1c8bbe431d[..]dd7cef3611 48308 wget_1.12-2.1.debian.tar.gz
272 Checksums-Sha256: 
273  7578ed0974e12[..]dcba65b572 2464747 wget_1.12.orig.tar.gz
274  1e9b0c4c00eae[..]89c402ad78 48308 wget_1.12-2.1.debian.tar.gz
275 Files: 
276  141461b9c04e4[..]9d1f2abf83 2464747 wget_1.12.orig.tar.gz
277  e93123c934e3c[..]2f380278c2 48308 wget_1.12-2.1.debian.tar.gz
278 \end{lstlisting}
279 \end{frame}
280
281 \subsection{Retrieving source packages}
282 \begin{frame}{Retrieving an existing source package}
283   \begin{itemize}
284   \item From the Debian archive:
285     \begin{itemize}
286     \item \texttt{apt-get source \textsl{package}}
287     \item \texttt{apt-get source \textsl{package=version}}
288     \item \texttt{apt-get source \textsl{package/release}}
289     \end{itemize}
290     (You need \texttt{deb-src} lines in \texttt{sources.list})
291     \br
292   \item From the Internet:
293     \begin{itemize}
294     \item \texttt{dget \textsl{url-to.dsc}}
295     \item \texttt{dget http://snapshot.debian.org/archive/debian-archive/\\20090802T004153Z/debian/dists/bo/main/source/web/\\
296         wget\_1.4.4-6.dsc}\\ 
297       (\href{http://snapshot.debian.org/}{\ttfamily snapshot.d.o} provides all packages from Debian since 2005)
298     \end{itemize}
299     \br
300   \item From the (declared) version control system:
301     \begin{itemize}
302     \item \texttt{debcheckout \textsl{package}}
303     \end{itemize}
304     \br
305   \item Once downloaded, extract with \texttt{dpkg-source -x \textsl{file.dsc}}
306   \end{itemize}
307 \end{frame}
308
309 \subsection{Creating a basic source package}
310 \begin{frame}{Creating a basic source package}
311   \begin{itemize}
312   \item Download the upstream source\\
313     (\textsl{upstream source} = the one from the software's original developers)
314     \hbr
315   \item Rename to \texttt{<\textsl{source\_package}>\_<\textsl{upstream\_version}>.orig.tar.gz}\\
316     (example: \texttt{simgrid\_3.6.orig.tar.gz})
317     \hbr
318   \item Untar it
319     \hbr
320   \item \texttt{cd \textsl{upstream\_source} \&\& dh\_make} (from the \textbf{dh-make} package)
321     \hbr
322   \item There are some alternatives to \texttt{dh\_make} for specific sets of
323     packages: \textbf{dh-make-perl}, \textbf{dh-make-php}, \ldots \hbr
324   \item \texttt{debian/} directory created, with a lot of files in it
325   \end{itemize}
326 \end{frame}
327
328 \subsection{Files in debian/}
329 \begin{frame}{Files in debian/}
330   All the packaging work should be made by modifying files in \texttt{debian/}
331   \hbr
332   \begin{itemize}
333   \item Main files:
334     \begin{itemize}
335     \item \textbf{control} -- meta-data about the package (dependencies, etc)
336     \item \textbf{rules} -- specifies how to build the package
337     \item \textbf{copyright} -- copyright information for the package
338     \item \textbf{changelog} -- history of the Debian package
339     \end{itemize}
340     \hbr
341   \item Other files:
342     \begin{itemize}
343     \item compat
344     \item watch
345     \item dh\_install* targets\\
346       {\small *.dirs, *.docs, *.manpages, \ldots}
347     \item maintainer scripts\\
348       {\small *.postinst, *.prerm, \ldots}
349     \item source/format
350     \item patches/ -- if you need to modify the upstream sources
351     \end{itemize}
352     \hbr
353   \item Several files use a format based on RFC 822 (mail headers)
354   \end{itemize}
355 \end{frame}
356
357 \begin{frame}[fragile]{debian/changelog}
358   \begin{itemize}
359   \item Lists the Debian packaging changes
360   \item Gives the current version of the package
361   \begin{center}
362     \begin{tikzpicture}
363             \draw (0,0) node[above right] {\large 1.2.1.1-5};
364             \draw [decorate,decoration={brace}] (2,0) -- (1.45,0) node[at start,below,text width=1.6cm,text centered] {\small  Debian revision};
365             \draw [decorate,decoration={brace}] (1.4,0) -- (0,0) node[midway,below,text width=1.6cm,text centered] { \small Upstream version};
366 \end{tikzpicture}
367 \end{center}
368
369
370           %%
371   \item Edited manually or with \textttc{dch}
372   \begin{itemize}
373           \item Create a changelog entry for a new release: \textttc{dch -i}
374   \end{itemize}
375   \item Special format to automatically close Debian or Ubuntu bugs\\
376     Debian: \texttt{Closes:~\#595268}; Ubuntu: \texttt{LP:~\#616929}
377   \item Installed as \texttt{/usr/share/doc/\textit{package}/changelog.Debian.gz}
378   \end{itemize}
379   \seprule
380   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
381 mpich2 (1.2.1.1-5) unstable; urgency=low
382
383   * Use /usr/bin/python instead of /usr/bin/python2.5. Allow
384     to drop dependency on python2.5.  Closes: #595268
385   * Make /usr/bin/mpdroot setuid. This is the default after
386     the installation of mpich2 from source, too. LP: #616929
387     + Add corresponding lintian override.
388
389  -- Lucas Nussbaum <lucas@debian.org>  Wed, 15 Sep 2010 18:13:44 +0200
390 \end{lstlisting}
391 \end{frame}
392
393 \begin{frame}[fragile]{debian/control}
394   \hbr
395   \begin{itemize}
396   \item Package metadata
397     \begin{itemize}
398     \item For the source package itself
399     \item For each binary package built from this source
400     \end{itemize}
401     \hbr
402   \item Package name, section, priority, maintainer, uploaders,
403     build-dependencies, dependencies, description, homepage, \ldots \hbr
404   \item Documentation: Debian Policy chapter 5\\
405     \url{http://www.debian.org/doc/debian-policy/ch-controlfields.html}
406   \end{itemize}
407   \seprule
408 \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
409 Source: wget
410 Section: web
411 Priority: important
412 Maintainer: Noel Kothe <noel@debian.org>
413 Build-Depends: debhelper (>> 5.0.0), gettext, texinfo,
414  libssl-dev (>= 0.9.8), dpatch, info2man
415 Standards-Version: 3.8.4
416 Homepage: http://www.gnu.org/software/wget/
417
418 Package: wget
419 Architecture: any
420 Depends: ${shlibs:Depends}, ${misc:Depends}
421 Description: retrieves files from the web
422  Wget is a network utility to retrieve files from the Web
423 \end{lstlisting}
424 \end{frame}
425
426 \begin{frame}{Architecture: all or any}
427   Two kinds of binary packages:
428   \hbr
429   \begin{itemize}
430   \item Packages with different contents on each Debian architecture
431     \begin{itemize}
432     \item Example: C program
433     \item \texttt{Architecture:\ any} in \texttt{debian/control}
434       \begin{itemize}
435       \item Or, if it only works on a subset of architectures:\\
436         \texttt{Architecture:\ amd64 i386 ia64 hurd-i386}
437       \end{itemize}
438     \item buildd.debian.org: builds all the other architectures for you on upload
439     \item Named \texttt{\textsl{package}\_\textsl{version}\_\textsl{architecture}.deb}
440     \end{itemize}
441     \br
442   \item Packages with the same content on all architectures
443     \begin{itemize}
444     \item Example: Perl library
445     \item \texttt{Architecture:\ all} in \texttt{debian/control}
446     \item Named \texttt{\textsl{package}\_\textsl{version}\_\textbf{all}.deb}
447     \end{itemize}
448   \end{itemize}
449   \br
450   A source package can generate a mix of \texttt{Architecture:\ any} and \texttt{Architecture:\ all} binary packages
451 \end{frame}
452
453 \begin{frame}[fragile]{debian/rules}
454   \hbr
455   \begin{itemize}
456   \item Makefile
457     \br
458   \item Interface used to build Debian packages
459     \br
460   \item Documented in Debian Policy, chapter 4.8\\
461     {\small \texttt{http://www.debian.org/doc/debian-policy/ch-source.html\#s-debianrules}}
462     \br
463   \item Five required targets:
464     \begin{itemize}
465     \item \texttt{build}: should perform all the configuration and compilation
466       \hbr
467     \item \texttt{binary, binary-arch, binary-indep}: build the binary packages
468       \begin{itemize}
469       \item \texttt{dpkg-buildpackage} will call \texttt{binary} to build all
470         the packages, or \texttt{binary-arch} to build only the
471         \texttt{Architecture:~any} packages
472       \end{itemize}
473       \hbr
474     \item \texttt{clean}: clean up the source directory
475     \end{itemize}
476   \end{itemize}
477 \end{frame}
478
479 \subsection{Packaging helpers}
480 \begin{frame}{Packaging helpers -- debhelper}
481   \begin{itemize}
482   \item You could write shell code in \texttt{debian/rules} directly
483     \begin{itemize}
484     \item See the \texttt{adduser} package for example
485     \end{itemize}
486     \hbr
487   \item Better practice (used by most packages): use a \textsl{Packaging helper}
488     \hbr
489   \item Most popular one: \textbf{debhelper} (used by 98\% of packages)
490     \hbr
491   \item Goals:
492     \begin{itemize}
493     \item Factor the common tasks in standard tools used by all packages
494     \item Fix some packaging bugs once for all packages
495     \end{itemize}
496     {\footnotesize dh\_installdirs, dh\_installchangelogs, dh\_installdocs,
497       dh\_installexamples, dh\_install, dh\_installdebconf, dh\_installinit,
498       dh\_link, dh\_strip, dh\_compress, dh\_fixperms, dh\_perl,
499       dh\_makeshlibs, dh\_installdeb, dh\_shlibdeps, dh\_gencontrol,
500       dh\_md5sums, dh\_builddeb, \ldots}
501     \begin{itemize}
502     \item Called from \texttt{debian/rules}
503     \item Configurable using command parameters or files in \texttt{debian/}
504     \end{itemize}
505     {\footnotesize \ttfamily \textsl{package}.docs, \textsl{package}.examples,
506       \textsl{package}.install, \textsl{package}.manpages, \ldots} \hbr
507   \item Third-party helpers for sets of packages: \textbf{python-support},
508     \textbf{dh\_ocaml}, \ldots \hbr
509   \item Gotcha: \texttt{debian/compat}: Debhelper compatibility version (use "7")
510   \end{itemize}
511 \end{frame}
512
513 \begin{frame}[fragile]{debian/rules using debhelper (1/2)}
514   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize,escapeinside=\{\}]
515 #!/usr/bin/make -f
516
517 # Uncomment this to turn on verbose mode.
518 #export DH_VERBOSE=1
519
520 build: 
521         $(MAKE)
522         #docbook-to-man debian/packagename.sgml > packagename.1
523
524 clean: 
525         dh_testdir
526         dh_testroot
527         rm -f build-stamp configure-stamp
528         $(MAKE) clean
529         dh_clean 
530
531 install: build
532         dh_testdir
533         dh_testroot
534         dh_clean -k 
535         dh_installdirs
536         # Add here commands to install the package into debian/packagename.
537         $(MAKE) DESTDIR=$(CURDIR)/debian/packagename install
538 \end{lstlisting}
539 \end{frame}
540
541 \begin{frame}[fragile]{debian/rules using debhelper (2/2)}
542   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize,escapeinside=\{\}]
543
544 # Build architecture-independent files here.
545 binary-indep: build install
546
547 # Build architecture-dependent files here.
548 binary-arch: build install
549         dh_testdir
550         dh_testroot
551         dh_installchangelogs 
552         dh_installdocs
553         dh_installexamples
554         dh_install
555         dh_installman
556         dh_link
557         dh_strip
558         dh_compress
559         dh_fixperms
560         dh_installdeb
561         dh_shlibdeps
562         dh_gencontrol
563         dh_md5sums
564         dh_builddeb
565
566 binary: binary-indep binary-arch
567 .PHONY: build clean binary-indep binary-arch binary install configure
568 \end{lstlisting}
569 \end{frame}
570
571 \begin{frame}[fragile]{CDBS}
572   \hbr
573   \begin{itemize}
574   \item With debhelper, still a lot of redundancy between packages
575     \hbr
576   \item Second-level helpers that factor common functionality
577     \begin{itemize}
578     \item E.g building with \texttt{./configure \&\& make \&\& make install} or CMake
579     \end{itemize}
580     \hbr
581   \item CDBS:
582     \begin{itemize}
583     \item Introduced in 2005, based on advanced \textsl{GNU make} magic
584     \item Documentation: \texttt{/usr/share/doc/cdbs/}
585     \item Support for Perl, Python, Ruby, GNOME, KDE, Java, Haskell, \ldots
586     \item But some people hate it:
587       \begin{itemize}
588       \item Sometimes difficult to customize package builds:\\
589         "\textsl{twisty maze of makefiles and environment variables}"
590       \item Slower than plain debhelper (many useless calls to \texttt{dh\_*})
591       \end{itemize}
592     \end{itemize}
593   \end{itemize}
594   \seprule
595       \begin{lstlisting}[basicstyle=\ttfamily\footnotesize,escapeinside=\{\}]
596 #!/usr/bin/make -f
597 include /usr/share/cdbs/1/rules/debhelper.mk
598 include /usr/share/cdbs/1/class/autotools.mk
599
600 # add an action after the build
601 build/mypackage::
602     /bin/bash debian/scripts/foo.sh
603       \end{lstlisting}
604 \end{frame}
605
606 \begin{frame}[fragile]{Dh (aka Debhelper 7, or dh7)}
607   \begin{itemize}
608   \item Introduced in 2008 as a \textsl{CDBS killer}
609     \hbr
610   \item \textbf{dh} command that calls \texttt{dh\_*}
611     \hbr
612   \item Simple \textsl{debian/rules}, listing only overrides
613     \hbr
614   \item Easier to customize than CDBS
615     \hbr
616   \item Doc: manpages (\texttt{debhelper(7)}, \texttt{dh(1)}) + slides from DebConf9 talk\\
617     \url{http://kitenet.net/~joey/talks/debhelper/debhelper-slides.pdf}
618   \end{itemize}
619   \seprule
620     \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
621 #!/usr/bin/make -f
622 %:
623     dh $@
624
625 override_dh_auto_configure:
626      dh_auto_configure -- --with-kitchen-sink
627
628 override_dh_auto_build:
629      make world
630
631     \end{lstlisting}
632 \end{frame}
633
634 \begin{frame}{Classic debhelper vs CDBS vs dh}
635   \hbr
636   \begin{itemize}
637   \item Mind shares:\\
638     Classic debhelper: 36\% \hskip 1em CDBS: 21\% \hskip 1em  dh: 41\%
639     \hbr
640   \item Which one should I learn?
641     \begin{itemize}
642     \item Probably a bit of all of them
643     \item You need to know debhelper to use dh and CDBS
644     \item You might have to modify CDBS packages
645     \end{itemize}
646     \hbr
647   \item Which one should I use for a new package?
648     \begin{itemize}
649     \item \textbf{dh} (only solution with an increasing mind share)
650     \end{itemize}
651   \end{itemize}
652   
653   \hbr
654   \begin{center}
655     \begin{tikzpicture}
656 \begin{axis}[small,label style={font=\footnotesize},xlabel={\small Time},ylabel={\small Market share (\%)},
657         date coordinates in=x,height=4.85cm,width=9cm,xticklabel={\month/\year},
658              legend style={font=\footnotesize,at={(1.02,1)},anchor=north west},max space between ticks=82,try min ticks=5,ymin=0]
659         \addplot[mark=none,blue,thick,style=densely dotted] table[x=date,y=dh] {cdbs-dh7.txt};
660         \addplot[mark=none,red,thick,style=dashed] table[x=date,y=dh7] {cdbs-dh7.txt};
661         \addplot[mark=none,green,thick] table[x=date,y=cdbs] {cdbs-dh7.txt};
662         \legend{debhelper, dh, CDBS}
663 \end{axis}
664 \end{tikzpicture}
665 \end{center}
666
667 \end{frame}
668
669 \section{Building and testing packages}
670 \subsection{Building packages}
671 \begin{frame}{Building packages}
672   \begin{itemize}
673   \item \textttc{apt-get build-dep mypackage}\\
674     Installs the \textsl{build-dependencies} (for a package in the archive)
675     
676     \br
677   \item \textttc{debuild}: build, test with \texttt{lintian}, sign with GPG
678     \br
679   \item Also possible to call \textttc{dpkg-buildpackage} directly
680     \begin{itemize}
681     \item Usually with \texttt{dpkg-buildpackage -us -uc}
682     \end{itemize}
683     \br
684   \item It is better to build packages in a clean \& minimal environment
685     \begin{itemize}
686     \item \textttc{pbuilder} -- helper to build packages in a \textsl{chroot}\\
687       Good documentation: \url{https://wiki.ubuntu.com/PbuilderHowto}\\
688       (optimization: \textttc{cowbuilder} \textttc{ccache} \textttc{distcc})
689       \hbr
690     \item \textttc{schroot} and \textttc{sbuild}: used on the Debian build daemons\\
691       (not as simple as \texttt{pbuilder}, but allows LVM snapshots\\
692        see: \url{https://help.ubuntu.com/community/SbuildLVMHowto} )
693     \end{itemize}
694     \br
695   \item Generates \texttt{.deb} files and a \texttt{.changes} file
696     \begin{itemize}
697     \item \texttt{.changes}: describes what was built; used to upload the package
698     \end{itemize}
699   \end{itemize}
700 \end{frame}
701 \subsection{Installing and testing packages}
702 \begin{frame}{Installing and testing packages}
703   \begin{itemize}
704   \item Install the package locally: \textttc{debi} (will use \texttt{.changes}
705     to know what to install) \br
706   \item List the content of the package: \texttt{{\color{rouge}debc}
707       ../mypackage<TAB>.changes} \br
708   \item Compare the package with a previous version:\\
709     \texttt{{\color{rouge}debdiff} ../mypackage\_1\_*.changes ../mypackage\_2\_*.changes}\\
710     or to compare the sources:\\
711     \texttt{{\color{rouge}debdiff} ../mypackage\_1\_*.dsc ../mypackage\_2\_*.dsc}\\
712     \br
713   \item Check the package with \texttt{lintian} (static analyzer):\\
714     \texttt{{\color{rouge}lintian} ../mypackage<TAB>.changes}\\
715     \texttt{lintian -i}: gives more information about the errors \br
716   \item Upload the package to Debian (\textttc{dput}) (needs configuration) \br
717   \item Manage a private Debian archive with \textttc{reprepro}\\
718     Documentation: \url{http://mirrorer.alioth.debian.org/}
719   \end{itemize}
720 \end{frame}
721 \section{Practical session 1: modifying the grep package}
722 \begin{frame}{Practical session 1: modifying the grep package}
723   \begin{enumerate}
724   \item Go to \url{http://ftp.debian.org/debian/pool/main/g/grep/} and
725     download version 2.6.3-3 of the package (if you use Ubuntu 11.10 or
726     later, or Debian testing or unstable, use version 2.9-1 or 2.9-2 instead)
727
728   \item Look at the files in \texttt{debian/}.
729     \begin{itemize}
730     \item               How many binary packages are generated by this source package?
731     \item               Which packaging helper does this package use?
732     \end{itemize}
733     \hbr
734   \item Build the package
735     \hbr
736   \item We are now going to modify the package. Add a changelog entry and increase the version number.
737     \hbr
738   \item Now disable perl-regexp support (it is a \texttt{./configure} option)
739     \hbr
740   \item Rebuild the package
741     \hbr
742   \item Compare the original and the new package with debdiff
743     \hbr
744   \item Install the newly built package
745     \hbr
746   \item Cry if you messed up ;)
747   \end{enumerate}
748 \end{frame}
749
750 \section{Advanced packaging topics}
751 \subsection{debian/copyright}
752 \begin{frame}[fragile]{debian/copyright}
753   \hbr
754   \begin{itemize}
755   \item Copyright and license information for the source and the packaging
756   \item Traditionally written as a text file
757   \item New machine-readable format: \url{http://dep.debian.net/deps/dep5/}
758   \end{itemize}
759   \seprule
760   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
761 Format: <VERSIONED_FORMAT_URL>
762 Upstream-Name: X Solitaire
763 Source: ftp://ftp.example.com/pub/games
764
765 Files: *
766 Copyright: Copyright 1998 John Doe <jdoe@example.com>
767 License: GPL-2+
768  This program is free software; you can redistribute it
769  [...]
770  .
771  On Debian systems, the full text of the GNU General Public
772  License version 2 can be found in the file
773  `/usr/share/common-licenses/GPL-2'.
774
775 Files: debian/*
776 Copyright: Copyright 1998 Jane Smith <jsmith@example.net>
777 License:
778  [LICENSE TEXT]
779 \end{lstlisting}
780 \end{frame}
781
782
783
784 \subsection{Modifying the upstream source}
785 \begin{frame}{Modifying the upstream source}
786   Often needed:
787   \begin{itemize}
788   \item Fix bugs or add customizations that are specific to Debian
789     \hbr
790   \item Backport fixes from a newer upstream release
791   \end{itemize}
792   \br
793   Several methods to do it:
794   \begin{itemize}
795   \item Modifying the files directly
796     \begin{itemize}
797     \item Simple
798     \item But no way to track and document the changes
799     \end{itemize}
800     \hbr
801   \item Using patch systems
802     \begin{itemize}
803     \item Eases contributing your changes to upstream
804     \item Helps sharing the fixes with derivatives
805     \item Gives more exposure to the changes\\
806       \url{http://patch-tracker.debian.org/}
807     \end{itemize}
808   \end{itemize}
809 \end{frame}
810
811 \begin{frame}{Patch systems}
812   \begin{itemize}
813   \item Principle: changes are stored as patches in \texttt{debian/patches/}
814     \br
815   \item Applied and unapplied during build
816     \br
817   \item Past: several implementations -- \textsl{simple-patchsys} (\textsl{cdbs}),
818     \textsl{dpatch}, \textbf{\textsl{quilt}}
819     \begin{itemize}
820   \item Each supports two \texttt{debian/rules} targets:
821     \begin{itemize}
822     \item \texttt{debian/rules patch}: apply all patches
823     \item \texttt{debian/rules unpatch}: de-apply all patches
824     \end{itemize}
825           \hbr
826   \item More documentation: \url{http://wiki.debian.org/debian/patches}
827   \end{itemize}
828   \br
829   \item \textbf{New source package format with built-in patch system: 3.0 (quilt)}
830   \begin{itemize}
831   \item Recommended solution
832           \hbr
833   \item You need to learn \textsl{quilt}\\
834     \url{http://pkg-perl.alioth.debian.org/howto/quilt.html}
835     \hbr
836   \item Patch-system-agnostic tool in \texttt{devscripts}: \texttt{edit-patch}
837   \end{itemize}
838   \end{itemize}
839 \end{frame}
840
841 \begin{frame}[fragile]{Documentation of patches}
842   \begin{itemize}
843           \item Standard headers at the beginning of the patch
844     \br
845   \item Documented in DEP-3 - Patch Tagging Guidelines\\
846     \url{http://dep.debian.net/deps/dep3/}
847   \end{itemize}
848   \vfill
849 \seprule
850   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
851 Description: Fix widget frobnication speeds
852  Frobnicating widgets too quickly tended to cause explosions.
853 Forwarded: http://lists.example.com/2010/03/1234.html
854 Author: John Doe <johndoe-guest@users.alioth.debian.org>
855 Applied-Upstream: 1.2, http://bzr.foo.com/frobnicator/revision/123
856 Last-Update: 2010-03-29
857
858 --- a/src/widgets.c
859 +++ b/src/widgets.c
860 @@ -101,9 +101,6 @@ struct {
861 \end{lstlisting}
862 \end{frame}
863
864 \subsection{Doing things during installation and removal}
865 \begin{frame}{Doing things during installation and removal}
866   \begin{itemize}
867   \item Decompressing the package is sometimes not enough
868     \hbr
869   \item Create/remove system users, start/stop services, manage \textsl{alternatives}
870     \hbr
871   \item Done in \textsl{maintainer scripts}\\
872     \texttt{preinst, postinst, prerm, postrm}
873     \begin{itemize}
874             \item  Snippets for common actions can be generated by debhelper
875     \end{itemize}
876     \hbr
877   \item Documentation:
878     \begin{itemize}
879     \item Debian Policy Manual, chapter 6\\
880       {\footnotesize \url{http://www.debian.org/doc/debian-policy/ch-maintainerscripts.html}}
881       
882       \hbr
883     \item Debian Developer's Reference, chapter 6.4\\
884       {\scriptsize \url{http://www.debian.org/doc/developers-reference/best-pkging-practices.html}}
885       \hbr
886     \item {\footnotesize \url{http://people.debian.org/~srivasta/MaintainerScripts.html}}
887     \end{itemize}
888     \br
889   \item Prompting the user
890     \begin{itemize}
891     \item Must be done with \textbf{debconf}
892       \hbr
893     \item Documentation: \texttt{debconf-devel(7)} (\texttt{debconf-doc} package)
894     \end{itemize}
895   \end{itemize}
896 \end{frame}
897
898 \begin{frame}[fragile]{Monitoring upstream versions}
899   \begin{itemize}
900   \item Specify where to look in \texttt{debian/watch} (see \texttt{uscan(1)})
901     \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
902 version=3
903
904 http://tmrc.mit.edu/mirror/twisted/Twisted/(\d\.\d)/ \
905   Twisted-([\d\.]*)\.tar\.bz2
906     \end{lstlisting}
907     \br
908   \item Debian infrastructure that makes use of \texttt{debian/watch}:\\
909     \textbf{Debian External Health Status}\\
910     \url{http://dehs.alioth.debian.org/}
911     \br
912   \item Maintainer warned by emails sent to the Package Tracking System\\
913     \url{http://packages.qa.debian.org/}
914     \br
915   \item \texttt{uscan}: run a manual check
916     \br
917   \item \texttt{uupdate}: try to update your package to the latest upstream version
918   \end{itemize}
919 \end{frame}
920
921 \subsection{Packaging with a VCS (SVN, Git \& friends)}
922 \begin{frame}[fragile]{Packaging with a VCS (SVN, Git, etc.)}
923   \begin{itemize}
924   \item Several tools to help manage branches and tags for your packaging work:\\
925     \texttt{svn-buildpackage}, \texttt{git-buildpackage}
926     \hbr
927   \item Example: \texttt{git-buildpackage}
928     \begin{itemize}
929     \item \texttt{upstream} branch to track upstream with \texttt{upstream/\textsl{version}} tags
930     \item \texttt{master} branch tracks the Debian package
931     \item \texttt{debian/\textsl{version}} tags for each upload
932     \item \texttt{pristine-tar} branch to be able to rebuild the upstream tarball
933     \end{itemize}
934     \hbr
935   \item \texttt{Vcs-*} fields in \texttt{debian/control} to locate the repository
936           \begin{itemize}
937                 \item \url{http://wiki.debian.org/Alioth/Git}
938                 \item \url{http://wiki.debian.org/Alioth/Svn}
939         \end{itemize}
940 \end{itemize}
941   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
942 Vcs-Browser: http://git.debian.org/?p=devscripts/devscripts.git
943 Vcs-Git: git://git.debian.org/devscripts/devscripts.git
944   \end{lstlisting}
945   \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
946 Vcs-Browser: http://svn.debian.org/viewsvn/pkg-perl/trunk/libwww-perl/
947 Vcs-Svn: svn://svn.debian.org/pkg-perl/trunk/libwww-perl
948   \end{lstlisting}
949   \begin{itemize}
950   \item VCS-agnostic interface: \texttt{debcheckout}, \texttt{debcommit},
951     \texttt{debrelease}\\
952     \begin{itemize}
953             \item     \texttt{debcheckout grep} $\rightarrow$ checks out the source package
954     from Git
955     \end{itemize}
956 \end{itemize}
957 \end{frame}
958
959 \subsection{Backporting packages}
960 \begin{frame}{Backporting packages}
961   \begin{itemize}
962   \item Goal: use a newer version of a package on an older system\\
963           e.g use \textsl{mutt} from Debian \textsl{unstable} on Debian \textsl{stable}
964         \br
965   \item General idea:
966           \begin{itemize}
967                 \item Take the source package from Debian unstable
968                 \hbr
969                 \item Modify it so that it builds and works fine on Debian stable
970                 \begin{itemize}
971                         \item Sometimes trivial (no changes needed)
972                         \item Sometimes difficult
973                         \item Sometimes impossible (many unavailable dependencies)
974                 \end{itemize}
975         \end{itemize}
976         \br
977    \item Some backports are provided and supported by the Debian project\\
978            \url{http://backports.debian.org/}
979 \end{itemize}
980 \end{frame}
981
982
983
984 \section{Maintaining packages in Debian}
985 \subsection{Several ways to contribute to Debian}
986 \begin{frame}{Several ways to contribute to Debian}
987   \begin{itemize}
988   \item \textbf{Worst} way to contribute:
989     \begin{enumerate}
990     \item Package your own application
991     \item Get it into Debian
992     \item Disappear
993     \end{enumerate}
994     \br
995   \item \textbf{Better} ways to contribute:
996           \begin{itemize}
997                   \item Get involved in packaging teams
998     \begin{itemize}
999     \item Many teams that focus on set of packages, and need help
1000     \item List available at \url{http://wiki.debian.org/Teams}
1001     \item An excellent way to learn from more experienced contributors
1002     \end{itemize}
1003     \br
1004 \item Adopt existing unmaintained packages (\textsl{orphaned packages})
1005     \br
1006   \item Bring new software to Debian
1007     \begin{itemize}
1008     \item Only if it's interesting/useful enough, please
1009     \item Are there alternatives already packaged in Debian?
1010     \end{itemize}
1011   \end{itemize}
1012
1013   \end{itemize}
1014 \end{frame}
1015
1016 \subsection{Adopting orphaned packages}
1017 \begin{frame}{Adopting orphaned packages}
1018       \hbr
1019   \begin{itemize}
1020     \item Many unmaintained packages in Debian
1021     \hbr
1022   \item Full list + process: \url{http://www.debian.org/devel/wnpp/}
1023     \hbr
1024   \item Installed on your machine: \texttt{wnpp-alert}
1025     \hbr
1026   \item Different states:
1027     \begin{itemize}
1028                     \small
1029     \item \textbf{O}rphaned: the package is unmaintained\\
1030       Feel free to adopt it
1031       \hbr
1032     \item \textbf{RFA}: \textbf{R}equest \textbf{F}or \textbf{A}dopter\\
1033       Maintainer looking for adopter, but continues work in the meantime\\
1034       Feel free to adopt it. A mail to the current maintainer is polite
1035       \hbr
1036     \item \textbf{ITA}: \textbf{I}ntent \textbf{T}o \textbf{A}dopt\\
1037       Someone intends to adopt the package\\
1038       You could propose your help!
1039       \hbr
1040     \item \textbf{RFH}: \textbf{R}equest \textbf{F}or \textbf{H}elp\\
1041       The maintainer is looking for help
1042     \end{itemize}
1043     \hbr
1044   \item Some unmaintained packages not detected \arr not orphaned yet
1045     \hbr
1046   \item When in doubt, ask \texttt{debian-qa@lists.debian.org} \\
1047     or \texttt{\#debian-qa} on \texttt{irc.debian.org}
1048   \end{itemize}
1049 \end{frame}
1050
1051 \subsection{Getting your package in Debian}
1052 \begin{frame}{Getting your package in Debian}
1053 \begin{itemize}
1054 \item You do not need any official status to get your package into Debian
1055         \begin{enumerate}
1056                 \item Prepare a source package
1057                         \hbr
1058                 \item Find a Debian Developer that will sponsor your package
1059         \end{enumerate}
1060 \br
1061 \item Official status (when you are already experienced):
1062         \begin{itemize}
1063                 \item \textbf{Debian Maintainer (DM):}\\
1064                         Permission to upload your own packages\\
1065                         See \url{http://wiki.debian.org/DebianMaintainer}
1066                         \hbr
1067                 \item \textbf{Debian Developer (DD):}\\
1068                         Debian project members; can vote and upload any package
1069         \end{itemize}
1070 \end{itemize}
1071 \end{frame}
1072
1073 \subsection{Where to find help?}
1074 \begin{frame}{Where to find help?}
1075   Help you will need:
1076   \begin{itemize}
1077   \item Advice and answers to your questions, code reviews
1078   \item Sponsorship for your uploads, once your package is ready
1079   \end{itemize}
1080   \br
1081   You can get help from:
1082   \begin{itemize}
1083           \item \textbf{Other members of a packaging team}
1084     \begin{itemize}
1085     \item They know the specifics of your package
1086     \item You can become a member of the team
1087     \end{itemize}
1088     \hbr
1089   \item The Debian Mentors group (if your package doesn't fit in a team)
1090     \begin{itemize}
1091     \item \url{http://wiki.debian.org/DebianMentorsFaq}
1092     \item Mailing list: \url{debian-mentors@lists.debian.org}\\
1093             {\small (also a good way to learn by accident)}
1094     \item IRC: \texttt{\#debian-mentors} on \texttt{irc.debian.org}
1095     \item \url{http://mentors.debian.net/}
1096     \end{itemize}
1097   \end{itemize}
1098 \end{frame}
1099
1100 \subsection{Official documentation}
1101 \begin{frame}{Official documentation}
1102   \begin{itemize}
1103   \item Debian Developers' Corner\\
1104     \url{http://www.debian.org/devel/}\\
1105     {\small Links to many resources about Debian development}
1106     \hbr
1107   \item Debian New Maintainers' Guide\\
1108     \url{http://www.debian.org/doc/maint-guide/}\\
1109     {\small An introduction to Debian packaging, but could use an update}
1110     \hbr
1111   \item Debian Developer's Reference\\
1112     \url{http://www.debian.org/doc/developers-reference/}\\
1113     {\small Mostly about Debian procedures, but also some best packaging practices (part 6)}
1114     \hbr
1115   \item Debian Policy\\
1116     \url{http://www.debian.org/doc/debian-policy/}\\
1117     
1118     {\small \begin{itemize}
1119       \item \small All the requirements that every package must satisfy
1120       \item \small Specific policies for Perl, Java, Python, \ldots
1121       \end{itemize}}
1122     \hbr
1123     
1124   \item Ubuntu Packaging Guide\\
1125     \url{https://wiki.ubuntu.com/PackagingGuide}
1126   \end{itemize}
1127 \end{frame}
1128
1129 \begin{frame}{Debian dashboards for maintainers}
1130   \begin{itemize}
1131           \item \textbf{Source package centric}: Package Tracking System (PTS)\\
1132     \url{http://packages.qa.debian.org/dpkg}
1133     \br
1134   \item \textbf{Maintainer/team centric}: Developer's Packages Overview (DDPO)\\
1135     \url{http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers@lists.alioth.debian.org}
1136   \end{itemize}
1137 \end{frame}
1138
1139 \subsection{More interested in Ubuntu?}
1140 \begin{frame}{More interested in Ubuntu?}
1141   \begin{itemize}
1142   \item Ubuntu mainly manages the divergence with Debian
1143     \br
1144   \item No real focus on specific packages\\
1145     Instead, collaboration with Debian teams
1146     \br
1147   \item Usually recommend uploading new packages to Debian first\\
1148     \url{https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages}
1149     \br
1150   \item Possibly a better plan:
1151     \begin{itemize}
1152     \item Get involved in a Debian team and act as a bridge with Ubuntu
1153       \hbr
1154     \item Help reduce divergence, triage bugs in Launchpad
1155       \hbr
1156     \item Many Debian tools can help:
1157       \begin{itemize}
1158       \item Ubuntu column on the Developer's packages overview
1159       \item Ubuntu box on the Package Tracking System
1160       \item Receive launchpad bugmail via the PTS
1161       \end{itemize}
1162     \end{itemize}
1163   \end{itemize}
1164 \end{frame}
1165
1166 \section{Conclusion}
1167 \subsection{Conclusion}
1168 \begin{frame}{Conclusion}
1169   \begin{itemize}
1170   \item You now have a full overview of Debian packaging
1171     \br
1172   \item But you will need to read more documentation
1173     \br
1174   \item Best practices have evolved over the years
1175     \begin{itemize}
1176     \item If not sure, use the \textbf{dh} packaging helper, and the \textbf{3.0 (quilt)} format
1177     \end{itemize}
1178     \br
1179   \item Things that were not covered in this tutorial:
1180     \begin{itemize}
1181         \item UCF -- manage user changes to configuration files when upgrading
1182                 \hbr
1183         \item dpkg triggers -- group similar maintainer scripts actions together
1184                 \hbr
1185         \item Debian development organization:
1186                 \begin{itemize}
1187                         \item Bug Tracking System (BTS)
1188                         \item Suites: stable, testing, unstable, experimental, security, *-updates, backports, \ldots
1189                         \item Debian Blends -- subsets of Debian targeting specific groups
1190                 \end{itemize}
1191                 \end{itemize}
1192   \end{itemize}
1193   \vfill
1194   \centerline{\large Feedback: \textbf{lucas@debian.org}}
1195 \end{frame}
1196
1197 \subsection{Legal stuff}
1198 \begin{frame}{Legal stuff}
1199
1200   Copyright \copyright 2011 Lucas Nussbaum -- lucas@debian.org
1201   \br
1202
1203   {\small 
1204     \textbf{This document is free software}: you can redistribute it and/or modify
1205     it under either (at your option):
1206     \hbr
1207     \begin{itemize}
1208     \item The terms of the GNU General Public License as published by the Free
1209       Software Foundation, either version 3 of the License, or
1210       (at your option) any later version.\\
1211       \url{http://www.gnu.org/licenses/gpl.html} \br
1212     \item The terms of the Creative Commons Attribution-ShareAlike 3.0 Unported
1213       License.\\ 
1214       \url{http://creativecommons.org/licenses/by-sa/3.0/}
1215     \end{itemize}
1216   }
1217 \end{frame}
1218
1219 \subsection{Latest version \& source code}
1220 \begin{frame}{Latest version \& source code}
1221   \begin{itemize}
1222   \item Latest version:\\
1223     {\footnotesize \url{http://git.debian.org/?p=collab-maint/packaging-tutorial.git;a=blob\_plain;f=packaging-tutorial.pdf;hb=refs/heads/pdf}}
1224   \end{itemize}
1225   
1226   \begin{itemize}
1227   \item Contribute:
1228           \begin{itemize}
1229                   \item  {\small \texttt{git clone\\ git://git.debian.org/collab-maint/packaging-tutorial.git}}
1230     \hbr
1231     \item {\small \texttt{apt-get source packaging-tutorial}}
1232     \hbr
1233     \item {\small \url{http://git.debian.org/?p=collab-maint/packaging-tutorial.git}}
1234     \end{itemize}
1235     \br
1236   \item Feedback: \href{mailto:lucas@debian.org}{\textbf{\texttt{lucas@debian.org}}}
1237   \end{itemize}
1238 \end{frame}
1239
1240 \section{Practical session 2: packaging GNUjump}
1241 \begin{frame}{Practical session 2: packaging GNUjump}
1242 \begin{enumerate}
1243         \item Download GNUjump 1.0.6 from
1244                 \url{http://ftp.gnu.org/gnu/gnujump/1.0.6/gnujump-1.0.6.tar.gz}
1245                 \br
1246         \item Create a Debian package for it
1247                 \begin{itemize}
1248                         \item Install build-dependencies so that you can build the package
1249                         \item Get a basic working package
1250                         \item Finish filling \texttt{debian/control} and other files
1251                 \end{itemize}
1252                 \br
1253         \item Enjoy
1254 \end{enumerate}
1255 \centerline{\includegraphics[width=5cm]{figs/gnujump.png}}
1256 \end{frame}
1257
1258 \section{Practical session 3: packaging a Java library}
1259 \begin{frame}{Practical session 3: packaging a Java library}
1260 \begin{enumerate}
1261         \item Take a quick look at some documentation about Java packaging:\\
1262                 \begin{itemize}
1263                 \item \url{http://wiki.debian.org/Java}
1264       \hbr
1265                 \item \url{http://wiki.debian.org/Java/Packaging}
1266       \hbr
1267                 \item \url{http://www.debian.org/doc/packaging-manuals/java-policy/}
1268       \hbr
1269                 \item \url{http://pkg-java.alioth.debian.org/docs/tutorial.html}
1270       \hbr
1271                 \item Paper and slides from a Debconf10 talk about javahelper:\\
1272                         {\footnotesize
1273                         \url{http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-paper.pdf}\\
1274                         \url{http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-slides.pdf}}
1275                 \end{itemize}
1276                 \br
1277         \item Download IRClib from \url{http://moepii.sourceforge.net/}
1278                 \br
1279         \item Package it
1280 \end{enumerate}
1281 \end{frame}
1282
1283 \section{Practical session 4: packaging a Ruby gem}
1284 \begin{frame}{Practical session 4: packaging a Ruby gem}
1285 \begin{enumerate}
1286         \item Take a quick look at some documentation about Ruby packaging:\\
1287                 \begin{itemize}
1288                 \item \url{http://wiki.debian.org/Ruby}
1289       \hbr
1290                 \item \url{http://wiki.debian.org/Teams/Ruby}
1291       \hbr
1292                 \item \url{http://wiki.debian.org/Teams/Ruby/Packaging}
1293       \hbr
1294                 \item \texttt{gem2deb(1)}, \texttt{dh\_ruby(1)} (in the \texttt{gem2deb} package)
1295                 \end{itemize}
1296                 \hbr
1297         \item Create a basic Debian source package from the \texttt{net-ssh} gem:\\
1298                 \texttt{gem2deb net-ssh}
1299         \hbr
1300         \item Improve it so that it becomes a proper Debian package
1301 \end{enumerate}
1302 \end{frame}
1303
1304 \section{Answers to practical sessions}
1305
1306 \begin{frame}
1307         \begin{center}
1308                 \LARGE Answers to\\[0.5em]  practical sessions
1309         \end{center}
1310 \end{frame}
1311
1312
1313 \subsection{Practical session 1: modifying the grep package}
1314
1315 \begin{frame}{Practical session 1: modifying the grep package}
1316 \begin{enumerate}
1317   \item Go to \url{http://ftp.debian.org/debian/pool/main/g/grep/} and
1318     download version 2.6.3-3 of the package (if you use Ubuntu 11.10 or
1319     later, or Debian testing or unstable, use version 2.9-1 or 2.9-2 instead)
1320
1321         \item Look at the files in \texttt{debian/}.
1322                 \begin{itemize}
1323                         \item           How many binary packages are generated by this source package?
1324                         \item           Which packaging helper does this package use?
1325                 \end{itemize}
1326     \hbr
1327         \item Build the package
1328     \hbr
1329         \item We are now going to modify the package. Add a changelog entry and increase the version number.
1330     \hbr
1331         \item Now disable perl-regexp support (it is a \texttt{./configure} option)
1332     \hbr
1333         \item Rebuild the package
1334     \hbr
1335         \item Compare the original and the new package with debdiff
1336     \hbr
1337         \item Install the newly built package
1338     \hbr
1339         \item Cry if you messed up ;)
1340 \end{enumerate}
1341 \end{frame}
1342
1343 \begin{frame}{Fetching the source}
1344 \begin{enumerate}
1345         \item Go to \url{http://ftp.debian.org/debian/pool/main/g/grep/} and
1346                 download version 2.6.3-3 of the package
1347 \end{enumerate}
1348 \begin{itemize}
1349         \item Use dget to download the \texttt{.dsc} file:\\
1350                 {\small \texttt{dget http://cdn.debian.net/debian/pool/main/g/grep/grep\_2.6.3-3.dsc}}
1351                 \hbr
1352         \item According to \texttt{http://packages.qa.debian.org/grep}, \texttt{grep} version 2.6.3-3 is currently in \textsl{stable} (\textsl{squeeze}). If you have \texttt{deb-src} lines for \textsl{squeeze} in your \texttt{/etc/apt/sources.list}, you can use:\\
1353                 \texttt{apt-get source grep=2.6.3-3}\\
1354                 or \texttt{apt-get source grep/stable}\\
1355                 or, if you feel lucky: \texttt{apt-get source grep}
1356         \hbr
1357         \item The \texttt{grep} source package is composed of three files:
1358                 \begin{itemize}
1359                         \item \texttt{grep\_2.6.3-3.dsc}
1360                         \item \texttt{grep\_2.6.3-3.debian.tar.bz2}
1361                         \item \texttt{grep\_2.6.3.orig.tar.bz2}
1362                 \end{itemize}
1363                 This is typical of the "3.0 (quilt)" format.
1364         \hbr
1365 \item If needed, uncompress the source with\\
1366         \texttt{dpkg-source -x grep\_2.6.3-3.dsc}
1367 \end{itemize}
1368 \end{frame}
1369
1370 \begin{frame}{Looking around and building the package}
1371         \begin{enumerate}
1372                         \setcounter{enumi}{1}
1373         \item Look at the files in \texttt{debian/}.
1374                 \begin{itemize}
1375                         \item           How many binary packages are generated by this source package?
1376                         \item           Which packaging helper does this package use?
1377                 \end{itemize}
1378         \end{enumerate}
1379         \hbr
1380         \begin{itemize}
1381                 \item According to \texttt{debian/control}, this package only generates one binary package, named \texttt{grep}.
1382                         \hbr
1383                 \item According to \texttt{debian/rules}, this package is typical of \textsl{classic} debhelper packaging, without using \textsl{CDBS} or \textsl{dh}. One can see the various calls to \texttt{dh\_*} commands in \texttt{debian/rules}.
1384         \end{itemize}
1385         \hbr
1386         \begin{enumerate}
1387                         \setcounter{enumi}{2}
1388
1389                 \item Build the package
1390         \end{enumerate}
1391         \hbr
1392         \begin{itemize}
1393                 \item Use \texttt{apt-get build-dep grep} to fetch the build-dependencies
1394                 \item Then \texttt{debuild} or \texttt{dpkg-buildpackage -us -uc} (Takes about 1 min)
1395         \end{itemize}
1396 \end{frame}
1397
1398 \begin{frame}{Editing the changelog}
1399         \begin{enumerate}
1400                         \setcounter{enumi}{3}
1401
1402         \item We are now going to modify the package. Add a changelog entry and increase the version number.
1403         \end{enumerate}
1404         \hbr
1405         \begin{itemize}
1406                 \item \texttt{debian/changelog} is a text file. You could edit it and add a new entry manually.
1407         \hbr
1408                 \item Or you can use \texttt{dch -i}, which will add an entry and open the editor
1409         \hbr
1410                 \item The name and email can be defined using the \texttt{DEBFULLNAME} and \texttt{DEBEMAIL} environment variables
1411         \hbr
1412                 \item After that, rebuild the package: a new version of the package is built
1413         \hbr
1414                 \item Package versioning is detailed in section 5.6.12 of the Debian policy\\
1415                         \url{http://www.debian.org/doc/debian-policy/ch-controlfields.html}
1416         \end{itemize}
1417 \end{frame}
1418
1419 \begin{frame}{Disabling Perl regexp support and rebuilding}
1420         \begin{enumerate}
1421                         \setcounter{enumi}{4}
1422
1423         \item Now disable perl-regexp support (it is a \texttt{./configure} option)
1424         \item Rebuild the package
1425         \end{enumerate}
1426         \hbr
1427         \begin{itemize}
1428           \item Check with \texttt{./configure -{}-help}: the option to disable
1429             Perl regexp is \texttt{-{}-disable-perl-regexp}
1430         \hbr
1431                 \item Edit \texttt{debian/rules} and find the \texttt{./configure} line
1432         \hbr
1433                 \item Add \texttt{-{}-disable-perl-regexp}
1434         \hbr
1435                 \item Rebuild with \texttt{debuild} or \texttt{dpkg-buildpackage -us -uc}
1436         \end{itemize}
1437 \end{frame}
1438
1439 \begin{frame}{Comparing and testing the packages}
1440         \begin{enumerate}
1441                         \setcounter{enumi}{6}
1442
1443         \item Compare the original and the new package with debdiff
1444         \item Install the newly built package
1445         \end{enumerate}
1446         \hbr
1447         \begin{itemize}
1448                 \item Compare the binary packages: \texttt{debdiff ../*changes}
1449         \hbr
1450                 \item Compare the source packages: \texttt{debdiff ../*dsc}
1451         \hbr
1452                 \item Install the newly built package: \texttt{debi}\\
1453                         Or \texttt{dpkg -i ../grep\_<TAB>}
1454         \hbr
1455                 \item \texttt{grep -P foo} no longer works!
1456         \end{itemize}
1457 \br
1458 \begin{enumerate}
1459                 \setcounter{enumi}{8}
1460         \item Cry if you messed up ;)
1461 \end{enumerate}
1462 \hbr
1463 Or not: reinstall the previous version of the package:
1464 \begin{itemize}
1465         \item \texttt{apt-get install -{}-reinstall grep=2.6.3-3} \textit{(= previous version)}
1466 \end{itemize}
1467 \end{frame}
1468
1469 \subsection{Practical session 2: packaging GNUjump}
1470 \begin{frame}{Practical session 2: packaging GNUjump}
1471 \begin{enumerate}
1472         \item Download GNUjump 1.0.6 from
1473                 \url{http://ftp.gnu.org/gnu/gnujump/1.0.6/gnujump-1.0.6.tar.gz}
1474                 \br
1475         \item Create a Debian package for it
1476                 \begin{itemize}
1477                         \item Install build-dependencies so that you can build the package
1478                         \item Get a basic working package
1479                         \item Finish filling \texttt{debian/control} and other files
1480                 \end{itemize}
1481                 \br
1482         \item Enjoy
1483 \end{enumerate}
1484 \centerline{\includegraphics[width=5cm]{figs/gnujump.png}}
1485 \end{frame}
1486
1487 \begin{frame}[fragile]{Step by step\ldots}
1488 \begin{itemize}
1489         \item \texttt{wget http://ftp.gnu.org/gnu/gnujump/1.0.6/gnujump-1.0.6.tar.gz}
1490                 \hbr
1491         \item \texttt{mv gnujump-1.0.6.tar.gz gnujump\_1.0.6.orig.tar.gz}
1492                 \hbr
1493         \item \texttt{tar xf gnujump\_1.0.6.orig.tar.gz}
1494                 \hbr
1495         \item \texttt{cd gnujump-1.0.6/}
1496                 \hbr
1497         \item \texttt{dh\_make}
1498         \begin{itemize}
1499                 \item \small Type of package: single binary (for now)
1500         \end{itemize}
1501 \end{itemize}
1502 \begin{lstlisting}[basicstyle=\ttfamily\small]
1503 gnujump-1.0.6$ ls debian/
1504 changelog           gnujump.default.ex   preinst.ex
1505 compat              gnujump.doc-base.EX  prerm.ex
1506 control             init.d.ex            README.Debian
1507 copyright           manpage.1.ex         README.source
1508 docs                manpage.sgml.ex      rules
1509 emacsen-install.ex  manpage.xml.ex       source
1510 emacsen-remove.ex   menu.ex              watch.ex
1511 emacsen-startup.ex  postinst.ex
1512 gnujump.cron.d.ex   postrm.ex
1513 \end{lstlisting}
1514 \end{frame}
1515
1516 \begin{frame}[fragile]{Step by step\ldots (2)}
1517 \begin{itemize}
1518         \item Look at \texttt{debian/changelog}, \texttt{debian/rules}, \texttt{debian/control}\\
1519                 (auto-filled by \textbf{dh\_make})
1520                 \hbr
1521         \item In \texttt{debian/control}:\\
1522                 \texttt{Build-Depends: debhelper (>= 7.0.50~), autotools-dev}\\
1523                 Lists the \textsl{build-dependencies} = packages needed to build the package
1524                 \hbr
1525         \item Try to build the package as-is (thanks to \textbf{dh} magic)
1526                 \begin{itemize}
1527                         \item And add build-dependencies, until it builds
1528                         \item Hint: use \texttt{apt-cache search} and \texttt{apt-file} to find the packages
1529                         \item Example:
1530 \begin{lstlisting}[basicstyle=\ttfamily\footnotesize]
1531 checking for sdl-config... no
1532 checking for SDL - version >= 1.2.0... no
1533 [...]
1534 configure: error: *** SDL version 1.2.0 not found!
1535 \end{lstlisting}
1536 $\rightarrow$ Add \textbf{libsdl1.2-dev} to Build-Depends and install it.
1537                 \hbr
1538         \item Better: use \textbf{pbuilder} to build in a clean environment
1539                 \end{itemize}
1540 \end{itemize}
1541 \end{frame}
1542
1543 \begin{frame}{Step by step\ldots (3)}
1544 \begin{itemize}
1545         \item After installing \texttt{libsdl1.2-dev, libsdl-image1.2-dev, libsdl-mixer1.2-dev}, the package builds fine.
1546                 \hbr
1547         \item Use \texttt{debc} to list the content of the generated package.
1548                 \hbr
1549         \item Use \texttt{debi} to install it and test it.
1550                 \hbr
1551         \item Fill in \texttt{debian/control} using \url{http://www.debian.org/doc/debian-policy/ch-controlfields.html}
1552                 \hbr
1553         \item Test the package with \texttt{lintian}
1554                 \hbr
1555         \item Remove the files that you don't need in \texttt{debian/}
1556                 \hbr
1557         \item Compare your package with the one already packaged in Debian:
1558                 \begin{itemize}
1559                         \item It splits the data files to a second package, that is the same across all architectures ($\rightarrow$ saves space in the Debian archive)
1560                         \item It installs a .desktop file (for the GNOME/KDE menus) and also integrates into the Debian menu
1561                         \item It fixes a few minor problems using patches
1562                 \end{itemize}
1563 \end{itemize}
1564 \end{frame}
1565
1566 \subsection{Practical session 3: packaging a Java library}
1567 \begin{frame}{Practical session 3: packaging a Java library}
1568 \begin{enumerate}
1569         \item Take a quick look at some documentation about Java packaging:\\
1570                 \begin{itemize}
1571                 \item \url{http://wiki.debian.org/Java}
1572       \hbr
1573                 \item \url{http://wiki.debian.org/Java/Packaging}
1574       \hbr
1575                 \item \url{http://www.debian.org/doc/packaging-manuals/java-policy/}
1576       \hbr
1577                 \item \url{http://pkg-java.alioth.debian.org/docs/tutorial.html}
1578       \hbr
1579                 \item Paper and slides from a Debconf10 talk about javahelper:\\
1580                         {\footnotesize
1581                         \url{http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-paper.pdf}\\
1582                         \url{http://pkg-java.alioth.debian.org/docs/debconf10-javahelper-slides.pdf}}
1583                 \end{itemize}
1584                 \br
1585         \item Download IRClib from \url{http://moepii.sourceforge.net/}
1586                 \br
1587         \item Package it
1588 \end{enumerate}
1589 \end{frame}
1590
1591 \begin{frame}{Step by step\ldots}
1592 \begin{itemize}
1593         \item \texttt{apt-get install javahelper}
1594                 \hbr
1595         \item Create a basic source package: \texttt{jh\_makepkg}
1596                 \begin{itemize}
1597                         \item Library
1598                         \item None
1599                         \item Default Free compiler/runtime
1600                 \end{itemize}
1601                 \hbr
1602         \item Look at and fix \texttt{debian/*}
1603                 \hbr
1604         \item \texttt{dpkg-buildpackage -us -uc} or \texttt{debuild}
1605                 \hbr
1606         \item \texttt{lintian}, \texttt{debc}, etc.
1607                 \hbr
1608         \item Compare your result with the \texttt{libirclib-java} source package
1609 \end{itemize}
1610 \end{frame}
1611
1612 \subsection{Practical session 4: packaging a Ruby gem}
1613 \begin{frame}{Practical session 4: packaging a Ruby gem}
1614 \begin{enumerate}
1615         \item Take a quick look at some documentation about Ruby packaging:\\
1616                 \begin{itemize}
1617                 \item \url{http://wiki.debian.org/Ruby}
1618       \hbr
1619                 \item \url{http://wiki.debian.org/Teams/Ruby}
1620       \hbr
1621                 \item \url{http://wiki.debian.org/Teams/Ruby/Packaging}
1622       \hbr
1623                 \item \texttt{gem2deb(1)}, \texttt{dh\_ruby(1)} (in the \texttt{gem2deb} package)
1624                 \end{itemize}
1625                 \hbr
1626         \item Create a basic Debian source package from the \texttt{net-ssh} gem:\\
1627                 \texttt{gem2deb net-ssh}
1628         \hbr
1629         \item Improve it so that it becomes a proper Debian package
1630 \end{enumerate}
1631 \end{frame}
1632
1633 \begin{frame}{Step by step\ldots}
1634 \texttt{gem2deb net-ssh}:
1635 \begin{itemize}
1636 \item Downloads the gem from rubygems.org
1637 \item Creates a suitable .orig.tar.gz archive, and untar it
1638 \item Initializes a Debian source package based on the gem's metadata
1639         \begin{itemize}
1640                 \item Named \texttt{ruby-\textsl{gemname}}
1641         \end{itemize}
1642 \item Tries to build the Debian binary package (this might fail)
1643 \end{itemize}
1644 \br
1645 \texttt{dh\_ruby} (included in \textsl{gem2deb}) does the Ruby-specific tasks:
1646 \begin{itemize}
1647         \item Build C extensions for each Ruby version
1648         \item Copy files to their destination directory
1649         \item Update shebangs in executable scripts
1650         \item Run tests defined in \texttt{debian/ruby-tests.rb} or \texttt{debian/ruby-test-files.yaml}, as well as various other checks
1651 \end{itemize}
1652 \end{frame}
1653
1654 \begin{frame}[fragile]{Step by step\ldots (2)}
1655 Improve the generated package:
1656 \begin{itemize}
1657         \item Run \texttt{debclean} to clean the source tree. Look at \texttt{debian/}.
1658                 \hbr
1659         \item \texttt{changelog} and \texttt{compat} should be correct
1660                 \hbr
1661         \item Edit \texttt{debian/control}: uncomment \texttt{Homepage}, improve \texttt{Description}
1662                 \hbr
1663         \item Write a proper \texttt{copyright} file based on the upstream files
1664                 \hbr
1665         \item \texttt{ruby-net-ssh.docs}: install \texttt{README.rdoc}
1666                 \hbr
1667         \item \texttt{ruby-tests.rb}: run the tests. In that case, it is enough to do:\\
1668                 \verb+$: << 'test' << 'lib' << '.'+\\
1669                 \verb+require 'test/test_all.rb'+
1670 \end{itemize}
1671 \end{frame}
1672
1673 \begin{frame}[fragile]{Step by step\ldots (3)}
1674 Build the package.
1675 It fails to build. There are two problems:
1676 \begin{itemize}
1677         \item You need to disable the \texttt{gem} call in the test suite.\\
1678         In \texttt{test/common.rb}, remove the \verb+gem "test-unit"+ line:
1679                 \begin{itemize}
1680                         \item \texttt{edit-patch disable-gem.patch}
1681                         \item Edit \texttt{test/common.rb}, remove the \texttt{gem} line. Exit the sub-shell
1682                         \item Describe the changes in \texttt{debian/changelog}
1683                         \item Document the patch in \texttt{debian/patches/disable-gem.patch}
1684                 \end{itemize}
1685                 \hbr
1686
1687         \item The package lacks a build-dependency on \texttt{ruby-mocha},
1688                 which is used by the test suite (you might need to build your
1689                 package in a clean environment, using \texttt{pbuilder}, to
1690                 reproduce that problem)
1691
1692                 \begin{itemize}
1693                         \item Add \texttt{ruby-mocha} to the package's \texttt{Build-Depends}
1694
1695                         \item \textsl{gem2deb} copies the dependencies
1696                                 documented in the \textsl{gem} as comments in
1697                                 \texttt{debian/control}, but \textsl{mocha} is
1698                                 not listed as a development dependency by the
1699                                 gem (that's a bug in the gem)
1700                 \end{itemize}
1701 \end{itemize}
1702 \hbr
1703 Compare your package with the \texttt{ruby-net-ssh} package in the Debian archive
1704 \end{frame}
1705
1706 \end{document}