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