/[ddp]/manuals/trunk/maint-guide/maint-guide.en.dbk

Diff of /manuals/trunk/maint-guide/maint-guide.en.dbk

Parent Directory | Revision Log | View Patch Patch

-revision 8640 by osamu,
Wed Apr  6 19:00:00 2011 UTC
+revision 8718 by osamu,
Sun Apr 24 09:54:41 2011 UTC
 Line 2
  <!-- -*- DocBook -*- -->
  <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+ <!ENTITY % trans    SYSTEM "po4a/maint-guide.en.ent">   %trans;
  <!ENTITY % common   SYSTEM "common.ent">   %common;
  <!ENTITY % version  SYSTEM "version.ent">  %version;
  ]>
  <book lang="en">
  <!-- This is UTF-8 encoded. -->
- <!-- This is reorganized to make this document robust for translaion when some externally referenced information changes. -->
+ <!--
- <title>Debian New Maintainers' Guide</title>
+ This is reorganized to make this document robust for translation
- <bookinfo>
+ when some externally referenced information changes.
- <authorgroup>
- <author> <personname> <firstname>Josip</firstname> <surname>Rodin</surname> </personname> <email>joy-mg@debian.org</email> <contrib>(original contents)</contrib> </author>
- <author> <personname> <firstname>Osamu</firstname> <surname>Aoki</surname> </personname> <email>osamu@debian.org</email> <contrib>(updated contents)</contrib> </author>
+ If you want to add extra contents to this document, please do so by
+  * adding tag like &othercredit; in English and provide it for each language.
+  * add extra content within msgstr but within <footnote>...</footnote>
+ Please note there will be content checker to match tags of msgid and msgstr.
+ The second rule is a way to get exception to this rule.
+ Please try to correct something in translation.  If you think contents needs fix,
+ Let's fix it in the root cause.
- <!-- BEGIN: Add othercredit for translator via po4a/maint-guide.*.patch -->
+ Please understand to keep this document focused.  Not everything you think important
- <!-- END: Add othercredit for translator via po4a/maint-guide.*.patch -->
+ for new maintainer should be written down.  Something social needs to be elsewhere.
- <!-- dummy -->
+ Some thing should be left to the practice.  Something needs to be left for exercise
- <!-- dummy -->
+ for people to check official documentations.
+ -->
+ <title>Debian New Maintainers' Guide</title>
+ <bookinfo>
+ <authorgroup>
+ <!-- do not use firstname and surname tags it braks Japanese.  The same with othercredit -->
+ <author> <personname>Josip Rodin</personname> <email>joy-mg@debian.org</email> <contrib>original contents</contrib> </author>
+ <author> <personname>Osamu Aoki</personname> <email>osamu@debian.org</email> <contrib>updated contents</contrib> </author>
+ <!-- translator credits in po4a/translator.*.ent -->
+ &othercredit;
  </authorgroup>
  <releaseinfo>version &docversion;</releaseinfo>
  <pubdate>&docisodate;</pubdate>
-Line 36 
 version 2 or higher.
+Line 49 
 version 2 or higher.
  <para>
  This document was made using with these two documents as examples:
  </para>
+ <itemizedlist>
+ <listitem>
  <para>
  Making a Debian Package (AKA the Debmake Manual), copyright © 1997 Jaldhar
  Vyas.
  </para>
+ </listitem>
+ <listitem>
  <para>
  The New-Maintainer's Debian Packaging Howto, copyright © 1997 Will Lowe.
  </para>
+ </listitem>
+ </itemizedlist>
  </legalnotice>
  <!-- toc -->
  </bookinfo>
  <chapter id="start"><title>Getting started The Right Way</title>
  <para>
- This document tries to describe building of a Debian package to the common
+ This document tries to describe the building of a Debian package to ordinary
- Debian user, and the prospectus developer.  It uses pretty common language, and
+ Debian users and prospective developers.  It uses fairly non-technical language, and
- it's well covered with working examples.  There is an old Roman saying,
+ it's well covered with working examples.  There is an old Latin saying:
- <emphasis>Longum iter est per preaecepta, breve et efficax per
+ <emphasis>Longum iter est per praecepta, breve et efficax per
- exempla!</emphasis> (It's a long way by the rules, but short and efficient with
+ exempla</emphasis> (It's a long way by the rules, but short and efficient with
- examples!).
+ examples).
  </para>
  <para>
  This document has been updated for the Debian <literal>&base-release;</literal>
  release.
- <footnote><para> The document assumes you are using the
+ <footnote><para> The document assumes you are using a
- <literal>&base-release;</literal> system or newer.  If you need to follow this
+ <literal>&base-release;</literal> or newer system.  If you need to follow this
- text in the older system (including the older Ubuntu system etc.), you must
+ text in an older system (including an older Ubuntu system etc.), you must
  install backported <systemitem role="package">dpkg</systemitem> and
  <systemitem role="package">debhelper</systemitem> packages, at least.
  </para> </footnote>
-Line 69 
 install backported <systemitem role="pac
+Line 88 
 install backported <systemitem role="pac
  One of the things that makes Debian such a top-notch distribution is its
  package system.  While there is a vast quantity of software already in the
  Debian format, sometimes you need to install software that isn't.  You may be
- wondering how you can make your own packages and perhaps you think it is a very
+ wondering how you can make your own packages; and perhaps you think it is a very
  difficult task.  Well, if you are a real novice on Linux, it is hard, but if
- you were rookie, you wouldn't be reading this doc now.  :-) You do need to know
+ you were a rookie, you wouldn't be reading this document now&nbsp;:-)
- a little about Unix programming but you certainly don't need to be a wizard.
+ You do need to know a little about Unix programming but you certainly
+ don't need to be a wizard.
  <footnote><para>
- You can learn basic operations of the Debian system from
+ You can learn about the basic handling of a Debian system from the
  <ulink url="&debref;">Debian Reference</ulink>.  It contains some pointers to
  learn about Unix programming, too.
  </para></footnote>
  </para>
  <para>
  One thing is certain, though: to properly create and maintain Debian packages
- you need many hours.  Make no mistake, for our system to work the maintainers
+ takes many hours.  Make no mistake, for our system to work the maintainers
  need to be both technically competent and diligent.
  </para>
  <para>
  This document will explain every little (at first maybe irrelevant) step, and
  help you create that first package, and to gain some experience in building
- next releases of that and maybe other packages later on.
+ the next releases of that and maybe other packages later on.
  </para>
  <para>
- If you need some help on packaging, please read <xref linkend="helpme"/> .
+ If you need some help on packaging, please read <xref linkend="helpme"/>.
  </para>
  <para>
  Newer versions of this document should always be available online at
  <ulink url="&maint-guide;"/> and in the
  <systemitem role="package">maint-guide</systemitem> package.
  The translations may be available in packages such as
  <systemitem role="package">maint-guide-es</systemitem>.
+ Please note that this documentation may be slightly outdated.
  </para>
- <section id="needprogs"><title>Programs you need for development</title>
+ <section id="socialdynamism"><title>Social dynamics of Debian</title>
  <para>
- Before you start anything, you should make sure that you have properly
+ Here are some observations of Debian's social dynamics, presented in the hope
- installed some additional packages needed for development.  Note that the list
+ that it will prepare you for interactions with Debian.
- doesn't contain any packages marked <literal>essential</literal> or
- <literal>required</literal> - we expect that you have those installed already.
- </para>
- <para>
- The following packages come with the standard Debian installation, so you
- probably have them already (along with any additional packages they depend on).
- Still, you should check it with <literal>aptitude show
- <replaceable>package</replaceable></literal>
- or with <literal>dpkg -s <replaceable>package</replaceable></literal>.
- </para>
- <para>
- The most important package to install on your development system is the
- <systemitem role="package">build-essential</systemitem> package.  Once you try
- to install it, it will <emphasis>pull in</emphasis> other packages required to
- have a basic build environment.
- </para>
- <para>
- For some types of packages, that is all you will require, however there is
- another set of packages that while not essential for all package builds are
- useful to have install or may be required by your package:
  </para>
  <itemizedlist>
- <listitem>
+ <listitem><para>We all are volunteers.</para>
- <para>
+     <itemizedlist>
- <systemitem role="package">file</systemitem> - this handy program can determine
+     <listitem><para>You cannot impose on others what to do.</para></listitem>
- what type a file is.  (see <citerefentry> <refentrytitle>file</refentrytitle>
+     <listitem><para>You should be motivated to do things by yourself.</para></listitem>
- <manvolnum>1</manvolnum> </citerefentry>)
+     </itemizedlist></listitem>
- </para>
+ <listitem><para>Friendly cooperation is the driving force.</para>
- </listitem>
+     <itemizedlist>
- <listitem>
+     <listitem><para>Your contribution should not overstrain others.</para></listitem>
- <para>
+     <listitem><para>Your contribution is valuable only when others appreciate it.</para></listitem>
- <systemitem role="package">patch</systemitem> - this very useful utility will
+     </itemizedlist></listitem>
- take a file containing a difference listing (produced by the
+ <listitem><para>Debian is not your school where you get automatic attention of teachers.</para>
- <command>diff</command> program) and apply it to the original file, producing a
+     <itemizedlist>
- patched version.  (see <citerefentry> <refentrytitle>patch</refentrytitle>
+     <listitem><para>You should be able to learn many things by yourself.</para></listitem>
- <manvolnum>1</manvolnum> </citerefentry>)
+     <listitem><para>Attention from other volunteers is a very scarce resource.</para></listitem>
- </para>
+     </itemizedlist></listitem>
- </listitem>
+ <listitem><para>Debian is constantly improving.</para>
- <listitem>
+     <itemizedlist>
- <para>
+     <listitem><para>You are expected to make high quality packages.</para></listitem>
- <systemitem role="package">perl</systemitem> - Perl is one of the most used
+     <listitem><para>You should adapt yourself to change.</para></listitem>
- interpreted scripting languages on today's Unix-like systems, often referred to
+     </itemizedlist></listitem>
- as Unix's Swiss Army Chainsaw.  (see <citerefentry>
+ </itemizedlist>
- <refentrytitle>perl</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>)
- </para>
- </listitem>
- <listitem>
  <para>
- <systemitem role="package">python</systemitem> - Python is another of the most
+ There are several types of people interacting around Debian with different
- used interpreted scripting languages on the Debian system that combines
+ roles.
- remarkable power with very clear syntax.  (see <citerefentry>
- <refentrytitle>python</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>)
  </para>
- </listitem>
+ <itemizedlist>
  <listitem>
  <para>
- <systemitem role="package">autoconf</systemitem>, <systemitem role="package">automake</systemitem> and <systemitem role="package">autotools-dev</systemitem> - many newer programs use configure
+ <emphasis role="strong">upstream author</emphasis>: the person who made the
- scripts and <filename>Makefile</filename> files preprocessed with help of
+ original program.
- programs like these.  (see <literal>info autoconf</literal>, <literal>info
- automake</literal>).  The <systemitem role="package">autotools-dev</systemitem>
- keeps up-to-date versions of certain auto files and has documentation about the
- best way to use those files.
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">dh-make</systemitem> and <systemitem role="package">debhelper</systemitem> - <systemitem role="package">dh-make</systemitem> is necessary to create the skeleton of our
+ <emphasis role="strong">upstream maintainer</emphasis>: the person who
- example package, and it will use some of the <systemitem role="package">debhelper</systemitem> tools for creating packages.  They are
+ currently maintains the program.
- not essential for creation of packages, but are <emphasis>highly</emphasis>
- recommended for new maintainers.  It makes the whole process very much easier
- to start, and control afterwards.  (see <citerefentry>
- <refentrytitle>dh_make</refentrytitle> <manvolnum>1</manvolnum>
- </citerefentry>, <citerefentry> <refentrytitle>debhelper</refentrytitle>
- <manvolnum>1</manvolnum> </citerefentry>) <footnote><para> There
- are few similar but specialized packages such as <systemitem role="package">dh-make-perl</systemitem>, <systemitem role="package">dh-make-php</systemitem>, etc.  </para> </footnote>
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">devscripts</systemitem> - this package contains some
+ <emphasis role="strong">maintainer</emphasis>: the person making the Debian
- nice and useful scripts that can be helpful to the maintainers, but they are
+ package of the program.
- also not necessary for building packages.  Packages recommended and suggested
- by this package are worth looking into.  (see
- <ulink url="&devscripts-readme;"/>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">fakeroot</systemitem> - this utility lets you
+ <emphasis role="strong">sponsor</emphasis>: a person who helps maintainers to
- emulate being root which is necessary for some parts of the build process.
+ upload packages to the official Debian package archive (after checking their
- (see <citerefentry> <refentrytitle>fakeroot</refentrytitle>
+ contents).
- <manvolnum>1</manvolnum> </citerefentry>)
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">gnupg</systemitem> - a tool that enables you to
+ <emphasis role="strong">mentor</emphasis>: a person who helps novice
- digitally <emphasis>sign</emphasis> packages.  This is especially important if
+ maintainers with packaging etc.
- you want to distribute it to other people, and you will certainly be doing that
- when your work gets included in the Debian distribution.  (see <citerefentry>
- <refentrytitle>gpg</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>)
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">gfortran</systemitem> - the GNU Fortran 95 compiler,
+ <emphasis role="strong">Debian Developer</emphasis> (DD): a member of
- necessary if your program is written in Fortran.  (see <citerefentry>
+ the Debian project with full upload rights to the official Debian package
- <refentrytitle>gfortran</refentrytitle> <manvolnum>1</manvolnum>
+ archive.
- </citerefentry>)
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">gpc</systemitem> - the GNU Pascal compiler,
+ <emphasis role="strong">Debian Maintainer</emphasis> (DM): a person with
- necessary if your program is written in Pascal.  Worthy of note here is
+ limited upload rights to the official Debian package archive.
- <systemitem role="package">fp-compiler</systemitem>, the Free Pascal Compiler,
- which is also good at this task.  (see <citerefentry>
- <refentrytitle>gpc</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>,
- <citerefentry> <refentrytitle>ppc386</refentrytitle> <manvolnum>1</manvolnum>
- </citerefentry>)
  </para>
  </listitem>
- <listitem>
+ </itemizedlist>
  <para>
- <systemitem role="package">xutils-dev</systemitem> - some programs, usually
+ Please note that you cannot become an official
- those made for X11, also use these programs to generate
+ <emphasis role="strong">Debian Developer</emphasis> (DD) overnight, because it
- <filename>Makefile</filename> files from sets of macro functions.  (see
+ takes more than technical skill.  Please do not be discouraged by this.  If it
- <citerefentry> <refentrytitle>imake</refentrytitle> <manvolnum>1</manvolnum>
+ is useful to others, you can still upload your package either as a
- </citerefentry>, <citerefentry> <refentrytitle>xmkmf</refentrytitle>
+ <emphasis role="strong">maintainer</emphasis> through a
- <manvolnum>1</manvolnum> </citerefentry>)
+ <emphasis role="strong">sponsor</emphasis> or as a
+ <emphasis role="strong">Debian Maintainer</emphasis>.
  </para>
- </listitem>
- <listitem>
  <para>
- <systemitem role="package">lintian</systemitem> - this is the Debian package
+ Please note that you do not need to create any new package to become an
- checker that can let you know of any common mistakes after you build the
+ official Debian Developer.  Contributing to the existing packages can provide a
- package, and explains the errors found.  (see <citerefentry>
+ path to becoming an official Debian Developer too.  There are many packages
- <refentrytitle>lintian</refentrytitle> <manvolnum>1</manvolnum>
+ waiting for good maintainers (see <xref linkend="choose"/>).
- </citerefentry>,
- <ulink url="&lintian-doc;">Lintian User's Manual</ulink>)
  </para>
- </listitem>
- <listitem>
  <para>
- <systemitem role="package">pbuilder</systemitem> - this package contains
+ Since we focus only on technical aspects of packaging in this document,
- programs which are used for creating and maintaining <command>chroot</command>
+ please refer to the following to learn how Debian functions and how you can get involved.
- environment.  Building Debian package in this <command>chroot</command>
- environment verifies the proper build dependency and avoid FTBFS (Fails To
- Build From Source) bugs.  (see <citerefentry>
- <refentrytitle>pbuilder</refentrytitle> <manvolnum>8</manvolnum>
- </citerefentry> and <citerefentry> <refentrytitle>pdebuild</refentrytitle>
- <manvolnum>1</manvolnum> </citerefentry>)
  </para>
- </listitem>
+ <itemizedlist>
- <listitem>
+ <listitem><para><ulink url="&logiciellibre;">Debian: 17 years of Free Software, "do-ocracy", and democracy</ulink> (Introductory slides) </para> </listitem>
+ <listitem><para><ulink url="&debianorghelp;">How can you help Debian?</ulink> (official) </para> </listitem>
+ <listitem><para><ulink url="&debianfaqhelp;">The Debian GNU/Linux FAQ, Chapter 13 - 'Contributing to the Debian Project'</ulink> (semi-official) </para> </listitem>
+ <listitem><para><ulink url="&debianwikihelp;">Debian Wiki, HelpDebian</ulink> (supplemental) </para> </listitem>
+ <listitem><para><ulink url="&nm-do;">Debian New Maintainer site</ulink> (official) </para> </listitem>
+ <listitem><para><ulink url="&debianmentorfaq;">Debian Mentors FAQ</ulink> (supplemental) </para> </listitem>
+ </itemizedlist>
+ </section>
+ <section id="needprogs"><title>Programs you need for development</title>
  <para>
- <systemitem role="package">patchutils</systemitem> - this package contains some
+ Before you start anything, you should make sure that you have properly
- utilities to work with patches such as the <command>lsdiff</command>,
+ installed some additional packages needed for development.  Note that the list
- <command>interdiff</command> and <command>filterdiff</command> commands.
+ doesn't contain any packages marked <literal>essential</literal> or
+ <literal>required</literal> - we expect that you have those installed already.
  </para>
- </listitem>
- <listitem>
  <para>
- <systemitem role="package">quilt</systemitem> - this package helps you to
+ The following packages come with the standard Debian installation, so you
- manage a series of patches by keeping track of the changes each of them makes.
+ probably have them already (along with any additional packages they depend on).
- They are logically organized as a stack, and you can apply (=push), un-apply
+ Still, you should check it with <literal>aptitude show
- (=pop), refresh them easily by traveling into the stack.  (see <citerefentry>
+ <replaceable>package</replaceable></literal>
- <refentrytitle>quilt</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>,
+ or with <literal>dpkg -s <replaceable>package</replaceable></literal>.
- <ulink url="&quilt-pdf;">quilt.pdf</ulink>)
  </para>
- </listitem>
- <listitem>
  <para>
- <systemitem role="package">git</systemitem> - this package provides popular
+ The most important package to install on your development system is the
- version control system designed to handle very large projects with speed and
+ <systemitem role="package">build-essential</systemitem> package.  Once you try
- efficiency; it is used for many high profile open source projects, most notably
+ to install that, it will <emphasis>pull in</emphasis> other packages required to
- the Linux kernel.  (see <citerefentry> <refentrytitle>git</refentrytitle>
+ have a basic build environment.
- <manvolnum>1</manvolnum> </citerefentry>,
- <ulink url="&git-doc;">git Manual</ulink>)
  </para>
- </listitem>
- </itemizedlist>
  <para>
- The following is the <emphasis>very important</emphasis> documentation which
+ For some types of packages, that is all you will require; however, there is
- you should read along with this document:
+ another set of packages that while not essential for all package builds are
+ useful to have installed or may be required by your package:
  </para>
  <itemizedlist>
  <listitem>
  <para>
- <systemitem role="package">debian-policy</systemitem> - the <ulink url="&debian-policy;">Debian Policy
+ <systemitem role="package">autoconf</systemitem>, <systemitem
- Manual</ulink> includes explanations of the structure and contents of the
+ role="package">automake</systemitem>, and <systemitem
- Debian archive, several OS design issues, the Filesystem Hierarchy Standard
+ role="package">autotools-dev</systemitem> - many newer programs use configure
- (which says where each file and directory should be) etc.  For you, the most
+ scripts and <filename>Makefile</filename> files preprocessed with the help of
- important thing is that it describes requirements that each package must
+ programs like these (see <literal>info autoconf</literal>, <literal>info
- satisfy to be included in the distribution (see the local copy of
+ automake</literal>).  <systemitem role="package">autotools-dev</systemitem>
- <ulink url="&policy-pdf;">policy.pdf</ulink>).
+ keeps up-to-date versions of certain auto files and has documentation about the
+ best way to use those files.
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">developers-reference</systemitem> - the <ulink url="&developers-reference;">Debian Developer's
+ <systemitem role="package">debhelper</systemitem> and
- Reference</ulink> describes all matters not specifically about the technical
+ <systemitem role="package">dh-make</systemitem> -
- details of packaging, like the structure of the archive, how to rename, orphan,
+ <systemitem role="package">dh-make</systemitem> is necessary to create
- pick up packages, how to do NMUs, how to manage bugs, best packaging practices,
+ the skeleton of our example package, and it will use some of the
- when and where to upload etc.  (see the local copy of
+ <systemitem role="package">debhelper</systemitem> tools for creating
- <ulink url="&developers-refpdf;">developers-reference.pdf</ulink>).
+ packages.  They are not essential for this purpose, but are
+ <emphasis>highly</emphasis> recommended for new maintainers.  It makes
+ the whole process very much easier to start, and to control afterwards.
+ (See <citerefentry> <refentrytitle>dh_make</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry>, <citerefentry>
+ <refentrytitle>debhelper</refentrytitle> <manvolnum>1</manvolnum>
+ </citerefentry>.) <footnote><para> There are also some more specialized
+ but similar packages such as
+ <systemitem role="package">dh-make-perl</systemitem>,
+ <systemitem role="package">dh-make-php</systemitem>, etc.  </para>
+ </footnote>
  </para>
  </listitem>
  <listitem>
  <para>
- <ulink url="&autotools-tutorial;">Autotools
+ <systemitem role="package">devscripts</systemitem> - this package contains some
- Tutorial</ulink> provides very good tutorial for <ulink url="&gnu-build-system;">the GNU Build System known
+ useful scripts that can be helpful for maintainers, but they are also
- as the GNU Autotools</ulink> whose most important components are Autoconf,
+ not necessary for building packages.  Packages recommended and suggested
- Automake, Libtool, and gettext.
+ by this package are worth looking into.  (See <ulink url="&devscripts-readme;"/>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">gnu-standards</systemitem> - this package contains
+ <systemitem role="package">fakeroot</systemitem> - this utility lets you
- two pieces of documentation from the GNU project:
+ emulate being root which is necessary for some parts of the build process.
- <ulink url="&gnu-standard;">GNU Coding Standards</ulink>, and
+ (See <citerefentry> <refentrytitle>fakeroot</refentrytitle>
- <ulink url="&gnu-maintainer;">Information for Maintainers of GNU Software</ulink>.
+ <manvolnum>1</manvolnum> </citerefentry>.)
- Although Debian does not require these to
- be followed, these are still helpful as guidelines and common sense.  (see the local copies of
- <ulink url="&gnu-standard-pdf;">standards.pdf</ulink> and
- <ulink url="&gnu-maintainer-pdf;">maintain.pdf</ulink>).
  </para>
  </listitem>
- </itemizedlist>
- <para>
- If this document contradicts with any of the documents mentioned above, they
- are correct.  Please file a bug report on the
- <systemitem role="package">maint-guide</systemitem> package using
- <command>reportbug</command>.
- </para>
- <para>
- The short descriptions that are given above only serve to introduce you to what
- each package does.  Before continuing please thoroughly read the documentation
- of each program, at least, for the standard usage.  It may seem like heavy
- going now, but later on you'll be <emphasis>very</emphasis> glad you read it.
- </para>
- </section>
- <section id="terminology"><title>Basic terminology</title>
- <para>
- There are two types of packages.
- </para>
- <itemizedlist>
  <listitem>
  <para>
- <emphasis role="strong">source package</emphasis>: A source package is a set of
+ <systemitem role="package">file</systemitem> - this handy program can determine
- files which contain code and data which you can compile and process into
+ what type a file is.  (See <citerefentry> <refentrytitle>file</refentrytitle>
- execution programs and formatted documents.  It usually comes as a combination
+ <manvolnum>1</manvolnum> </citerefentry>.)
- of <filename>*.orig.tar.gz</filename>, <filename>*.debian.tar.gz</filename> (or
- <filename>*.diff.gz</filename>), and <filename>*.dsc</filename>.  Some other
- archive and compression methods may be used, too.
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">binary package</emphasis>: A binary package contains
+ <systemitem role="package">gfortran</systemitem> - the GNU Fortran 95 compiler,
- execution programs and formatted documents.  It usually comes as
+ necessary if your program is written in Fortran.  (See <citerefentry>
- <filename>*.deb</filename> for the normal Debian system and as
+ <refentrytitle>gfortran</refentrytitle> <manvolnum>1</manvolnum>
- <filename>*.udeb</filename> for the Debian Installer.
+ </citerefentry>.)
  </para>
  </listitem>
- </itemizedlist>
- <para>
- Don't mix terms like source of the program and the source package of the
- program!
- </para>
- <para>
- There are several role names used around Debian.
- </para>
- <itemizedlist>
  <listitem>
  <para>
- <emphasis role="strong">upstream author</emphasis>: The person who made the
+ <systemitem role="package">git</systemitem> - this package provides a popular
- original program.
+ version control system designed to handle very large projects with speed and
+ efficiency; it is used for many high profile open source projects, most notably
+ the Linux kernel.  (See <citerefentry> <refentrytitle>git</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry>,
+ <ulink url="&git-doc;">git Manual</ulink>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">upstream maintainer</emphasis>: The person who
+ <systemitem role="package">gnupg</systemitem> - a tool that enables you to
- currently maintains the program.
+ digitally <emphasis>sign</emphasis> packages.  This is especially important if
+ you want to distribute it to other people, and you will certainly be doing that
+ when your work gets included in the Debian distribution.  (See <citerefentry>
+ <refentrytitle>gpg</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">maintainer</emphasis>: The person who makes Debian
+ <systemitem role="package">gpc</systemitem> - the GNU Pascal compiler,
- package of the program.
+ necessary if your program is written in Pascal.  Worthy of note here is
+ <systemitem role="package">fp-compiler</systemitem>, the Free Pascal Compiler,
+ which is also good at this task.  (See <citerefentry>
+ <refentrytitle>gpc</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>,
+ <citerefentry> <refentrytitle>ppc386</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">sponsor</emphasis>: The person who helps maintainers to
+ <systemitem role="package">lintian</systemitem> - this is the Debian package
- upload packages to the official Debian Package Archive after checking their
+ checker, which can let you know of any common mistakes after you build the
- contents.
+ package, and explains the errors found.  (See <citerefentry>
+ <refentrytitle>lintian</refentrytitle> <manvolnum>1</manvolnum>
+ </citerefentry>,
+ <ulink url="&lintian-doc;">Lintian User's Manual</ulink>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">mentor</emphasis>: The person who helps novice
+ <systemitem role="package">patch</systemitem> - this very useful utility will
- maintainers on packaging etc.
+ take a file containing a difference listing (produced by the
+ <command>diff</command> program) and apply it to the original file, producing a
+ patched version.  (See <citerefentry> <refentrytitle>patch</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">Debian Developer</emphasis> (DD): The person who is a
+ <systemitem role="package">patchutils</systemitem> - this package contains some
- member of Debian.  He has full upload right to the official Debian Package
+ utilities to work with patches such as the <command>lsdiff</command>,
- Archive.
+ <command>interdiff</command> and <command>filterdiff</command> commands.
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">Debian Maintainer</emphasis> (DM): The person who has
+ <systemitem role="package">pbuilder</systemitem> - this package contains
- limited upload right to the official Debian Package Archive.
+ programs which are used for creating and maintaining <command>chroot</command>
+ environment.  Building Debian package in this <command>chroot</command>
+ environment verifies the proper build dependency and avoid FTBFS (Fails To
+ Build From Source) bugs.  (see <citerefentry>
+ <refentrytitle>pbuilder</refentrytitle> <manvolnum>8</manvolnum>
+ </citerefentry> and <citerefentry> <refentrytitle>pdebuild</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry>)
  </para>
  </listitem>
- </itemizedlist>
- <para>
- There are several version names<footnote><para>see <ulink url="&policy-control;#s-f-Version">Debian Policy  Manual: 5.6.12 Version</ulink>.</para></footnote> used around Debian.
- </para>
- <itemizedlist>
  <listitem>
  <para>
- <emphasis role="strong">upstream source version</emphasis>: The upstream source
+ <systemitem role="package">perl</systemitem> - Perl is one of the most used
- version is referred as <literal><replaceable>version</replaceable></literal>.
+ interpreted scripting languages on today's Unix-like systems, often referred to
+ as Unix's Swiss Army Chainsaw. (See <citerefentry>
+ <refentrytitle>perl</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">Debian revision</emphasis>: The revision by Debian on
+ <systemitem role="package">python</systemitem> - Python is another of the most
- package is referred as <literal><replaceable>revision</replaceable></literal>.
+ used interpreted scripting languages on the Debian system, combining
+ remarkable power with very clear syntax. (See <citerefentry>
+ <refentrytitle>python</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>.)
  </para>
  </listitem>
  <listitem>
  <para>
- <emphasis role="strong">Debian package version</emphasis>: The Debian package
+ <systemitem role="package">quilt</systemitem> - this package helps you to
- version is referred as the following.
+ manage large numbers of patches by keeping track of the changes each patch
- </para>
+ makes. Patches can be applied, un-applied, refreshed, and more.  (See
- <itemizedlist>
+ <citerefentry> <refentrytitle>quilt</refentrytitle> <manvolnum>1</manvolnum></citerefentry>,
- <listitem>
+ <ulink url="&quilt-pdf;">quilt.pdf</ulink>.)
- <para>
- <literal><replaceable>version</replaceable></literal> for the native Debian
- binary package and for the Debian source package.
  </para>
  </listitem>
  <listitem>
  <para>
- <literal><replaceable>version</replaceable>-<replaceable>revision</replaceable></literal>
+ <systemitem role="package">xutils-dev</systemitem> - some programs, usually
- for the non-native Debian binary package.
+ those made for X11, also use these programs to generate
+ <filename>Makefile</filename> files from sets of macro functions.  (See
+ <citerefentry> <refentrytitle>imake</refentrytitle> <manvolnum>1</manvolnum>
+ </citerefentry>, <citerefentry> <refentrytitle>xmkmf</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry>.)
  </para>
  </listitem>
  </itemizedlist>
- </listitem>
- </itemizedlist>
  <para>
- Please read the other manuals if you need more details on terminology.
+ The short descriptions that are given above only serve to introduce you to what
- </para>
+ each package does.  Before continuing please thoroughly read the documentation
- </section>
+ of each program including ones installed through the package dependency such as
- <section id="debiandeveloper"><title>Official Debian Developer</title>
+ <command>make</command>, at least, for the standard usage.  It may seem like heavy
- <para>
+ going now, but later on you'll be <emphasis>very</emphasis> glad you read it.
- You can not become an official
- <emphasis role="strong">Debian Developer</emphasis> (DD) over night because it
- takes more than technical skill.  Please do not be discouraged by this.  If it
- is useful to others, you can still upload your package either as a
- <emphasis role="strong">maintainer</emphasis> through a
- <emphasis role="strong">sponsor</emphasis> or as a
- <emphasis role="strong">Debian Maintainer</emphasis>.
- </para>
- <para>
- Please make sure to check the latest proper procedure to become an official Debian Developer.
  </para>
- <itemizedlist>
- <listitem><para><ulink url="&nm-do;">Debian New Maintainer site</ulink> (official) </para> </listitem>
- <listitem><para><ulink url="&debianmentorfaq;">Debian Mentors FAQ</ulink> (supplemental) </para> </listitem>
- </itemizedlist>
  <para>
- Please note that you do not need to create any new package to become an
+ If you have specific questions later, I would suggest re-reading the documents
- official Debian Developer.  Contributing to the existing packages can provide a
+ mentioned above.  Since this is a tutorial, I have intentionally skipped
- path to become an official Debian Developer too.  There are many packages
+ details and provided only pointers to keep it simple.
- waiting for good maintainers (see <xref linkend="choose"/> ).
  </para>
  </section>
- <section id="helpme"><title>Where to ask for help</title>
+ <section id="needdocs"><title>Documentation needed for development</title>
  <para>
- Before you decide to ask your question in some public place, please read the fine documentation.
+ The following is the <emphasis>very important</emphasis> documentation which
+ you should read along with this document:
  </para>
  <itemizedlist>
  <listitem>
  <para>
- files in <filename>/usr/share/doc/dpkg</filename>
+ <ulink url="&autotools-tutorial;">Autotools
+ Tutorial</ulink> provides a very good tutorial for <ulink url="&gnu-build-system;">the GNU Build System known
+ as the GNU Autotools</ulink> whose most important components are Autoconf,
+ Automake, Libtool, and gettext.
  </para>
  </listitem>
  <listitem>
  <para>
- files in <filename>/usr/share/doc/debian</filename>
+ <systemitem role="package">debian-policy</systemitem> - the <ulink url="&debian-policy;">Debian Policy
- <!-- /usr/share/doc/debian is used be doc-debian and debian-faq -->
+ Manual</ulink> includes explanations of the structure and contents of the
+ Debian archive, several OS design issues, the <ulink url="&fhs;">Filesystem Hierarchy Standard</ulink>
+ (FHS, which says where each file and directory should be), etc.  For you, the most
+ important thing is that it describes requirements that each package must
+ satisfy to be included in the distribution (see the local copies of
+ <ulink url="&policy-pdf;">policy.pdf</ulink> and <ulink url="&fhs-pdf;">fhs-2.3.pdf</ulink>).
  </para>
  </listitem>
  <listitem>
  <para>
- files in <filename>/usr/share/doc/autotools-dev</filename>
+ <systemitem role="package">developers-reference</systemitem>
+ - the <ulink url="&developers-reference;">Debian Developer's Reference</ulink>
+ describes all matters not specifically about the technical
+ details of packaging, like the structure of the archive, how to rename, orphan,
+ or adopt packages, how to do NMUs, how to manage bugs, best packaging practices,
+ when and where to upload etc.  (See the local copy of
+ <ulink url="&developers-refpdf;">developers-reference.pdf</ulink>.)
  </para>
  </listitem>
  <listitem>
  <para>
- files in <filename>/usr/share/doc/<replaceable>package</replaceable></filename> for all pertinent packages.
+ <systemitem role="package">gnu-standards</systemitem> - this package contains
+ two pieces of documentation from the GNU project:
+ <ulink url="&gnu-standard;">GNU Coding Standards</ulink>, and
+ <ulink url="&gnu-maintainer;">Information for Maintainers of GNU Software</ulink>.
+ Although Debian does not require these to
+ be followed, these are still helpful as guidelines and common sense.
+ (See the local copies of
+ <ulink url="&gnu-standard-pdf;">standards.pdf</ulink> and
+ <ulink url="&gnu-maintainer-pdf;">maintain.pdf</ulink>.)
  </para>
  </listitem>
- <listitem>
+ </itemizedlist>
  <para>
- contents of "<literal><command>man</command> <replaceable>command</replaceable></literal>" for all pertinent commands
+ If this document contradicts any of the documents mentioned above, they
+ are correct.  Please file a bug report on the
+ <systemitem role="package">maint-guide</systemitem> package using
+ <command>reportbug</command>.
  </para>
- </listitem>
+ </section>
+ <section id="helpme"><title>Where to ask for help</title>
+ <para>
+ Before you decide to ask your question in some public place, please read the fine documentation.
+ </para>
+ <itemizedlist>
  <listitem>
  <para>
- contents of "<literal><command>info</command> <replaceable>command</replaceable></literal>" for all pertinent commands
+ files in <filename>/usr/share/doc/<replaceable>package</replaceable></filename> for all pertinent packages
  </para>
  </listitem>
  <listitem>
  <para>
- contents of <ulink url="&nm-do;">Debian New Maintainer site</ulink>
+ contents of <literal><command>man</command> <replaceable>command</replaceable></literal> for all pertinent commands
  </para>
  </listitem>
  <listitem>
  <para>
- contents of <ulink url="&debianmentorfaq;">Debian Mentors FAQ</ulink>
+ contents of <literal><command>info</command> <replaceable>command</replaceable></literal> for all pertinent commands
  </para>
  </listitem>
  <listitem>
-Line 545 
 contents of <ulink url="&debian-devel-ld
+Line 520 
 contents of <ulink url="&debian-devel-ld
  </listitem>
  </itemizedlist>
  <para>
- Please consider to use web search engine effectively by including search string
+ You can use web search engines more effectively by including search strings
- such as "<literal>site:lists.debian.org</literal>" to limit the domain.
+ such as <literal>site:lists.debian.org</literal> to limit the domain.
  </para>
  <para>
- Making a small test package is good way to learn details of packaging.
+ Making a small test package is a good way to learn details of packaging.
  Inspecting existing well maintained packages is the best way to learn how other
  people make packages.
  </para>
-Line 575 
 in the available documentation and web r
+Line 550 
 in the available documentation and web r
  </listitem>
  </itemizedlist>
  <para>
- The more experienced Debian developers will gladly help you, but do read at
+ The more experienced Debian developers will gladly help you, if you ask
- least some of the documentation before asking a question!
+ properly after making your required efforts.
  </para>
  <para>
  When you receive a bug report (yes, actual bug reports!), you will know that it
-Line 584 
 is time for you to dig into the
+Line 559 
 is time for you to dig into the
  <ulink url="&bts;">Debian Bug Tracking System</ulink>
  and read the documentation there, to be able to
  deal with the reports efficiently.  I highly recommend reading the
- <ulink url="&devref-bug-handling;">Debian Developer's Reference, 5.8.  'Handling bugs'</ulink>.
+ <ulink url="&devref-bug-handling;">Debian Developer's Reference, 5.8:
+ "Handling bugs"</ulink>.
  </para>
  <para>
  Even if it all worked well, it's time to start praying.  Why?  Because in just
-Line 602 
 documentation</emphasis> for details).
+Line 578 
 documentation</emphasis> for details).
  </chapter>
  <chapter id="first"><title>First steps</title>
  <para>
- Let's try to make your own package (or, better even, adopt an existing one).
+ Let's start by creating a package of your own (or, even better,
+ adopting an existing one).
+ </para>
+ <section id="workflow"><title>Workflow of the Debian package building</title>
+ <para>
+ If you are making a Debian package with an upstream program,
+ typical workflow of the Debian package building involves generating several
+ specifically named files for each step as the following.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>We obtain an upstream program file usually in a compressed tar format.</para>
+   <itemizedlist>
+   <listitem><literal><replaceable>programname</replaceable>-<replaceable>version</replaceable>.tar.gz</literal></listitem>
+   </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ We create a non-native Debian source package in the "3.0 (quilt)" format, which refers to the set of input files for
+ the Debian package building, by adding Debian package modifications to the upstream program under the <filename>debian</filename> directory.
+ </para>
+   <itemizedlist>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>.orig.tar.gz</literal></listitem>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>-<replaceable>revision</replaceable>.debian.tar.gz</literal>
+     <footnote><para>For the older non-native Debian source package in the "1.0" format,
+     <literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>-<replaceable>revision</replaceable>.diff.gz</literal>
+     is used instead. </para></footnote></listitem>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>-<replaceable>revision</replaceable>.dsc</literal></listitem>
+   </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ We build Debian binary packages, which are ordinary installable package files in <literal>.deb</literal> format (or <literal>.udeb</literal> format, used by the Debian Installer), from the Debian source package.
+ </para>
+   <itemizedlist>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>-<replaceable>revision</replaceable>_<replaceable>arch</replaceable>.deb</literal></listitem>
+   </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Please note that the character separating
+ <literal><replaceable>programname</replaceable></literal> and
+ <literal><replaceable>version</replaceable></literal> was changed from
+ <literal>-</literal> (hyphen) to <literal>_</literal> (underscore).
+ </para>
+ <para>
+ If you are making a Debian specific package without an upstream program instead,
+ typical workflow of the Debian package building is simpler.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ We create a native Debian source package in the "3.0 (native)" format using a compressed tar format in which required files under the <filename>debian</filename> directory are also included.
  </para>
+   <itemizedlist>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>.tar.gz</literal></listitem>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>.dsc</literal></listitem>
+   </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>
+ We build Debian binary packages from the native Debian source package.
+ </para>
+   <itemizedlist>
+   <listitem><literal><replaceable>programname</replaceable>_<replaceable>version</replaceable>_<replaceable>arch</replaceable>.deb</literal></listitem>
+   </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Here,
+ <literal><replaceable>programname</replaceable></literal> part of the file name is substituted by the
+ <emphasis role="strong">package name</emphasis>,
+ <literal><replaceable>version</replaceable></literal> part of it is substituted by the
+ <emphasis role="strong">upstream version</emphasis>,
+ <literal><replaceable>revision</replaceable></literal> part of it is substituted by the
+ <emphasis role="strong">Debian revision</emphasis>,
+ <literal><replaceable>arch</replaceable></literal> part of it is substituted by the
+ <emphasis role="strong">package architecture</emphasis>.
+ <footnote><para>
+ The <emphasis role="strong">package name</emphasis>, <emphasis
+ role="strong">upstream version</emphasis>, and <emphasis role="strong">Debian
+ revision</emphasis> must be adjusted to comply with the Debian Policy Manual:
+ <ulink url="&policy-source;">5.6.1 Source</ulink>,
+ <ulink url="&policy-package;">5.6.7 Package</ulink>, and
+ <ulink url="&policy-version;">5.6.12 Version</ulink>.
+ The <emphasis role="strong">package architecture</emphasis> follows the
+ Debian Policy Manual: <ulink url="&policy-architecture;">5.6.8 Architecture</ulink>
+ and is automatically assigned by the package build process.</para></footnote>
+ </para>
+ <para>
+ In the following, each step of this is explained with detailed examples.
+ </para>
+ </section>
  <section id="choose"><title>Choose your program</title>
  <para>
  You have probably chosen the package you want to create.  The first thing you
-Line 615 
 using the following.
+Line 682 
 using the following.
  <para>the <command>aptitude</command> command</para>
  </listitem>
  <listitem>
- <para><ulink url="&packages-do;">Debian packages</ulink> web page</para>
+ <para>the <ulink url="&packages-do;">Debian packages</ulink> web page</para>
  </listitem>
  <listitem>
- <para><ulink url="&packages-qa-do;">Debian Package Tracking System</ulink> web page</para>
+ <para>the <ulink url="&packages-qa-do;">Debian Package Tracking System</ulink> web page</para>
  </listitem>
  </itemizedlist>
  <para>
  If the package already exists, well, install it!  :-) If it happens to be
- <emphasis role="strong">orphaned</emphasis> -- if its maintainer is set to
+ <emphasis role="strong">orphaned</emphasis> (that is, if its
- <ulink url="&qa-do;">Debian QA Group</ulink>, you may be able to pick it up if
+ maintainer is set to <ulink url="&qa-do;">Debian QA Group</ulink>),
- it's still available.  You may also adopt a package for which the corresponding
+ you may be able to pick it up if it's still available.  You may also
- maintainer has filed a Request for Adoption
+ adopt a package whose maintainer has filed a Request for Adoption
- (<emphasis role="strong">RFA</emphasis>).
+ (<emphasis role="strong">RFA</emphasis>).<footnote> <para>See
+ <ulink url="&devref-adopt;">Debian Developer's Reference 5.9.5.
+ "Adopting a package"</ulink>.</para> </footnote>
  </para>
  <para>
- There are several package ownership status resorces.
+ There are several package ownership status resources.
  </para>
  <itemizedlist>
  <listitem>
  <para> <ulink url="&wnpp-do;">Work-Needing and Prospective Packages</ulink> </para>
  </listitem>
  <listitem>
- <para> <ulink url="&wnpp-bts;">Debian Bug report logs: Bugs in package wnpp in unstable</ulink> </para>
+ <para> <ulink url="&wnpp-bts;">Debian Bug report logs: Bugs in pseudo-package <systemitem role="package">wnpp</systemitem> in <literal>unstable</literal></ulink> </para>
  </listitem>
  <listitem>
  <para> <ulink url="&wnpp-dn;">Debian Packages that Need Lovin'</ulink> </para>
  </listitem>
  <listitem>
- <para> <ulink url="&wnpp-debtags;">Browse WNPP bugs based on debtags</ulink> </para>
+ <para> <ulink url="&wnpp-debtags;">Browse <systemitem role="package">wnpp</systemitem> bugs based on debtags</ulink> </para>
  </listitem>
  </itemizedlist>
  <para>
-Line 652 
 for most kinds of programs, and the numb
+Line 721 
 for most kinds of programs, and the numb
  archive is much larger than that of contributors with upload rights.  Thus,
  contributions to packages already in the archive are far more appreciated (and
  more likely to receive sponsorship) by other developers <footnote><para> Having
- said that, there will of course always be new programs that are worthwhile
+ said that, there will of course always be new programs that are worth
- packaging.  </para> </footnote>.  You can do that in various ways.
+ packaging.  </para> </footnote>.  You can contribute in various ways.
  </para>
  <itemizedlist>
  <listitem>
-Line 683 
 If you are able to adopt the package, ge
+Line 752 
 If you are able to adopt the package, ge
  examine them.  This document unfortunately doesn't include comprehensive
  information about adopting packages.  Thankfully you shouldn't have a hard time
  figuring out how the package works since someone has already done the initial
- set up for you.  Keep reading, though, a lot of the advice below will still be
+ setup for you.  Keep reading, though; a lot of the advice below will still be
  applicable for your case.
  </para>
  <para>
-Line 693 
 as follows:
+Line 762 
 as follows:
  <itemizedlist>
  <listitem>
  <para>
- First, you must know that program works, and have tried it for some time to
+ First, you must know that the program works, and have tried it for some time to
  confirm its usefulness.
  </para>
  </listitem>
  <listitem>
  <para>
- You must check if no one else is working on the package already at the
+ You must check that no one else is already working on the package on the
  <ulink url="&wnpp-do;">Work-Needing and Prospective Packages</ulink> site.
  If no one else is working on it, file an ITP (Intent
  To Package) bug report to the <systemitem role="package">wnpp</systemitem>
  pseudo-package using <command>reportbug</command>.  If someone's already on it,
  contact them if you feel you need to.  If not - find another interesting
- program that nobody maintains.
+ program that nobody is maintaining.
  </para>
  </listitem>
  <listitem>
  <para>
- That program <emphasis role="strong">must have a license</emphasis>.
+ The software <emphasis role="strong">must have a license</emphasis>.
  </para>
  <itemizedlist>
  <listitem>
  <para>
- For the <literal>main</literal> section, it <emphasis role="strong">must be
+ For the <literal>main</literal> section, Debian Policy requires it
- compliant to all the Debian Free Software Guidelines</emphasis> (<ulink url="&dfsg;">DFSG</ulink>)
+ <emphasis role="strong">to be fully compliant with the Debian Free Software
- and <emphasis role="strong">that program must not require a package outside of
+ Guidelines</emphasis> (<ulink url="&dfsg;">DFSG</ulink>)
- <literal>main</literal></emphasis> for compilation or execution as required by
+ and <emphasis role="strong">not to require a package outside of
- the Debian Policy.  This is desired case.
+ <literal>main</literal></emphasis> for compilation or execution.  This
+ is the desired case.
  </para>
  </listitem>
  <listitem>
  <para>
- For the <literal>contrib</literal> section, it must be compliant to all the
+ For the <literal>contrib</literal> section, it must comply with the
  DFSG but it may require a package outside of <literal>main</literal> for
  compilation or execution.
  </para>
  </listitem>
  <listitem>
  <para>
- For the <literal>non-free</literal> section, it may not be compliant to some of
+ For the <literal>non-free</literal> section, it may be non-compliant
- the DFSG but it <emphasis role="strong">must be distributable</emphasis>.
+ with the DFSG but it <emphasis role="strong">must be distributable</emphasis>.
  </para>
  </listitem>
  </itemizedlist>
-Line 743 
 and ask for advice.
+Line 813 
 and ask for advice.
  </listitem>
  <listitem>
  <para>
- That program certainly should <emphasis role="strong">not</emphasis> run setuid
+ The program certainly should <emphasis role="strong">not</emphasis> run setuid
- root, or even better - it shouldn't need to be setuid or setgid to anything.
+ root, or even better, it shouldn't need to be setuid or setgid to anything.
  </para>
  </listitem>
  <listitem>
  <para>
- That program should not be a daemon, or something that goes in
+ The program should not be a daemon, or go in an
- <filename>*/sbin</filename> directories, or open a port as root.
+ <filename>*/sbin</filename> directory, or open a port as root.
  </para>
  </listitem>
  <listitem>
  <para>
- That program should result in binary executable form, libraries are harder to
+ The program should be in binary executable form; libraries are harder to handle.
- handle.
  </para>
  </listitem>
  <listitem>
  <para>
- That program should be well documented and its code needs to be understandable
+ The program should be well documented and its code needs to be understandable
  (i.e.  not obfuscated).
  </para>
  </listitem>
  <listitem>
  <para>
- You should contact program's author(s) to check if they agree with packaging it
+ You should contact the program's author(s) to check if they agree with packaging it
- and amicable to Debian.  It is important to be able to consult with author(s)
+ and are amicable to Debian.  It is important to be able to consult with the author(s)
- about the program in case of any program specific problems, so don't try to
+ in case of any problems with the program, so don't try to package
- package unmaintained pieces of software.
+ unmaintained software.
  </para>
  </listitem>
  </itemizedlist>
  <para>
- Of course, these things are just safety measures, and intended to save you from
+ Of course, these are just safety measures, and intended to save you from
- raging users if you do something wrong in some setuid daemon...  When you gain
+ enraging users if you do something wrong in some setuid daemon...  When you gain
- some more experience in packaging, you'll be able to package such packages.
+ more experience in packaging, you'll be able to package such software.
  </para>
  </section>
  <section id="getit"><title>Get the program, and try it out</title>
  <para>
- So the first thing to do is to find and download the original source code.  I
+ So the first thing to do is to find and download the original source code.
- presume that you already have the source file that you picked up at the
+ Presumably you already have the source file that you picked up at the
  author's homepage.  Sources for free Unix programs usually come in
- <command>tar</command>+<command>gzip</command> format with extension
+ <command>tar</command>+<command>gzip</command> format with the extension
- <filename>.tar.gz</filename>, or
+ <filename>.tar.gz</filename>,
- <command>tar</command>+<command>bzip2</command> format with extension
+ <command>tar</command>+<command>bzip2</command> format with the extension
- <filename>.tar.bz2</filename>.  These usually contain the subdirectory called
+ <filename>.tar.bz2</filename>, or
+ <command>tar</command>+<command>xz</command> format with the extension
+ <filename>.tar.xz</filename>.  These usually contain a directory called
  <filename><replaceable>programname</replaceable>-<replaceable>version</replaceable></filename>
- in them and all the sources under it.
+ with all the sources inside.
  </para>
  <para>
- If the latest version of such sources are available through VCS such as Git,
+ If the latest version of the source is available through a VCS such as Git,
- Subversion, or CVS repository, you need to get it with <literal>git
+ Subversion, or CVS, you need to get it with <literal>git
  clone</literal>, <literal>svn co</literal>, or <literal>cvs co</literal> and
- repack it into <command>tar</command>+<command>gzip</command> format by
+ repack it into <command>tar</command>+<command>gzip</command> format yourself
- yourself using the <literal>--exclude-vcs</literal> option.
+ by using the <literal>--exclude-vcs</literal> option.
  </para>
  <para>
  If your program's source comes as some other sort of archive (for instance, the
  filename ends in <filename>.Z</filename> or
  <filename>.zip</filename><footnote><para> You can identify the archive format
  using the <command>file</command> command when the file extension is not
- enough.  </para> </footnote>), unpack it with appropriate tools and repack it,
+ enough.  </para> </footnote>), you should also unpack it with the
- too.
+ appropriate tools and repack it.
  </para>
  <para>
- As an example, I'll use a program called <command>gentoo</command>, an X GTK+
+ As an example, I'll use a program called <command>gentoo</command>, a GTK+
- file manager.<footnote><para> This program is already packaged.
+ file manager.
- <ulink url="&gentoo-package;">Current
+ <footnote><para> This program is already packaged. The
- version</ulink> has changed substantially from the version 0.9.12 in the
+ <ulink url="&gentoo-package;">current version</ulink> uses Autotools as its
- following examples.</para> </footnote>
+ build structure and is substantially different from the following examples,
+ which were based on version 0.9.12.</para>
+ </footnote>
  </para>
  <para>
  Create a subdirectory under your home directory named
  <filename>debian</filename> or <filename>deb</filename> or anything you find
  appropriate (e.g.  just <filename>~/gentoo</filename> would do fine in this
  case).  Place the downloaded archive in it, and extract it (with <literal>tar
- xzf gentoo-0.9.12.tar.gz</literal>).  Make sure there are no errors, even some
+ xzf gentoo-0.9.12.tar.gz</literal>).  Make sure there are no warning
- <emphasis>irrelevant</emphasis> ones, because there will most probably be
+ messages, even <emphasis>irrelevant</emphasis> ones, because other
- problems unpacking on other people's systems, whose unpacking tools may or may
+ people's unpacking tools may or may not ignore these anomalies, so they
- not ignore those anomalies.  On your console screen, you should see the
+ may have problems unpacking them.  Your shell command line may look
- following.
+ something like this:
  </para>
  <screen>
  $ mkdir ~/gentoo ; cd ~/gentoo
-Line 838 
 Now you have another subdirectory, calle
+Line 911 
 Now you have another subdirectory, calle
  Change to that directory and <emphasis>thoroughly</emphasis> read the provided
  documentation.  Usually there are files named <filename>README*</filename>,
  <filename>INSTALL*</filename>, <filename>*.lsm</filename> or
- <filename>*.html</filename>.  You must find instructions on how to correctly
+ <filename>*.html</filename>.  You must find instructions on how to
  compile and install the program (most probably they'll assume you want to
- install to <filename>/usr/local/bin</filename> directory; you won't be doing
+ install to the <filename>/usr/local/bin</filename> directory; you won't be doing
- that, but more on that later in <xref linkend="destdir"/> ).
+ that, but more on that later in <xref linkend="destdir"/>).
  </para>
  <para>
- Simple programs come with a <filename>Makefile</filename> file in them and can
+ You should start packaging with a completely clean (pristine) source directory,
- be compiled simply with <literal>make</literal>.<footnote><para>
+ or simply with freshly unpacked sources.
+ </para>
+ </section>
+ <section id="simplemake"><title>Simple build systems</title>
+ <para>
+ Simple programs come with a <filename>Makefile</filename> and can
+ be compiled just by invoking <literal>make</literal>.<footnote><para>
  Many modern programs come with a script <filename>configure</filename> which
- creates a <filename>Makefile</filename> file customized for your system upon
+ when executed creates a <filename>Makefile</filename> customized for
- its execution.</para></footnote> Some of them support
+ your system.</para></footnote> Some of them support
- <literal>make check</literal>, which runs included self-checks.  Installation
+ <literal>make check</literal>, which runs included self-tests.  Installation
  to the destination directories is usually done with <literal>make
  install</literal>.
  </para>
-Line 864 
 there's even a <literal>make uninstall</
+Line 943 
 there's even a <literal>make uninstall</
  all the installed files.
  </para>
  </section>
- <section id="portable"><title>Free portable programs</title>
+ <section id="portable"><title>Popular portable build systems</title>
  <para>
- A lot of Free programs are written in the <ulink url="&c-program;">C</ulink> and
+ A lot of free software programs are written in the <ulink url="&c-program;">C</ulink> and
- <ulink url="&cxx;">C++</ulink> languages.  Many of
+ <ulink url="&cxx;">C++</ulink> languages.  Many of these use Autotools or
- these use Autotools or CMake to make them portable across different platforms.
+ CMake to make them portable across different platforms.  These build tools need
- These tools are used to generate <filename>Makefile</filename> and other
+ to be used to generate the <filename>Makefile</filename> and other
- required source files.  Then, such programs are built with usual <literal>make;
+ required source files first.  Then, such programs are built using the usual
- make install</literal>.
+ <literal>make; make install</literal>.
  </para>
  <para>
- <ulink url="&gnu-build-system;">Autotools</ulink>
+ <ulink url="&gnu-build-system;">Autotools</ulink> is the GNU build
- are the GNU build system comprising <ulink url="&autoconf;">Autoconf</ulink>, <ulink url="&automake;">Automake</ulink>, <ulink url="&libtool;">Libtool</ulink>, and <ulink url="&gettext;">gettext</ulink>.  You can notice
+ system comprising <ulink url="&autoconf;">Autoconf</ulink>,
+ <ulink url="&automake;">Automake</ulink>,
+ <ulink url="&libtool;">Libtool</ulink>, and
+ <ulink url="&gettext;">gettext</ulink>.  You can recognize
  such sources by the <filename>configure.ac</filename>,
  <filename>Makefile.am</filename>, and <filename>Makefile.in</filename> files.
- <footnote><para> See <ulink url="&autotools-tutorial;">Autotools Tutorial</ulink>
+ <footnote><para>Autotools is too big to deal in this small tutorial. This
- and <ulink url="&autotools-readme;"/>.  </para> </footnote>
+ section is mean to provide keywords and references only.  Please make sure to read the
+ <ulink url="&autotools-tutorial;">Autotools Tutorial</ulink> and
+ <ulink url="&autotools-readme;"/>, if you need to use it.</para></footnote>
  </para>
  <para>
- The first step of Autotools work flow is usually that the upstream runs
+ The first step of the Autotools workflow is usually that upstream runs
- <literal>autoreconf -i -f</literal> in the source and distributes this source
+ <literal>autoreconf -i -f</literal> in the source directory and
- with generated files.
+ distributes the generated files along with the source.
  </para>
  <screen>
  configure.ac-----+-&gt; autoreconf -+-&gt; configure
-Line 903 
 files requires some knowledge of <comman
+Line 987 
 files requires some knowledge of <comman
  <literal>info automake</literal>.
  </para>
  <para>
- The second step of Autotools work flow is usually that the user obtains this
+ The second step of the Autotools workflow is usually that the user obtains this
  distributed source and runs <literal>./configure &amp;&amp; make</literal> in
- the source to compile program into a
+ the source directory to compile the program into a
  <command><replaceable>binary</replaceable></command>.
  </para>
  <screen>
-Line 917 
 config.h.in -----+                +-&gt;
+Line 1001 
 config.h.in -----+                +-&gt;
             config.guess --+
  </screen>
  <para>
- You can change many things in the <filename>Makefile</filename> file such as
+ You can change many things in the <filename>Makefile</filename>; for
- the default file install location using the command option, e.g.
+ instance you can change the default location for file installation
- <command>./configure --prefix=/usr</command>.
+ using the option <command>./configure --prefix=/usr</command>.
  </para>
  <para>
  Although it is not required, updating the <filename>configure</filename> and
- other files with <literal>autoreconf -i -f</literal> as the user may improve
+ other files with <literal>autoreconf -i -f</literal> may improve
  the compatibility of the source.
+ <footnote><para>You can automate this by using
+ <systemitem role="package">dh-autoreconf</systemitem> package.
+ See <xref linkend="customrules"/>.</para></footnote>
  </para>
  <para>
  <ulink url="&cmake;">CMake</ulink> is an alternative
- build system.  You can notice such sources by the
+ build system.  You can recognize such sources by the
  <filename>CMakeLists.txt</filename> file.
  </para>
  </section>
  <section id="namever"><title>Package name and version</title>
  <para>
- You should start packaging with a completely clean (pristine) source directory,
+ If the upstream source comes as <filename>gentoo-0.9.12.tar.gz</filename>, you can
- or simply with freshly unpacked sources.
+ consider
+ <emphasis role="strong">package name</emphasis> to be <literal>gentoo</literal> and
+ <emphasis role="strong">upstream version</emphasis> to be <literal>0.9.12</literal>.
+ These are used in the <filename>debian/changelog</filename> file described later in
+ <xref linkend="changelog"/>, too.
+ </para>
+ <para>
+ Although this simple approach works most of the times, you may need to adjust
+ <emphasis role="strong">package name</emphasis> and
+ <emphasis role="strong">upstream version</emphasis> by renaming the upstream
+ source to follow the Debian policy and the existing convention.
+ </para>
+ <para>
+ You must choose the <emphasis role="strong">package name</emphasis>
+ to consist only of lower case letters (<literal>a-z</literal>), digits
+ (<literal>0-9</literal>), plus (<literal>+</literal>) and minus
+ (<literal>-</literal>) signs, and periods (<literal>.</literal>). It must be
+ at least two characters long, must start with an alphanumeric character, and
+ must not be the same as existing ones.
+ It is good idea to keep its length within 30 characters and should not exceed
+characters.
  </para>
+ <!--
+ Osamu's archive stat (2011-04-23, sid, kfreebsd-amd64):
+ === stat for package name string length ===
+1947 36.9%   mode
+1717 54.7%  50% median
+611 91.0%   90%
+89 99.0%    99%
+12 99.9%    99.9%
+1 100.0%
+ Previous 20 chars is becoming too short for 17% of packages
+ Default aptitude setting display up to 30 chars (98.3%).
+ -->
  <para>
- For the package to be built correctly, you must make the program's original
+ If upstream source uses generic words such as <literal>test-suite</literal> as
- name lowercase (if it isn't already), and you should move the source directory
+ its name, it is good idea to rename it not to contaminate name space for the
- to
+ package name and to identify its contents explicitly.
- <filename><replaceable>packagename</replaceable>-<replaceable>version</replaceable></filename>.
+ <footnote><para>If you follow the
- </para>
+ <ulink url="&devref-newpackage;">Developer's Reference 5.1. 'New packages'</ulink>,
- <para>
+ the ITP process will usually catch this kind of issues.</para></footnote>.
- If the program name consists of more than one word, contract them to one word,
- or make an abbreviation.  For example, program John's little editor for X
- package would be named <systemitem role="package">johnledx</systemitem>, or
- <systemitem role="package">jle4x</systemitem>, or whatever you decide, as long
- as it's under some reasonable limit, e.g.  20 characters.
- </para>
- <para>
- Also check for the exact version of the program (to be included in the package
- version).  If that piece of software is not numbered with versions like
- <literal>X.Y.Z</literal>, but with some kind of date, feel free to use that
- date as the version number, as long as newer version numbers will look larger.
- While it is best to use the same version number as what upstream uses, if it is
- in the format of <literal>09Oct23</literal> you may need to convert it to
- <literal>YYYYMMDD</literal> format, which would be <literal>20091023</literal>,
- to ensure proper order for upgrade with the <command>dpkg</command>
- program.<footnote><para> Version string can be compared by <literal>dpkg
- --compare-versions <replaceable>ver1</replaceable>
- <replaceable>op</replaceable> <replaceable>ver2</replaceable></literal>.  See
- <citerefentry> <refentrytitle>dpkg</refentrytitle> <manvolnum>1</manvolnum>
- </citerefentry> manpage.  </para> </footnote>
  </para>
  <para>
- Some programs won't be numbered at all, in which case you should contact the
+ You should choose the <emphasis role="strong">upstream version</emphasis>
- upstream maintainer to see if they've got some other revision-tracking method.
+ to consist only of
+ alphanumerics (<literal>0-9A-Za-z</literal>), plus (<literal>+</literal>),
+ tilde (<literal>~</literal>), and periods (<literal>.</literal>). It must
+ start with a digit (<literal>0-9</literal>).  <footnote><para>This stricter
+ rule should help you avoid confusing file names.</para></footnote>
+ It is good idea to keep its length within 8 characters if possible.
+ </para>
+ <!--
+ Osamu's archive stat (2011-04-23, sid, kfreebsd-amd64):
+ === stat for upstream version string length ===
+9765 60.2%  50% median and mode
+3765 73.3%
+2789 82.9%
+1158 86.9%
+501 88.6%
+773 91.3%  90%
+55 99.1%   99%
+11 99.9%    99.9
+6 100.0%
+ === stat for debian revision string length ===
+22556 83.3%  50% median and mode
+1106 87.2%
+1312 91.7%   90%
+2127 99.1%   99%
+14 99.9%     99.9%
+ aptitude display 10 = 8char for up + 1char (for -) + 1char for deb
+chars as max for file name of binary debs (package+up+deb+arch+.deb)
+ -->
+ <para>
+ If the upstream software does not use normal version system like
+ <literal>2.30.32</literal> but uses some kind of date such as
+ <literal>09Oct23</literal>, a random codename string or a VCS hush value as a part
+ of version, make sure to remove them from the
+ <emphasis role="strong">upstream version</emphasis>.  Such information can be
+ recorded in the <filename>debian/changelog</filename> file.  If you need to
+ invent a version string, use the <literal>YYYYMMDD</literal> format such as
+ <literal>20110429</literal> as upstream version.  This ensures that
+ <command>dpkg</command> properly sees later versions as upgrades.
+ </para>
+ <para>
+ Version strings can be compared with <citerefentry> <refentrytitle>dpkg</refentrytitle> <manvolnum>1</manvolnum> </citerefentry> as the following.
+ </para>
+ <screen>
+  $ dpkg --compare-versions <replaceable>ver1</replaceable> <replaceable>op</replaceable> <replaceable>ver2</replaceable>
+ </screen>
+ <para>
+ The version comparison rule can be summarized as the folowing.
+ </para>
+ <itemizedlist>
+ <listitem><para>The strings are compared from the head to the tail.</para></listitem>
+ <listitem><para>Alphabets are larger than numbers.</para></listitem>
+ <listitem><para>Numbers are compared as the integer.</para></listitem>
+ <listitem><para>Alphabets are compared in the ASCII code order.</para></listitem>
+ <listitem><para>There are some special rules for periods (<literal>.</literal>), plus (<literal>+</literal>) and tilde (<literal>~</literal>) as the followings.</para>
+   <para>
+   <literal>0.0</literal> &lt;
+   <literal>0.5</literal> &lt;
+   <literal>0.10</literal> &lt;
+   <literal>0.99</literal> &lt;
+   <literal>1</literal> &lt;
+   <literal>1.0~rc1</literal> &lt;
+   <literal>1.0</literal> &lt;
+   <literal>1.0+b1</literal> &lt;
+   <literal>1.0+nmu1</literal> &lt;
+   <literal>1.1</literal> &lt;
+   <literal>2.0</literal>
+   </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ One of the tricky case happens when the upstream releases
+ <filename>gentoo-0.9.12-ReleaseCandidate-99.tar.gz</filename> as the
+ pre-release of <filename>gentoo-0.9.12.tar.gz</filename>.  You need to make
+ sure that the upgrade works properly by renaming the upstream source to
+ <filename>gentoo-0.9.12~rc99.tar.gz</filename>.
  </para>
  </section>
  <section id="dh-make"><title>Initial Debian package</title>
  <para>
- Let's set up the shell environment variable <literal>$DEBEMAIL</literal> and
+ Set up the shell environment variables <literal>$DEBEMAIL</literal> and
- <literal>$DEBFULLNAME</literal> so many Debian maintenance tools recognize your
+ <literal>$DEBFULLNAME</literal> so that various Debian maintenance
- name and email address to use for packages as follows.<footnote><para> The
+ tools recognize your email address and name to use for packages. <footnote><para> The
  following text assumes you are using Bash as your login shell.  If you use
- other login shells such as Z shell, use their pertinent configuration files
+ some other login shell such as Z shell, use their corresponding
- instead of <filename>~/.bashrc</filename>.  </para> </footnote>.
+ configuration files instead of <filename>~/.bashrc</filename>. </para> </footnote>
  </para>
  <screen>
  $ cat &gt;&gt;~/.bashrc &lt;&lt;EOF
-Line 987 
 export DEBEMAIL DEBFULLNAME
+Line 1161 
 export DEBEMAIL DEBFULLNAME
  EOF
  </screen>
  <para>
- Let's make an initial Debian package by issuing the <command>dh_make</command>
+ You can create an initial Debian package by issuing the
- command as follows.
+ <command>dh_make</command> command as follows.
  </para>
  <screen>
  $ . ~/.bashrc
-Line 999 
 $ dh_make -f ../gentoo-0.9.12.tar.gz
+Line 1173 
 $ dh_make -f ../gentoo-0.9.12.tar.gz
  Of course, replace the filename with the name of your original source archive.
  <footnote><para> If the upstream source provides the
  <filename>debian</filename> directory and its contents, run the
- <command>dh_make</command> command with the <literal>--addmissing</literal>
+ <command>dh_make</command> command with the extra option
- option, instead.  The new source <literal>3.0 (quilt)</literal> format is quite
+ <literal>--addmissing</literal>.  The new source <literal>3.0 (quilt)</literal> format is
- robust not to break even for these packages.  You may need to update contents
+ robust enough not to break even for these packages.  You may need to update the contents
  provided by the upstream for your Debian package.  </para> </footnote> See
  <citerefentry> <refentrytitle>dh_make</refentrytitle> <manvolnum>1</manvolnum>
  </citerefentry> for details.
  </para>
  <para>
- Some information will come up.  It will ask you what sort of package you want
+ You should see some output asking you what sort of package you want
  to create.  Gentoo is a single binary package - it creates only one binary, and
- thus one <filename>.deb</filename> file - so we will select the first option,
+ thus one <filename>.deb</filename> file - so we will select the first option
- with the <literal>s</literal> key, check the information on the screen and
+ (with the <literal>s</literal> key), check the information on the screen, and
  confirm by pressing <literal><replaceable>ENTER</replaceable></literal>.
- <footnote><para> There are few choices here: <literal>s</literal> for Single
+ <footnote><para> There are several choices here: <literal>s</literal> for Single
- binary, <literal>i</literal> for Arch-Independent, <literal>m</literal> for
+ binary, <literal>i</literal> for arch-Independent, <literal>m</literal> for
  Multiple binary, <literal>l</literal> for Library, <literal>k</literal> for
- Kernel module, <literal>n</literal> for Kernel patch and <literal>b</literal>
+ Kernel module, <literal>n</literal> for kernel patch, and <literal>b</literal>
  for <systemitem role="package">cdbs</systemitem>.  This document focuses on the
- use of the <systemitem role="package">debhelper</systemitem> package with the
+ use of the <command>dh</command> command (from the package
- <command>dh</command> command.  This document focuses on the use of the new
+ <systemitem role="package">debhelper</systemitem>) to create a single-binary package,
- <command>dh</command> command for Single binary and touches on it for
+ but also touches on how to use it for arch-independent or
- Arch-Independent and Multiple binary.  The <systemitem role="package">cdbs</systemitem> package offers alternative package script
+ multiple-binary packages.  The package
- infrastructure to the <command>dh</command> command and outside of the scope of
+ <systemitem role="package">cdbs</systemitem> offers an alternative packaging script
+ infrastructure to the <command>dh</command> command and is outside the scope of
  this document.  </para> </footnote>
  </para>
  <para>
- After this execution of <command>dh_make</command>, a copy of the upstream
+ This execution of <command>dh_make</command> creates a copy of the upstream
- tarball is created as <filename>gentoo_0.9.12.orig.tar.gz</filename> in the
+ tarball as <filename>gentoo_0.9.12.orig.tar.gz</filename> in the
  parent directory to accommodate the creation of the non-native Debian source
- package with the <filename>debian.tar.gz</filename> later.
+ package with the name <filename>debian.tar.gz</filename> later.
  </para>
  <screen>
  $ cd ~/gentoo ; ls -F
-Line 1037 
 gentoo-0.9.12.tar.gz
+Line 1212 
 gentoo-0.9.12.tar.gz
  gentoo_0.9.12.orig.tar.gz
  </screen>
  <para>
- Please note 2 key features in this
+ Please note two key features of this filename
- <filename>gentoo_0.9.12.orig.tar.gz</filename> file name:
+ <filename>gentoo_0.9.12.orig.tar.gz</filename>:
  </para>
  <itemizedlist>
  <listitem>
  <para>
- Package name and version are separated by the <literal>_</literal>
+ Package name and version are separated by the character <literal>_</literal>
  (underscore).
  </para>
  </listitem>
  <listitem>
  <para>
- There is the <filename>.orig</filename> before the
+ The string <filename>.orig</filename> is inserted before the
  <filename>.tar.gz</filename>.
  </para>
  </listitem>
  </itemizedlist>
  <para>
  You should also notice that many template files are created in the source under
- the <filename>debian</filename> directory.  These will be explained in <xref linkend="dreq"/> and <xref linkend="dother"/> .  You should also understand
+ the <filename>debian</filename> directory.  These will be explained in
- that the packaging is not automatic process.  You need to modify the upstream
+ <xref linkend="dreq"/> and <xref linkend="dother"/>.  You should also understand
- source for Debian as <xref linkend="modify"/> .  After all these, you need to
+ that packaging cannot be a fully automated process.  You will need to modify the upstream
- build Debian packages under the proper method as <xref linkend="build"/> ,
+ source for Debian (see <xref linkend="modify"/>).  After this, you need to
- check them as <xref linkend="checkit"/> , and upload them as <xref linkend="upload"/> .  I will explain all these steps.
+ use the proper methods for building Debian packages (<xref linkend="build"/>),
+ testing them (<xref linkend="checkit"/>), and uploading them (<xref linkend="upload"/>).
+ All the steps will be explained.
  </para>
  <para>
  Once again, as a new maintainer you are discouraged from creating complicated
- packages, e.g.,
+ packages, e.g.:
  </para>
  <itemizedlist>
  <listitem>
  <para>
- multiple binary packages,
+ multiple binary packages;
  </para>
  </listitem>
  <listitem>
  <para>
- library packages,
+ library packages;
  </para>
  </listitem>
  <listitem>
  <para>
- kernel module packages,
+ kernel module packages;
  </para>
  </listitem>
  <listitem>
  <para>
- kernel patch packages,
+ kernel patch packages;
  </para>
  </listitem>
  <listitem>
  <para>
- the source file format being neither in <filename>tar.gz</filename> nor
+ packages with the source in a format other than <filename>tar.gz</filename> or
- <filename>tar.bz2</filename>, or
+ <filename>tar.bz2</filename>; or
  </para>
  </listitem>
  <listitem>
  <para>
- the source tarball containing undistributable contents.
+ packages where the source tarball contains undistributable contents.
  </para>
  </listitem>
  </itemizedlist>
  <para>
- It's not too hard, but it does require a bit more knowledge, so we won't
+ Doing so is not too hard, but it requires a bit more knowledge, so we won't
  describe all of it here.
  </para>
  <para>
-Line 1110 
 recover them by running <command>dh_make
+Line 1287 
 recover them by running <command>dh_make
  </para>
  <para>
  Updating an existing package may get complicated since it may be using older
- techniques.  Please stick with fresh packaging cases for now to learn basics.
+ techniques.  While learning the basics, please stick to creating a fresh
- I will come back to explain it later in <xref linkend="update"/> .
+ package; further explanations are given in <xref linkend="update"/>.
  </para>
  </section>
  </chapter>
-Line 1121 
 Please note that there isn't space here
+Line 1298 
 Please note that there isn't space here
  details of fixing upstream sources, but here are some basic steps and problems
  people often run across.
  </para>
- <section id="quiltrc"><title>Set up <command>quilt</command></title>
+ <section id="quiltrc"><title>Setting up <command>quilt</command></title>
  <para>
- The <command>quilt</command> program offers the basic method to record
+ The program <command>quilt</command> offers a basic method for recording
- modification to the source for the Debian packaging.  Since slightly different
+ modifications to the upstream source for Debian packaging.  It's
- default is desirable for Debian packaging, let's set up
+ useful to have a slightly customized default, so let's create an alias
- <filename>~/.quiltrc</filename> as follows.  <footnote><para> You can disable
+ <command>dquilt</command> for Debian packaging by adding the following
- this configuration by starting the <command>quilt</command> command as
+ line to <filename>~/.bashrc</filename>.
- <literal>quilt --quiltrc /dev/null ...</literal>.  </para> </footnote>
+ </para>
+ <screen>
+ alias dquilt="quilt --quiltrc=~/.quiltrc-dpkg"
+ </screen>
+ <para>
+ Then let's create <filename>~/.quiltrc-dpkg</filename> as follows.
  </para>
  <screen>
  d=. ; while [ ! -d $d/debian -a `readlink -e $d` != / ]; do d=$d/..; done
  if [ -d $d/debian ] &amp;&amp; [ -z $QUILT_PATCHES ]; then
-     # Debian packaging case and unset $QUILT_PATCHES
+     # if in Debian packaging tree with unset $QUILT_PATCHES
-     QUILT_PATCHES=debian/patches
+     QUILT_PATCHES="debian/patches"
-     QUILT_PATCH_OPTS=--reject-format=unified
+     QUILT_PATCH_OPTS="--reject-format=unified"
-     QUILT_DIFF_ARGS=-p ab --no-timestamps --no-index --color=auto
+     QUILT_DIFF_ARGS="-p ab --no-timestamps --no-index --color=auto"
-     QUILT_REFRESH_ARGS=-p ab --no-timestamps --no-index
+     QUILT_REFRESH_ARGS="-p ab --no-timestamps --no-index"
-     QUILT_COLORS=diff_hdr=1;32:diff_add=1;34:diff_rem=1;31:diff_hunk=1;33:diff_ctx=35:diff_cctx=33
+     QUILT_COLORS="diff_hdr=1;32:diff_add=1;34:diff_rem=1;31:diff_hunk=1;33:diff_ctx=35:diff_cctx=33"
      if ! [ -d $d/debian/patches ]; then mkdir $d/debian/patches; fi
  fi
  </screen>
  <para>
  See <citerefentry> <refentrytitle>quilt</refentrytitle>
  <manvolnum>1</manvolnum> </citerefentry> and
- <ulink url="&quilt-pdf;">quilt.pdf</ulink> for how to use
+ <ulink url="&quilt-pdf;">quilt.pdf</ulink> on how to use
  <command>quilt</command>.
  </para>
  </section>
- <section id="fixupstream"><title>Fixing upstream bug</title>
+ <section id="fixupstream"><title>Fixing upstream bugs</title>
  <para>
  Let's assume you find an error in the upstream <filename>Makefile</filename>
- file as follows where <literal>install: gentoo</literal> should have been
+ as follows where <literal>install: gentoo</literal> should have been
  <literal>install: gentoo-target</literal>.
  </para>
  <screen>
-Line 1162 
 install: gentoo
+Line 1344 
 install: gentoo
          install gentoorc-example $(HOME)/.gentoorc
  </screen>
  <para>
- Let's fix this and record this with the <command>quilt</command> command as
+ Let's fix this and record it with the <command>dquilt</command> command as
  <filename>fix-gentoo-target.patch</filename>.  <footnote><para> The
- <filename>debian/patches</filename> directory should exist now if you run
+ <filename>debian/patches</filename> directory should exist now if you ran
  <command>dh_make</command> as described before.  This example operation creates
- it just in case you are updating the existing package.  </para> </footnote>
+ it just in case you are updating an existing package.  </para> </footnote>
  </para>
  <screen>
  $ mkdir debian/patches
- $ quilt new fix-gentoo-target.patch
+ $ dquilt new fix-gentoo-target.patch
- $ quilt add Makefile
+ $ dquilt add Makefile
  </screen>
  <para>
  You change the <filename>Makefile</filename> file as follows.
-Line 1183 
 install: gentoo-target
+Line 1365 
 install: gentoo-target
          install gentoorc-example $(HOME)/.gentoorc
  </screen>
  <para>
- Ask <command>quilt</command> to refresh the patch to create
+ Ask <command>dquilt</command> to generate the patch to create
  <filename>debian/patches/fix-gentoo-target.patch</filename> and add its
  description following <ulink url="&dep3;">DEP-3: Patch Tagging Guidelines</ulink>.
  </para>
  <screen>
- $ quilt refresh
+ $ dquilt refresh
- $ quilt header -e
+ $ dquilt header -e
  ... describe patch
  </screen>
  </section>
+ <section id="destdir"><title>Installation of files to their destination</title>
- <section id="destdir"><title>Installation of files to the destination</title>
  <para>
- Normally, programs install themselves in the <filename>/usr/local</filename>
+ Most third-party software installs itself in the <filename>/usr/local</filename>
- subdirectory.  Since it is reserved for system administrator's (or user's)
+ directory hierarchy.  On Debian this is reserved for private use
- private use, Debian packages must not use that directory but should use system
+ by the system administrator, so packages must not use directories such
- directories such as the <filename>/usr/bin</filename> subdirectory following
+ as <filename>/usr/local/bin</filename> but should instead use system
- the Filesystem Hierarchy Standard (<ulink url="&fhs;">FHS</ulink>,
+ directories such as <filename>/usr/bin</filename>, obeying the
- <ulink url="&fhs-pdf;">fhs-2.3.pdf</ulink>).
+ <ulink url="&fhs;">Filesystem Hierarchy Standard</ulink> (FHS).
  </para>
  <para>
  Normally, <citerefentry> <refentrytitle>make</refentrytitle>
  <manvolnum>1</manvolnum> </citerefentry> is used to automate building the
- program and the execution of <literal>make install</literal> installs programs
+ program, and executing <literal>make install</literal> installs programs
- directly to the desired destination by the <literal>install</literal> target of
+ directly to the desired destination (following the
- the <filename>Makefile</filename> file.  In order for Debian to provide binary
+ <literal>install</literal> target in the
- packages, the build system installs programs to the file tree image created
+ <filename>Makefile</filename>).  In order for Debian to provide
- under a temporary directory instead to the actual destination.
+ pre-built installable packages, it modifies the build system to install
+ programs into a file tree image created under a temporary directory
+ instead of the actual destination.
  </para>
  <para>
- These 2 differences between (1) the normal program installation and (2) the
+ These two differences between normal program installation on one hand and the
- Debian packaging can be transparently addressed by the <systemitem role="package">debhelper</systemitem> package through the
+ Debian packaging system on the other can be transparently addressed by the
+ <systemitem role="package">debhelper</systemitem> package through the
  <command>dh_auto_configure</command> and <command>dh_auto_install</command>
  commands if the following conditions are met.
  </para>
  <itemizedlist>
  <listitem>
  <para>
- The <filename>Makefile</filename> file follows the GNU conventions to support
+ The <filename>Makefile</filename> must follow GNU conventions and
- <literal>$(DESTDIR)</literal> variable.
+ support the <literal>$(DESTDIR)</literal> variable.
  <footnote><para> See <ulink url="&gnu-destdir;">GNU Coding Standards: 7.2.4 DESTDIR: Support for Staged Installs</ulink>.</para></footnote>
  </para>
  </listitem>
  <listitem>
  <para>
- The source follows the Filesystem Hierarchy Standard (FHS).
+ The source must follow the Filesystem Hierarchy Standard (FHS).
  </para>
  </listitem>
  </itemizedlist>
  <para>
- Programs that use GNU <command>autoconf</command>
+ Programs that use GNU <command>autoconf</command> follow the GNU conventions
- <emphasis>automatically</emphasis> follow the GNU conventions and their
+ automatically, so they can be trivial to package.  On the basis of
- packaging is almost <emphasis>automatic</emphasis>.  With this and other
+ this and other heuristics, it is estimated that the
- heuristics, the <systemitem role="package">debhelper</systemitem> package
+ <systemitem role="package">debhelper</systemitem> package will work for
- estimates that it works for about 90% of packages without making any intrusive
+ about 90% of packages without making any intrusive changes to their
- changes to their build system.  So the packaging is not as complicated as it
+ build system.  So packaging is not as complicated as it may seem.
- may seem.
  </para>
  <para>
- If you need to make changes in the <filename>Makefile</filename> file, you
+ If you need to make changes in the <filename>Makefile</filename>, you
- should make sure to support these <literal>$(DESTDIR)</literal> variable.  The
+ should be careful to support the <literal>$(DESTDIR)</literal>
- <literal>$(DESTDIR)</literal> variable is unset in it and is prepended to each
+ variable.  Although it is unset by default, the <literal>$(DESTDIR)</literal>
- file path used for the program installation.  The packaging script will set
+ variable is prepended to each file path used for the program
- <literal>$(DESTDIR)</literal> to the temporary directory.
+ installation.  The packaging script will set
+ <literal>$(DESTDIR)</literal> to the temporary directory.
  </para>
  <para>
- The temporary directory used by the <command>dh_auto_install</command> command
+ For packages of the single-binary type, the temporary directory used
- is chosen as <filename>debian/<replaceable>package</replaceable></filename> for
+ by the <command>dh_auto_install</command> command will be set to
- single binary packages.  <footnote><para> For multiple binary packages, the
+ <filename>debian/<replaceable>package</replaceable></filename>.
+ <footnote><para> For packages of the multiple-binary type, the
  <command>dh_auto_install</command> command uses <filename>debian/tmp</filename>
  as the temporary directory while the <command>dh_install</command> command with
  the help of
  <filename>debian/<replaceable>package-1</replaceable>.install</filename> and
  <filename>debian/<replaceable>package-2</replaceable>.install</filename> files
- will split contents of <filename>debian/tmp</filename> into
+ will split the contents of <filename>debian/tmp</filename> into
  <filename>debian/<replaceable>package-1</replaceable></filename> and
  <filename>debian/<replaceable>package-2</replaceable></filename> temporary
- directories to create multiple binary <filename>*.deb</filename> packages.
+ directories, to create
+ <filename><replaceable>package-1</replaceable>_*.deb</filename> and
+ <filename><replaceable>package-2</replaceable>_*.deb</filename> binary
+ packages.
  </para> </footnote> Everything that is contained in the temporary directory
- will be installed on a user's system when they install your package, the only
+ will be installed on users' systems when they install your package; the only
- difference is that <command>dpkg</command> will be installing the files in the
+ difference is that <command>dpkg</command> will be installing the
- root directory.
+ files to paths relative to the root directory rather than your working
+ directory.
  </para>
  <para>
  Bear in mind that even though your program installs in
  <filename>debian/<replaceable>package</replaceable></filename>, it still needs
- to behave correctly when placed in the root directory, i.e.  when installed
+ to behave correctly when installed from the <filename>.deb</filename>
- from the <filename>.deb</filename> package.  So you must not allow the build
+ package under the root directory.  So you must not allow the build
  system to hardcode strings like
  <literal>/home/me/deb/<replaceable>package</replaceable>-<replaceable>version</replaceable>/usr/share/<replaceable>package</replaceable></literal>
- into the package file.
+ into files in the package.
  </para>
  <para>
  Here's the relevant part of <systemitem role="package">gentoo</systemitem>'s
- <filename>Makefile</filename> file <footnote><para> This is just an example to
+ <filename>Makefile</filename><footnote><para> This is just an example to
- show how the <filename>Makefile</filename> file should look like.  If the
+ show what a <filename>Makefile</filename> should look like.  If the
- <filename>Makefile</filename> file is created by the
+ <filename>Makefile</filename> is created by the
  <command>./configure</command> command, the correct way to fix this kind of
- <filename>Makefile</filename> is to executed the <command>./configure</command>
+ <filename>Makefile</filename> is to execute <command>./configure</command>
- command from the <command>dh_auto_configure</command> command with default
+ from the <command>dh_auto_configure</command> command with default
  options including <literal>--prefix=/usr</literal>.  </para> </footnote>:
  </para>
  <screen>
-Line 1293 
 ICONS   = /usr/local/share/gentoo
+Line 1482 
 ICONS   = /usr/local/share/gentoo
  </screen>
  <para>
  We see that the files are set to install under <filename>/usr/local</filename>.
- Change those paths to:
+ As explained above, that directory hierarchy is reserved for local use on
+ Debian, so change those paths to:
  </para>
  <screen>
  # Where to put binary on 'make install'?
-Line 1302 
 BIN     = $(DESTDIR)/usr/bin
+Line 1492 
 BIN     = $(DESTDIR)/usr/bin
  ICONS   = $(DESTDIR)/usr/share/gentoo
  </screen>
  <para>
- But why in that directory, and not some other?  Because Debian packages never
+ The exact locations that should be used for binaries, icons,
- install files beneath <filename>/usr/local</filename> -- that tree is reserved
+ documentation, etc. are specified in the Filesystem Hierarchy Standard
- for the system administrator's use.  Such files on Debian systems go under
+ (FHS).  You should browse through it and read the sections relevant to
- <filename>/usr</filename> instead.
+ your package.
- </para>
- <para>
- The more exact locations for binaries, icons, documentation etc.  are specified
- in the Filesystem Hierarchy Standard (see
- <ulink url="&fhs;">FHS</ulink>).  I recommend you
- browse it and read the sections that might concern your package.
  </para>
  <para>
  So, we should install the binary in <filename>/usr/bin</filename> instead of
  <filename>/usr/local/bin</filename>, the manual page in
  <filename>/usr/share/man/man1</filename> instead of
- <filename>/usr/local/man/man1</filename> etc.  Notice how there's no manual
+ <filename>/usr/local/man/man1</filename>, and so on.  Notice how there's no manual
  page mentioned in <systemitem role="package">gentoo</systemitem>'s
- <filename>Makefile</filename>, but since the Debian Policy requires that every
+ <filename>Makefile</filename>, but since Debian Policy requires that every
  program has one, we'll make one later and install it in
  <filename>/usr/share/man/man1</filename>.
  </para>
-Line 1330 
 to fix them to use the right locations.
+Line 1514 
 to fix them to use the right locations.
  for?  You can find this out by issuing:
  </para>
  <screen>
- $ grep -nr -e 'usr/local/lib' --include='*.[c|h]' .
+ $ grep -nr --include='*.[c|h]' -e 'usr/local/lib' .
  </screen>
  <para>
  <command>grep</command> will run recursively through the source tree and tell
-Line 1341 
 Edit those files and in those lines repl
+Line 1525 
 Edit those files and in those lines repl
  with <literal>usr/lib</literal>.  This can be done automatically as follows:
  </para>
  <screen>
- $ vim '+argdo %s/usr\/local\/lib/usr\/lib/gce|update' +q \
+ $ sed -i -e 's#usr/local/lib#usr/lib#g' \
        $(find . -type f -name '*.[c|h]')
  </screen>
  <para>
- Be careful that you don't mess up the rest of the code!  :-)
+ If you want to confirm each substitution instead, this can be done interactively as follows:
  </para>
+ <screen>
+ $ vim '+argdo %s#usr/local/lib#usr/lib#gce|update' +q \
+       $(find . -type f -name '*.[c|h]')
+ </screen>
  <para>
- After that you should find the install target (search for line that starts with
+ Next you should find the <literal>install</literal> target (searching
- <literal>install:</literal>, that will usually work) and rename all references
+ for the line that starts with <literal>install:</literal> will usually
- to directories other than ones defined at the top of the
+ work) and rename all references to directories other than ones defined
- <filename>Makefile</filename>.
+ at the top of the <filename>Makefile</filename>.
  </para>
  <para>
- Before your upstream bug fix, <systemitem role="package">gentoo</systemitem>'s
+ Originally, <systemitem role="package">gentoo</systemitem>'s
  install target said:
  </para>
  <screen>
-Line 1364 
 install: gentoo-target
+Line 1553 
 install: gentoo-target
          install gentoorc-example $(HOME)/.gentoorc
  </screen>
  <para>
- Let's fix this and record this with the <command>quilt</command> command as
+ Let's fix this upstream bug and record it with the <command>dquilt</command> command as
  <filename>debian/patches/install.patch</filename>.
  </para>
  <screen>
- $ quilt new install.patch
+ $ dquilt new install.patch
- $ quilt add Makefile
+ $ dquilt add Makefile
  </screen>
  <para>
- Let's change this for Debian package as following using the editor:
+ In your editor, change this for the Debian package as follows:
  </para>
  <screen>
  install: gentoo-target
-Line 1382 
 install: gentoo-target
+Line 1571 
 install: gentoo-target
          install -m644 gentoorc-example $(DESTDIR)/etc/gentoorc
  </screen>
  <para>
- You've surely noticed that there's now a <literal>install -d</literal> command
+ You'll have noticed that there's now an <literal>install -d</literal> command
  before the other commands in the rule.  The original
- <filename>Makefile</filename> didn't have it because usually the
+ <filename>Makefile</filename> didn't have it because usually
  <literal>/usr/local/bin</literal> and other directories already exist on the
- system where one runs <literal>make install</literal>.  However, since we will
+ system where you are running <literal>make install</literal>.  However, since we will
- install into our own empty (or even nonexistent) directory, we will have to
+ be installing into a newly created private directory tree, we will have to
  create each and every one of those directories.
  </para>
  <para>
-Line 1399 
 of additional documentation that the ups
+Line 1588 
 of additional documentation that the ups
          cp -a docs/* $(DESTDIR)/usr/share/doc/gentoo/html
  </screen>
  <para>
- After careful check, if everything is fine, ask <command>quilt</command> to
+ Check carefully, and if everything is okay, ask <command>dquilt</command> to
- refresh the patch to create <filename>debian/patches/install.patch</filename>
+ generate the patch to create <filename>debian/patches/install.patch</filename>
  and add its description.
  </para>
  <screen>
- $ quilt refresh
+ $ dquilt refresh
- $ quilt header -e
+ $ dquilt header -e
  ... describe patch
  </screen>
  <para>
-Line 1428 
 Debian specific packaging modification:
+Line 1617 
 Debian specific packaging modification:
  Whenever you make changes that are not specifically related to Debian package
  such as <filename>debian/patches/fix-gentoo-target.patch</filename>, be sure to
  send them to the upstream maintainer so they can be included in the next
- program revision and be useful to everyone else.  Also remember to make your
+ revision of the program and be useful to everyone else.  Also remember
- fixes not specific to Debian or Linux (or even Unix!) prior to sending them --
+ to avoid making your fixes specific to Debian or Linux - or even Unix!
- make them portable.  This will make your fixes much easier to apply.
+ Make them portable.  This will make your fixes much easier to apply.
  </para>
  <para>
  Note that you don't have to send the <filename>debian/*</filename> files
-Line 1441 
 upstream.
+Line 1630 
 upstream.
  <para>
  There is one other common problem: libraries are often different from platform
  to platform.  For example, a <filename>Makefile</filename> can contain a
- reference to a library which doesn't exist on Debian systems.  In that case, we
+ reference to a library which doesn't exist on the Debian system.  In that case, we
  need to change it to a library which does exist in Debian, and serves the same
  purpose.
  </para>
  <para>
- So, if there is a line in your program's <filename>Makefile</filename> (or
+ Let's assume a line in your program's <filename>Makefile</filename> (or
- <filename>Makefile.in</filename>) that says something like this (and your
+ <filename>Makefile.in</filename>) as the following.
- program doesn't compile) <footnote><para> The author realizes that this is not
- the best example considering our <systemitem role="package">libncurses</systemitem> package now ships with a
- <filename>libcurses.so</filename> symlink, but he couldn't think of a better
- one.  Suggestions very welcome :-) </para> </footnote>:
  </para>
  <screen>
- LIBS = -lcurses -lsomething -lsomethingelse
+ LIBS = -lfoo -lbar
  </screen>
  <para>
- Let's fix this as <filename>debian/patches/ncurse.patch</filename> by changing
+ If your program doesn't compile since the <literal>foo</literal> library
- <literal>curses</literal> into <literal>ncurses</literal>.
+ doesn't exist and its equivalent is provided by the <literal>foo2</literal>
+ library on the Debian system, you can fix this build problem as
+ <filename>debian/patches/foo2.patch</filename> by changing
+ <literal>foo</literal> into <literal>foo2</literal>.<footnote><para>If there
+ are API changes from the <literal>foo</literal> library to the
+ <literal>foo2</literal> library, required changes to the source code need to be
+ made to match the new API.</para> </footnote>
  </para>
  <screen>
- $ quilt new ncurse.patch
+ $ dquilt new foo2.patch
- $ quilt add Makefile
+ $ dquilt add Makefile
- $ sed -i -e s/-lcurses/-lncurses/g Makefile
+ $ sed -i -e 's/-lfoo/-lfoo2/g' Makefile
- $ quilt refresh
+ $ dquilt refresh
- $ quilt header -e
+ $ dquilt header -e
  ... describe patch
  </screen>
  </section>
-Line 1478 
 that we should edit in order to customiz
+Line 1669 
 that we should edit in order to customiz
  most important of them are <filename>control</filename>,
  <filename>changelog</filename>, <filename>copyright</filename> and
  <filename>rules</filename>, which are required for all packages.
+ <footnote><para>
+ In this chapter, files in the <filename>debian</filename> directory are
+ referred without preceding <filename>debian/</filename> for simplicity whenever
+ they are obvious.
+ </para></footnote>
  </para>
  <section id="control"><title><filename>control</filename> file</title>
  <para>
-Line 1530 
 for administrator-only programs, <litera
+Line 1726 
 for administrator-only programs, <litera
  documentation, <literal>libs</literal> for libraries, <literal>mail</literal>
  for e-mail readers and daemons, <literal>net</literal> for network apps and
  daemons, <literal>x11</literal> for X11 programs that don't fit anywhere else,
- and many more.  See the <ulink url="&policy-subsections;">Debian
+ and many more.
- Policy Manual, 2.4 'Sections'</ulink> and <ulink url="&sections-unstable;">List of sections in 'sid'</ulink>
+ <footnote> <para>See
- for the guidance.
+ <ulink url="&policy-subsections;">Debian Policy Manual, 2.4 'Sections'</ulink> and
+ <ulink url="&sections-unstable;">List of sections in <literal>sid</literal></ulink>.</para>
+ </footnote>
  </para>
  <para>
  Let's change it then to x11.  (A <literal>main/</literal> prefix is implied so
  we can omit it.)
  </para>
  <para>
- Line 3 describes how important it is that the user installs this package.  See
+ Line 3 describes how important it is that the user installs this package.
- the <ulink url="&policy-priorities;">Debian
+ <footnote> <para>See
- Policy Manual, 2.5 'Priorities'</ulink> for the guidance.
+ <ulink url="&policy-priorities;">Debian Policy Manual, 2.5 'Priorities'</ulink>.
+ </para>
+ </footnote>
  </para>
  <itemizedlist>
  <listitem>
-Line 1577 
 you.  Avoid using commas, ampersands and
+Line 1777 
 you.  Avoid using commas, ampersands and
  <para>
  The 5th line includes the list of packages required to build your package as
  the <literal>Build-Depends</literal> field.  You can also have the
- <literal>Build-Depends-Indep</literal> field as an additional line, here (see
+ <literal>Build-Depends-Indep</literal> field as an additional line, here.
- the <ulink url="&policy-relationships;#s-sourcebinarydeps">Debian
+ <footnote><para>See <ulink url="&policy-relationships;#s-sourcebinarydeps">Debian
  Policy Manual, 7.7 'Relationships between source and binary packages -
  Build-Depends, Build-Depends-Indep, Build-Conflicts,
- Build-Conflicts-Indep'</ulink>).  Some packages like <systemitem role="package">gcc</systemitem> and <systemitem role="package">make</systemitem> which are required by the <systemitem role="package">build-essential</systemitem> package are implied.  If you need
+ Build-Conflicts-Indep'</ulink>.</para></footnote>  Some packages like
+ <systemitem role="package">gcc</systemitem> and
+ <systemitem role="package">make</systemitem> which are required by the
+ <systemitem role="package">build-essential</systemitem> package are implied.  If you need
  to have other tools to build your package, you should add them to these fields.
  Multiple entries are separated with commas; read on for the explanation of
  binary dependencies to find out more about the syntax of these lines.
-Line 1600 
 satisfy the Debian Policy requirement fo
+Line 1803 
 satisfy the Debian Policy requirement fo
  For source packages which have some binary packages with <literal>Architecture:
  any</literal>, they are rebuild by the autobuilder.  Since this autobuilder
  procedure runs <literal>debian/rules build</literal> in it while installing
- only packages listed in the <literal>Build-Depends</literal> field (see <xref linkend="autobuilder"/> ), the <literal>Build-Depends</literal> field needs to
+ only packages listed in the <literal>Build-Depends</literal> field (see <xref linkend="autobuilder"/>), the <literal>Build-Depends</literal> field needs to
  list practically all the required packages and the
  <literal>Build-Depends-indep</literal> is rarely used.
  </para>
-Line 1701 
 these relations; if not, it will be expl
+Line 1904 
 these relations; if not, it will be expl
  </citerefentry> etc.)
  </para>
  <para>
  Here is a simplified description of package relationships.
  <footnote><para>See
- <ulink url="&policy-relationships;">Debian Policy Manual, 7 'Declaring relationships between packages'</ulink>
+ <ulink url="&policy-relationships;">Debian Policy Manual, 7 'Declaring relationships between packages'</ulink>.
- </para></footnote>:
+ </para></footnote>
  </para>
  <itemizedlist>
  <listitem>
-Line 1825 
 Replaces: quux (&lt;&lt; 5), quux-foo (&
+Line 2028 
 Replaces: quux (&lt;&lt; 5), quux-foo (&
  <para>
  The last feature you need to know about is
  <literal>${shlibs:Depends}</literal>, <literal>${perl:Depends}</literal>,
- <literal>${misc:Depends}</literal>, etc.  These entries are substituted by the
+ <literal>${misc:Depends}</literal>, etc.
- list generated by other <systemitem role="package">debhelper</systemitem>
- components when the <citerefentry> <refentrytitle>dh_gencontrol</refentrytitle>
- <manvolnum>1</manvolnum> </citerefentry> command is executed.
  </para>
  <para>
  <citerefentry> <refentrytitle>dh_shlibdeps</refentrytitle>
- <manvolnum>1</manvolnum> </citerefentry> will scan it for binaries and
+ <manvolnum>1</manvolnum> </citerefentry> calculates shared library dependencies
- libraries determine their shared library dependencies and detect which packages
+ for binary packages.  It generates a list of ELF executables and shared
- they are in, such as <systemitem role="package">libc6</systemitem> or
+ libraries it has found for each binary package.  Such list is used for
- <systemitem role="package">xlib6g</systemitem>, after your package has been
+ substituting <literal>${shlibs:Depends}</literal>.
- built and installed into the temporary directory.  This package list is used
- for substituting <literal>${shlibs:Depends}</literal>.
  </para>
  <para>
- The package list generated by <citerefentry>
+ <citerefentry> <refentrytitle>dh_perl</refentrytitle> <manvolnum>1</manvolnum>
- <refentrytitle>dh_perl</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
+ </citerefentry> calculates Perl dependencies.  It generates a list of a
- is used for substituting <literal>${perl:Depends}</literal>.
+ dependency on <literal>perl</literal> or <literal>perlapi</literal> for each binary package.  Such list is used for
+ substituting <literal>${perl:Depends}</literal>.
  </para>
  <para>
  Some <systemitem role="package">debhelper</systemitem> commands may make the
- generated package need to depend on some other packages.  This list of required
+ generated package need to depend on some other packages.  All such commands
- packages is used for substituting <literal>${misc:Depends}</literal>.
+ generate a list of required packages for each binary package.
+ Such list is used for substituting <literal>${misc:Depends}</literal>.
+ </para>
+ <para>
+ <citerefentry> <refentrytitle>dh_gencontrol</refentrytitle>
+ <manvolnum>1</manvolnum> </citerefentry> generates
+ <filename>DEBIAN/control</filename> for each binary package while
+ substituting <literal>${shlibs:Depends}</literal>,
+ <literal>${perl:Depends}</literal>, <literal>${misc:Depends}</literal>, etc.
  </para>
  <para>
  Having said all that, we can leave the <literal>Depends</literal> field exactly
-Line 1874 
 English.  Translations of these descript
+Line 2081 
 English.  Translations of these descript
  <ulink url="&ddtp;">The Debian Description Translation Project - DDTP</ulink>.</para></footnote>
  </para>
  <para>
- Let's insert <literal>Vcs-*</literal> fields documented in <ulink url="&devref-bpp-vcs;">Developer's
+ Let's insert <literal>Vcs-*</literal> fields to document the Version Control
- Reference, 6.2.5.  'Version Control System location'</ulink> between line 6 and
+ System (VCS) location between line 6 and 7.
-.  Let's assume that the <systemitem role="package">gentoo</systemitem>
+ <footnote><para>See
- package is located in Debian Alioth Git Service at
+ <ulink url="&devref-bpp-vcs;">Developer's Reference, 6.2.5. 'Version Control System location'</ulink>.
+ </para></footnote>
+ Let's assume that the <systemitem role="package">gentoo</systemitem>
+ package has its VCS located in Debian Alioth Git Service at
  <literal>git://git.debian.org/git/collab-maint/gentoo.git</literal>.
  </para>
  <para>
-Line 1920 
 Finally, here is the updated <filename>c
+Line 2130 
 Finally, here is the updated <filename>c
  <section id="copyright"><title><filename>copyright</filename> file</title>
  <para>
  This file contains the information about package upstream resources, copyright
- and license information.  Its format is not dictated by the Debian Policy
+ and license information.
- Manual, but the content is (<ulink url="&policy-copyright;">Debian
+ <ulink url="&policy-copyright;">Debian Policy Manual, 12.5 'Copyright information'</ulink>
- Policy Manual, 12.5 'Copyright information'</ulink>).  You may also consult
+ dictates its content and
- <ulink url="&dep5;">DEP-5: Machine-parseable
+ <ulink url="&dep5;">DEP-5: Machine-parseable <filename>debian/copyright</filename></ulink>
- debian/copyright</ulink>.
+ provides guidelines for its format.
  </para>
  <para>
  <command>dh_make</command> can give you a template
-Line 1990 
 debian-devel-announce: <ulink url="&howt
+Line 2200 
 debian-devel-announce: <ulink url="&howt
  </section>
  <section id="changelog"><title><filename>changelog</filename> file</title>
  <para>
- This is a required file, which has a special format described in the <ulink url="&policy-dpkgchangelog;">Debian
+ This is a required file, which has a special format described in the
- Policy Manual, 4.4 'debian/changelog'</ulink>.  This format is used by
+ <ulink url="&policy-dpkgchangelog;">Debian Policy Manual, 4.4 'debian/changelog'</ulink>.
- <command>dpkg</command> and other programs to obtain the version number,
+ This format is used by <command>dpkg</command> and other programs to obtain the
- revision, distribution and urgency of your package.
+ version number, revision, distribution and urgency of your package.
  </para>
  <para>
  For you, it is also important, since it is good to have documented all changes
-Line 2055 
 You will end up with something like this
+Line 2265 
 You will end up with something like this
  </para>
  <para>
  You can read more about updating the <filename>changelog</filename> file later
- in <xref linkend="update"/> .
+ in <xref linkend="update"/>.
  </para>
  </section>
  <section id="rules"><title><filename>rules</filename> file</title>
-Line 2104 
 binary package under the <filename>debia
+Line 2314 
 binary package under the <filename>debia
  <literal>binary</literal> target: to create all binary packages (effectively
  combination of <literal>binary-arch</literal> and
  <literal>binary-indep</literal> targets).  (required)<footnote><para> This
- target is used by <literal>dpkg-buildpackage</literal> as in <xref linkend="completebuild"/> .  </para> </footnote>
+ target is used by <literal>dpkg-buildpackage</literal> as in <xref linkend="completebuild"/>.  </para> </footnote>
  </para>
  </listitem>
  <listitem>
-Line 2112 
 target is used by <literal>dpkg-buildpac
+Line 2322 
 target is used by <literal>dpkg-buildpac
  <literal>binary-arch</literal> target: to create arch-dependent
  (<literal>Architecture: any</literal>) binary packages in the parent directory.
  (required)<footnote><para> This target is used by <literal>dpkg-buildpackage
- -B</literal> as in <xref linkend="autobuilder"/> .  </para> </footnote>
+ -B</literal> as in <xref linkend="autobuilder"/>.  </para> </footnote>
  </para>
  </listitem>
  <listitem>
-Line 2177 
 It tells the operating system that this
+Line 2387 
 It tells the operating system that this
  <filename>/usr/bin/make</filename>.
  </para>
  <para>
- Line 10 can be uncommented to set <literal>DH_VERBOSE</literal> variable to 1.
+ Line 11 can be uncommented to set <literal>DH_VERBOSE</literal> variable to 1.
  Then, the <command>dh</command> command will output which
  <command>dh_*</command> commands are executed by the <command>dh</command>
  command.  You can also add <literal>export DH_OPTIONS=-v</literal> line here.
-Line 2199 
 complicated <filename>rules</filename> f
+Line 2409 
 complicated <filename>rules</filename> f
  scripts listed for each required explicit targets and frozen them to the state
  when it was initially packaged.  This new <command>dh</command> command is
  simpler and frees us from this constrain.  You still have full power to
- customize this with <literal>override_dh_*</literal> targets.  See <xref linkend="customrules"/> .  It is based only on the <systemitem role="package">debhelper</systemitem> package and does not obfuscate the
+ customize this with <literal>override_dh_*</literal> targets.  See <xref linkend="customrules"/>.  It is based only on the <systemitem role="package">debhelper</systemitem> package and does not obfuscate the
  package building process like the <systemitem role="package">cdbs</systemitem>
  package.  </para> </footnote> The <command>dh</command> command is a wrapper
  script which runs appropriate sequences of <command>dh_*</command> programs
-Line 2613 
 This installs <command>bash</command> co
+Line 2823 
 This installs <command>bash</command> co
  </listitem>
  </itemizedlist>
  <para>
- For sources using Autotools, use combination of above as <literal>dh --with
- autotools-dev --with autoreconf $@</literal> to be most current with the GNU
- Build System.
- </para>
- <para>
  Many <command>dh_*</command> commands invoked by the new <command>dh</command>
  command can be customized by the corresponding configuration files in the
  <filename>debian</filename> directory.  See <xref linkend="dother"/> and the
-Line 2644 
 corner cases.  Use of simplified equival
+Line 2849 
 corner cases.  Use of simplified equival
  kill such <systemitem role="package">debhelper</systemitem>'s smart features.
  </para>
  <para>
- If you want to store the system configuration data for the <systemitem role="package">gentoo</systemitem> package in the
+ If you want to store the system configuration data in the
  <filename>/etc/gentoo</filename> directory instead of the usual
- <filename>/etc</filename> directory, you can override the default
+ <filename>/etc</filename> directory for the recent
+ <systemitem role="package">gentoo</systemitem> package using Autotools, you can override the default
  <literal>--sysconfig=/etc</literal> argument given by the
  <command>dh_auto_configure</command> command to the
- <command>./configure</command> command by the following.  <footnote><para> The
+ <command>./configure</command> command by the following.
- <systemitem role="package">gentoo</systemitem> package uses the <ulink url="&gnu-build-system;">GNU build
- system</ulink>, also known as the Autotools.
- </para> </footnote>
  </para>
  <screen>
  override_dh_auto_configure:
-Line 2744 
 filenames suffixed by <literal>.ex</lite
+Line 2947 
 filenames suffixed by <literal>.ex</lite
  prefixed by the binary package name such as
  <literal><replaceable>package</replaceable></literal>.  Take a look at all of
  them.
+ <footnote><para>
+ In this chapter, files in the <filename>debian</filename> directory are
+ referred without preceding <filename>debian/</filename> for simplicity whenever
+ they are obvious.
+ </para></footnote>
  </para>
  <para>
  The <command>dh_make</command> command may not create some template
-Line 2778 
 remove template files which you do not n
+Line 2986 
 remove template files which you do not n
  </listitem>
  <listitem>
  <para>
- modify the <filename>control</filename> file (see <xref linkend="control"/> ),
+ modify the <filename>control</filename> file (see <xref linkend="control"/>),
  if necessary.
  </para>
  </listitem>
  <listitem>
  <para>
- modify the <filename>rules</filename> file (see <xref linkend="rules"/> ), if
+ modify the <filename>rules</filename> file (see <xref linkend="rules"/>), if
  necessary.
  </para>
  </listitem>
-Line 2875 
 the <filename>/etc</filename> directory.
+Line 3083 
 the <filename>/etc</filename> directory.
  </listitem>
  </itemizedlist>
  <para>
- For more information on the <emphasis>maintainer scripts</emphasis>, see <xref linkend="maintscripts"/> .
+ For more information on the <emphasis>maintainer scripts</emphasis>, see <xref linkend="maintscripts"/>.
  </para>
  </section>
  <section id="crond"><title><filename><replaceable>package</replaceable>.cron.*</filename> files</title>
-Line 2944 
 means there is a problem with the <filen
+Line 3152 
 means there is a problem with the <filen
  </para>
  <para>
  Files listed in the <filename>install</filename> file doesn't need the
- directories created first.  See <xref linkend="install"/> .
+ directories created first.  See <xref linkend="install"/>.
  </para>
  <para>
- It is best to first try to run the installation first and only use this if you
+ It is best to try to run the installation first and only use this if you
  run into trouble.  There is no preceding slash on the directory names listed in
  the <filename>dirs</filename> file.
  </para>
-Line 2987 
 For information on the file format, see
+Line 3195 
 For information on the file format, see
  manual, in <ulink url="&doc-base;">Debian doc-base Manual</ulink>.
  </para>
  <para>
- For more details on installing additional documentation, look in <xref linkend="destdir"/> .
+ For more details on installing additional documentation, look in <xref linkend="destdir"/>.
  </para>
  </section>
  <section id="docs"><title><filename>docs</filename> file</title>
-Line 3045 
 obviously disregarded my initial recomme
+Line 3253 
 obviously disregarded my initial recomme
  <para>
  The <filename><replaceable>package</replaceable>.init</filename> file is
  installed as the
- <filename>/etc/init.d/<replaceable>package</replaceable></filename> script.
+ <filename>/etc/init.d/<replaceable>package</replaceable></filename> script
+ for the <emphasis>init script</emphasis> which starts and stops a daemon.
  Its fairly generic skeleton template is provided by the
  <command>dh_make</command> command as <filename>init.d.ex</filename>.  You'll
  likely have to rename and edit it, a lot, while making sure to provide
- Filesystem Hierarchy Standard (see <ulink url="&fhs;">FHS</ulink>) compliant headers.  It
+ <ulink url="&lsb;">Linux Standard Base</ulink> (LSB) compliant headers.  It
  gets installed into the temporary directory by <citerefentry>
  <refentrytitle>dh_installinit</refentrytitle> <manvolnum>1</manvolnum>
  </citerefentry>.
-Line 3058 
 gets installed into the temporary direct
+Line 3267 
 gets installed into the temporary direct
  The <filename><replaceable>package</replaceable>.default</filename> file will
  be installed into
  <filename>/etc/default/<replaceable>package</replaceable></filename>.  This
- file sets defaults that are sourced by the init script.  Most times this
+ file sets defaults that are sourced by the <emphasis>init script</emphasis>.  Most times this
- default file is used to disable running a daemon, set some default flags or
+ <filename><replaceable>package</replaceable>.default</filename> file is used to disable running a daemon, set some default flags or
- timeouts.  If your init script has certain <emphasis>settable</emphasis>
+ timeouts.  If your <emphasis>init script</emphasis> has certain <emphasis>settable</emphasis>
- features you want to install these into the default file, not the init script.
+ features you want to install these into the <filename><replaceable>package</replaceable>.default</filename> file, not the <emphasis>init script</emphasis>.
  </para>
  <para>
- If your upstream program has an init file you can either use it or not.  If you
+ If your upstream program provides a file for the <emphasis>init script</emphasis>, you can either use it or not.  If you
- don't use their init.d script then create a new one in
+ don't use their <emphasis>init script</emphasis> then create a new one in
- <filename>debian/<replaceable>package</replaceable>.init</filename>.  However
+ <filename><replaceable>package</replaceable>.init</filename>.  However
- if the upstream init script looks fine and installs in the right place you
+ if the upstream <emphasis>init script</emphasis> looks fine and installs in the right place you
  still need to setup the <filename>rc*</filename> symlinks.  To do this you will
  need to override <command>dh_installinit</command> in the
  <filename>rules</filename> file with the following lines:
-Line 3186 
 list of manual page sections:
+Line 3395 
 list of manual page sections:
      <row> <entry>1</entry> <entry>User command</entry> <entry>Executable commands or scripts</entry> </row>
      <row> <entry>2</entry> <entry>System calls</entry> <entry>Functions provided by the kernel</entry> </row>
      <row> <entry>3</entry> <entry>Library calls</entry> <entry>Functions within system libraries</entry> </row>
-     <row> <entry>4</entry> <entry>Special files</entry> <entry>Usually found in /dev</entry> </row>
+     <row> <entry>4</entry> <entry>Special files</entry> <entry>Usually found in <filename>/dev</filename></entry> </row>
      <row> <entry>5</entry> <entry>File formats</entry> <entry>E.g. <filename>/etc/passwd</filename>'s format</entry> </row>
      <row> <entry>6</entry> <entry>Games</entry> <entry>Games or other frivolous programs</entry> </row>
-     <row> <entry>7</entry> <entry>Macro packages</entry> <entry>Such as man macros</entry> </row>
+     <row> <entry>7</entry> <entry>Macro packages</entry> <entry>Such as <command>man</command> macros</entry> </row>
      <row> <entry>8</entry> <entry>System administration</entry> <entry>Programs typically only run by root</entry> </row>
      <row> <entry>9</entry> <entry>Kernel routines</entry> <entry>Non-standard calls and internals</entry> </row>
    </tbody>
-Line 3302 
 If your package has manual pages, you sh
+Line 3511 
 If your package has manual pages, you sh
  </para>
  <para>
  To install <filename>docs/gentoo.1</filename> for the <systemitem role="package">gentoo</systemitem> package as its manpage, you create a
- <filename>gentoo.manpages</filename> file as:
+ <filename>gentoo.manpages</filename> file as the following.
  </para>
  <screen>
  docs/gentoo.1
-Line 3316 
 the system will be created for them.
+Line 3525 
 the system will be created for them.
  </para>
  <para>
  Here's the default <filename>menu.ex</filename> file that
- <command>dh_make</command> created:
+ <command>dh_make</command> created.
  </para>
  <screen>
  ?package(gentoo):needs=X11|text|vc|wm \
-Line 3329 
 specifies what kind of interface the pro
+Line 3538 
 specifies what kind of interface the pro
  listed alternatives, e.g.  <literal>text</literal> or <literal>X11</literal>.
  </para>
  <para>
- The next is <literal>section</literal>, where the menu and submenu the entry
+ The next is <literal>section</literal>, where the menu and submenu entry
- should appear in.  The current list of sections <footnote><para> There were a
+ should appear in.
- major reorganization of menu structure for <literal>squeeze</literal>.  </para>
+ <footnote><para> The current list of sections is at
- </footnote> is at <ulink url="&menu-structure;">The Debian Menu sub-policy 2.1 'Preferred menu structure'</ulink>.
+ <ulink url="&menu-structure;">The Debian Menu sub-policy 2.1 'Preferred menu structure'</ulink>.
+ There were a major reorganization of menu structure for <literal>squeeze</literal>.
+ </para> </footnote>
  </para>
  <para>
  The <literal>title</literal> field is the name of the program.  You can start
-Line 3448 
 Normally with this <filename>watch</file
+Line 3659 
 Normally with this <filename>watch</file
  <literal>&sf-net;/gentoo</literal> is downloaded and searched for links of
  the form <literal>&lt;a href=...&gt;</literal>.  The base name (just the part
  after the final <literal>/</literal>) of these linked URLs are matched against
- Perl regexp (see <citerefentry> <refentrytitle>perlre</refentrytitle>
+ Perl regular expression (see <citerefentry> <refentrytitle>perlre</refentrytitle>
  <manvolnum>1</manvolnum> </citerefentry>) pattern
  <literal>gentoo-(.+)\.tar\.gz</literal>.  Out of matched files, the file with
  the greatest version number is downloaded and the <command>uupdate</command>
-Line 3456 
 program is run to create the updated sou
+Line 3667 
 program is run to create the updated sou
  </para>
  <para>
  Although this is true for other sites, the SourceForge download service at
- <ulink url="&sf-net;">&sf-net;</ulink> is an exception.  When the
+ <ulink url="&sf-net;"/> is an exception.  When the
  <filename>watch</filename> file has an URL matching with the Perl regexp
  <literal>^http://sf\.net/</literal>, the <command>uscan</command> program
  substitutes it with <literal>&qa-do;watch/sf.php/</literal> and
-Line 3520 
 Debian packaging to ease merging of the
+Line 3731 
 Debian packaging to ease merging of the
  </para>
  <para>
  After you build a package, the source is normally left patched.  You need to
- unpatch it manually by running <literal>quilt pop -a</literal> before
+ unpatch it manually by running <literal>dquilt pop -a</literal> before
  committing to the <literal>master</literal> branch.  You can automate this by
  adding the optional <filename>debian/source/local-options</filename> file
  containing <literal>unapply-patches</literal>.  This file is not included in
-Line 3542 
 such as <command>dh_autoreconf</command>
+Line 3753 
 such as <command>dh_autoreconf</command>
  <xref linkend="customrules"/>.
  </para>
  <para>
- You can provide a Perl regular expression argument to the
+ You can provide a Perl regular expression to the
- <literal>--extend-diff-ignore</literal> option of <citerefentry>
+ <literal>--extend-diff-ignore</literal> option argument of <citerefentry>
  <refentrytitle>dpkg-source</refentrytitle><manvolnum>1</manvolnum>
  </citerefentry> to ignore changes made to the autogenerated files while
  creating the source package.
-Line 3552 
 creating the source package.
+Line 3763 
 creating the source package.
  You can store such <command>dpkg-source</command> option argument in the
  <filename>source/options</filename> file of the source package as the generic
  solution to address this problem of the autogenerated files.  The following
- will skip creating patch files for <filename>config.sub</filename>
+ will skip creating patch files for <filename>config.sub</filename>,
  <filename>config.guess</filename> and <filename>Makefile</filename>.
  </para>
  <screen>
-Line 3597 
 documentation of your changes are very i
+Line 3808 
 documentation of your changes are very i
  by your sponsor.  </para> </footnote>
  </para>
  <para>
- For <xref linkend="modify"/> , we created 3 patches in
+ For <xref linkend="modify"/>, we created 3 patches in
  <filename>debian/patches</filename>.
  </para>
  <para>
  Since Debian patches are located in <filename>debian/patches</filename>, please
- make sure to setup the <command>quilt</command> command properly as described
+ make sure to setup the <command>dquilt</command> command properly as described
- in <xref linkend="quiltrc"/> .
+ in <xref linkend="quiltrc"/>.
  </para>
  <para>
  When someone (including yourself) provides you with a patch
-Line 3614 
 quite simple:
+Line 3825 
 quite simple:
  <screen>
  $ dpkg-source -x gentoo_0.9.12.dsc
  $ cd gentoo-0.9.12
- $ quilt import ../<replaceable>foo</replaceable>.patch
+ $ dquilt import ../<replaceable>foo</replaceable>.patch
- $ quilt push
+ $ dquilt push
- $ quilt refresh
+ $ dquilt refresh
- $ quilt header -e
+ $ dquilt header -e
  ... describe patch
  </screen>
  <para>
  The patches stored in the newer <literal>3.0 (quilt)</literal> source format
- must be <emphasis>fuzz</emphasis> free.  You should ensure it as <literal>quilt
+ must be <emphasis>fuzz</emphasis> free.  You should ensure it as <literal>dquilt
- pop -a; while quilt push; do quilt refresh; done</literal>.
+ pop -a; while dquilt push; do dquilt refresh; done</literal>.
  </para>
  </section>
  </chapter>
-Line 3644 
 the <systemitem role="package">build-ess
+Line 3855 
 the <systemitem role="package">build-ess
  </listitem>
  <listitem>
  <para>
- packages listed in the <literal>Build-Depends</literal> field (see <xref linkend="control"/> ), and
+ packages listed in the <literal>Build-Depends</literal> field (see <xref linkend="control"/>), and
  </para>
  </listitem>
  <listitem>
  <para>
- packages listed in the <literal>Build-Depends-indep</literal> field (see <xref linkend="control"/> ).
+ packages listed in the <literal>Build-Depends-indep</literal> field (see <xref linkend="control"/>).
  </para>
  </listitem>
  </itemizedlist>
-Line 3700 
 create and sign the upload <filename>.ch
+Line 3911 
 create and sign the upload <filename>.ch
  The only input that will be required of you is your GPG secret pass phrase,
  twice.
  <footnote><para>
- This GPG key must be signed by the Debian developer to get connected to the web
+ This GPG key must be signed by a Debian developer to get connected to the web
- of trust.  This enables your uploaded packages to be accepted to the Debian
+ of trust and must be registered to <ulink url="&keyring;">the Debian
- archives.  See
+ keyring</ulink>.  This enables your uploaded packages to be accepted to the
+ Debian archives.  See
  <ulink url="&keycreate;">Creating a new GPG key</ulink> and
  <ulink url="&keysigning; ">Debian Wiki on Keysigning</ulink>.
  </para></footnote>
-Line 3751 
 copy the three files somewhere else and
+Line 3963 
 copy the three files somewhere else and
  gentoo_0.9.12-1.dsc</literal>.  <footnote><para> You can avoid applying
  <command>quilt</command> patches in the <literal>3.0 (quilt)</literal> source
  format at the end of the extraction with the <literal>--skip-patches</literal>
- option.  Alternatively, you can run <literal>quilt pop -a</literal> after
+ option.  Alternatively, you can run <literal>dquilt pop -a</literal> after
  normal operation.  </para> </footnote>
  </para>
  </listitem>
-Line 3819 
 the <systemitem role="package">build-ess
+Line 4031 
 the <systemitem role="package">build-ess
  </listitem>
  <listitem>
  <para>
- packages listed in the <literal>Build-Depends</literal> field (see <xref linkend="control"/> ).
+ packages listed in the <literal>Build-Depends</literal> field (see <xref linkend="control"/>).
  </para>
  </listitem>
  </itemizedlist>
-Line 3867 
 This is why you see your package for oth
+Line 4079 
 This is why you see your package for oth
  </para>
  <para>
  Although packages listed in the <literal>Build-Depends-indep</literal> field
- are required to be installed for the normal packaging by us (see <xref linkend="completebuild"/> ), they are not required to be installed for the
+ are required to be installed for the normal packaging by us (see <xref linkend="completebuild"/>), they are not required to be installed for the
  autobuilder system since it build only architecture dependent binary packages.
  <footnote><para> Unlike under the <systemitem role="package">pbuilder</systemitem> package, the <command>chroot</command>
  environment under the <systemitem role="package">sbuild</systemitem> package
-Line 3876 
 many packages installed.  </para> </foot
+Line 4088 
 many packages installed.  </para> </foot
  packaging and autobuilder situation dictates whether you record such required
  packages in the <literal>Build-Depends</literal> or
  <literal>Build-Depends-indep</literal> fields of the
- <filename>debian/control</filename> file (see <xref linkend="control"/> ).
+ <filename>debian/control</filename> file (see <xref linkend="control"/>).
  </para>
  </section>
  <section id="option-sa"><title>Including <filename>orig.tar.gz</filename> for upload</title>
-Line 3940 
 For a clean room (<command>chroot</comma
+Line 4152 
 For a clean room (<command>chroot</comma
  build dependencies, the <systemitem role="package">pbuilder</systemitem>
  package is very useful.  <footnote><para> Since the <systemitem role="package">pbuilder</systemitem> package is still evolving, you have to
  check the actual configuration situation by consulting the latest official
- documentation.  </para> </footnote> This ensures a clean build from the source
+ documentation.</para> </footnote> This ensures a clean build from the source
  under the <literal>sid</literal> auto-builder for different architectures and
  avoids the severity serious FTBFS (Fails To Build From Source) bug which is
- always in the RC (release critical) category.  See <ulink url="&buildd-do;"/> for more on the Debian
+ always in the RC (release critical) category.
- package <systemitem role="package">auto-builder</systemitem>.
+ <footnote><para>See <ulink url="&buildd-do;"/> for more on the
+ auto-builder of the Debian package.</para></footnote>
  </para>
  <para>
  Let's customize the <systemitem role="package">pbuilder</systemitem> package by
-Line 4085 
 See <ulink url="&pbuilder;"/>,
+Line 4298 
 See <ulink url="&pbuilder;"/>,
  </section>
  <section id="git-buildpackage"><title><command>git-buildpackage</command> command and similars</title>
  <para>
- If your upstream uses the source code management system (<ulink url="&debref-vcs;">VCS</ulink>)
+ If your upstream uses the source code management system (VCS)
+ <footnote><para>See <ulink url="&debref-vcs;">Version control systems</ulink> for more.</para></footnote>
  to maintain their code, you should consider to use them.  That makes merging
  and cherry-picking upstream patches much easier.  There are several specialized
  wrapper script packages for the Debian package building for each VCS.
-Line 4099 
 Debian packages in Git repositories.
+Line 4313 
 Debian packages in Git repositories.
  </listitem>
  <listitem>
  <para>
- <systemitem role="package">topgit</systemitem>: a Git patch queue manager
- </para>
- </listitem>
- <listitem>
- <para>
  <systemitem role="package">svn-buildpackage</systemitem>: helper programs to
  maintain Debian packages with Subversion.
  </para>
-Line 4116 
 package scripts for CVS source trees.
+Line 4325 
 package scripts for CVS source trees.
  </listitem>
  </itemizedlist>
  <para>
- These packages offer more elegant working environment than manual use of the
+ There are packages which <emphasis>automate</emphasis> building of packages
- <command>quilt</command> commands for advanced audiences to
+ under VCS managed source tree for advanced audiences.  I will not explain them
- <emphasis>automate</emphasis> building of packages.  I will not explain them in
+ in this tutorial.
- this tutorial.
  <footnote><para> Here are few web resources available for advanced audiences.  </para>
  <itemizedlist>
  <listitem> <para> <ulink url="&git-buildpackage-doc;">Building Debian Packages with git-buildpackage</ulink> </para> </listitem>
  <listitem> <para> <ulink url="&debian-packages-git;">debian packages in git</ulink> </para> </listitem>
  <listitem> <para> <ulink url="&git-debian-packaging;">Using Git for Debian Packaging</ulink> </para> </listitem>
+ <listitem> <para> <ulink url="&git-dpm;">git-dpm: Debian packages in Git manager</ulink> </para> </listitem>
  <listitem> <para> <ulink url="&topgit;">Using TopGit to generate quilt series for Debian packaging</ulink> </para> </listitem>
- <listitem> <para> <ulink url="&git-dpm;">git-dpm: Debian packages in Git manager</ulink> </para> </listitem> </itemizedlist>
+ </itemizedlist>
  </footnote>
  </para>
  </section>
-Line 4194 
 All <emphasis>maintainer scripts</emphas
+Line 4403 
 All <emphasis>maintainer scripts</emphas
  <filename>preinst</filename>, <filename>prerm</filename>,
  <filename>postinst</filename>, and <filename>postrm</filename> files, are
  non-trivial unless they are auto-generated by the <systemitem role="package">debhelper</systemitem> programs.  So do not use them if you are
- a novice maintainer (see <xref linkend="maintscripts"/> ).
+ a novice maintainer (see <xref linkend="maintscripts"/>).
  </para>
  <para>
  If the package makes use of these non-trivial <emphasis>maintainer
-Line 4275 
 file.  The <command>lintian</command> co
+Line 4484 
 file.  The <command>lintian</command> co
  for many common packaging errors.  <footnote><para> You do not need to provide
  the <command>lintian</command> option <literal>-i -I --show-overrides</literal>
  if you customized <filename>/etc/devscripts.conf</filename> or
- <filename>~/.devscripts</filename> as described in <xref linkend="debuild"/> .
+ <filename>~/.devscripts</filename> as described in <xref linkend="debuild"/>.
  </para> </footnote>
  </para>
  <screen>
-Line 4319 
 error.
+Line 4528 
 error.
  <para>
  For warnings, tune the package to avoid them or verify that the warnings are
  spurious.  If spurious, set the <filename>lintian-overrides</filename> files as
- described in <xref linkend="lintian"/> .
+ described in <xref linkend="lintian"/>.
  </para>
  <para>
  Note that you can build the package with <command>dpkg-buildpackage</command>
-Line 4397 
 your <filename>rules</filename> file to
+Line 4606 
 your <filename>rules</filename> file to
  </chapter>
  <chapter id="upload"><title>Uploading the package</title>
  <para>
- Now that you have tested your new package thoroughly, you will be technically
+ Now that you have tested your new package thoroughly, you want to release it to
- ready to start the Debian new maintainer application process, as described at
+ a public archive to share it.
- <ulink url="&nm-join;"/>
  </para>
  <section id="upload-debian"><title>Uploading to the Debian archive</title>
  <para>
- Once you become an official developer, you'll need to upload the package to the
+ Once you become an official developer,
- Debian archive.  You can do this manually, but it's easier to use the provided
+ <footnote><para>
+ See <xref linkend="socialdynamism"/>.
+ </para></footnote>
+ you can upload the package to the Debian archive.
+ <footnote><para>
+ There are publicly accessible archives such as <ulink url="&mentors-dn;"/>
+ which work almost the same way as Debian archive and provide upload area for
+ the non-DD.  You can set up an equivalent archive by yourself using tools
+ listed at <ulink url="&deb-archive;"/>.  So this section is useful for the
+ non-DD, too.
+ </para></footnote>
+ You can do this manually, but it's easier to use the existing
  automated tools, like <citerefentry> <refentrytitle>dupload</refentrytitle>
  <manvolnum>1</manvolnum> </citerefentry> or <citerefentry>
  <refentrytitle>dput</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>.
-Line 4470 
 Z4jxNrgh7Bc=
+Line 4689 
 Z4jxNrgh7Bc=
  =pH94
  -----END PGP SIGNATURE-----
  </screen>
- <para>
- See <ulink url="&mentors-dn;"/> for
- publically accessible upload area for non-DD.
- </para>
- <para>
- See <ulink url="&debref-archive;">Debian
- Reference, 2.7.12.  'Small public package archive'</ulink> for an example for
- creating a small public package archive compatible with the modern secure APT
- system.
- </para>
  </section>
  <section id="skipped-uploads"><title>Skipped uploads</title>
  <para>
-Line 4512 
 If this is to be recorded as a new patch
+Line 4721 
 If this is to be recorded as a new patch
  <itemizedlist>
  <listitem>
  <para>
- <literal>quilt new <replaceable>bugname.patch</replaceable></literal> to set
+ <literal>dquilt new <replaceable>bugname.patch</replaceable></literal> to set
  patch name;
  </para>
  </listitem>
  <listitem>
  <para>
- <literal>quilt add <replaceable>buggy-file</replaceable></literal> to declare
+ <literal>dquilt add <replaceable>buggy-file</replaceable></literal> to declare
  file to be modified;
  </para>
  </listitem>
-Line 4529 
 Correct the problem in the package sourc
+Line 4738 
 Correct the problem in the package sourc
  </listitem>
  <listitem>
  <para>
- <literal>quilt refresh</literal> to record to
+ <literal>dquilt refresh</literal> to record to
  <filename><replaceable>bugname.patch</replaceable></filename>;
  </para>
  </listitem>
  <listitem>
  <para>
- <literal>quilt header -e</literal> to add its description;
+ <literal>dquilt header -e</literal> to add its description;
  </para>
  </listitem>
  </itemizedlist>
-Line 4547 
 If this is to update an existing patch,
+Line 4756 
 If this is to update an existing patch,
  <itemizedlist>
  <listitem>
  <para>
- <literal>quilt pop <replaceable>foo.patch</replaceable></literal> to recall
+ <literal>dquilt pop <replaceable>foo.patch</replaceable></literal> to recall
  existing <filename><replaceable>foo.patch</replaceable></filename>;
  </para>
  </listitem>
-Line 4559 
 Correct the problem in the old
+Line 4768 
 Correct the problem in the old
  </listitem>
  <listitem>
  <para>
- <literal>quilt refresh</literal> to update
+ <literal>dquilt refresh</literal> to update
  <filename><replaceable>foo.patch</replaceable></filename>;
  </para>
  </listitem>
  <listitem>
  <para>
- <literal>quilt header -e</literal> to update its description;
+ <literal>dquilt header -e</literal> to update its description;
  </para>
  </listitem>
  <listitem>
  <para>
- <literal>while quilt push; do quilt refresh; done</literal> to apply all
+ <literal>while dquilt push; do dquilt refresh; done</literal> to apply all
  patches while removing <emphasis>fuzz</emphasis>;
  </para>
  </listitem>
-Line 4603 
 Repeat what you did in the above to fix
+Line 4812 
 Repeat what you did in the above to fix
  </listitem>
  <listitem>
  <para>
- Repeat what you did in <xref linkend="completebuild"/> , <xref linkend="checkit"/> , and <xref linkend="upload"/> .  The difference is that
+ Repeat what you did in <xref linkend="completebuild"/>, <xref linkend="checkit"/>, and <xref linkend="upload"/>.  The difference is that
  this time, the original source archive won't be included, as it hasn't been
  changed and it already exists in the Debian archive.
  </para>
-Line 4667 
 Update the Debian <filename>changelog</f
+Line 4876 
 Update the Debian <filename>changelog</f
  <itemizedlist>
  <listitem>
  <para>
- Add an entry with "<literal>New upstream release</literal>".
+ Add an entry with <literal>New upstream release</literal>.
  </para>
  </listitem>
  <listitem>
  <para>
  Describe concisely the changes <emphasis>in the new upstream release</emphasis>
- that fix reported bugs and close those bugs by adding "<literal>Closes: #<replaceable>bug_number</replaceable></literal>".
+ that fix reported bugs and close those bugs by adding <literal>Closes: #<replaceable>bug_number</replaceable></literal>.
  </para>
  </listitem>
  <listitem>
  <para>
  Describe concisely the changes <emphasis>to the new upstream release</emphasis>
- by the maintainer that fix reported bugs and close those bugs by adding "<literal>Closes: #<replaceable>bug_number</replaceable></literal>".
+ by the maintainer that fix reported bugs and close those bugs by adding <literal>Closes: #<replaceable>bug_number</replaceable></literal>.
  </para>
  </listitem>
  </itemizedlist>
  </listitem>
  <listitem>
  <para>
- <literal>while quilt push; do quilt refresh; done</literal> to apply all
+ <literal>while dquilt push; do dquilt refresh; done</literal> to apply all
  patches while removing <emphasis>fuzz</emphasis>.
  </para>
  </listitem>
-Line 4703 
 If a patch you applied to the source was
+Line 4912 
 If a patch you applied to the source was
  <itemizedlist>
  <listitem>
  <para>
- <literal>quilt delete</literal> to remove it.
+ <literal>dquilt delete</literal> to remove it.
  </para>
  </listitem>
  </itemizedlist>
-Line 4716 
 upstream source,
+Line 4925 
 upstream source,
  <itemizedlist>
  <listitem>
  <para>
- <literal>quilt push -f</literal> to apply old patches while forcing rejects as
+ <literal>dquilt push -f</literal> to apply old patches while forcing rejects as
  <filename><replaceable>baz</replaceable>.rej</filename>.
  </para>
  </listitem>
-Line 4729 
 realize intended effect of
+Line 4938 
 realize intended effect of
  </listitem>
  <listitem>
  <para>
- <literal>quilt refresh</literal> to update the patch.
+ <literal>dquilt refresh</literal> to update the patch.
  </para>
  </listitem>
  </itemizedlist>
  </listitem>
  <listitem>
  <para>
- Continue back to <literal>while quilt push; do quilt refresh; done</literal>.
+ Continue back to <literal>while dquilt push; do dquilt refresh; done</literal>.
  </para>
  </listitem>
  </itemizedlist>
-Line 4760 
 $ wget http://example.org/<replaceable>f
+Line 4969 
 $ wget http://example.org/<replaceable>f
  $ cd <replaceable>foo</replaceable>-<replaceable>oldversion</replaceable>
  $ uupdate -v <replaceable>newversion</replaceable> ../<replaceable>foo</replaceable>-<replaceable>newversion</replaceable>.tar.gz
  $ cd ../<replaceable>foo</replaceable>-<replaceable>newversion</replaceable>
- $ while quilt push; do quilt refresh; done
+ $ while dquilt push; do dquilt refresh; done
  $ dch
  ... document changes made
  </screen>
  <para>
- If you set up a <filename>debian/watch</filename> file as described in <xref linkend="watch"/> , you can skip the <command>wget</command> command.  You
+ If you set up a <filename>debian/watch</filename> file as described in <xref linkend="watch"/>, you can skip the <command>wget</command> command.  You
  simply run <citerefentry> <refentrytitle>uscan</refentrytitle>
  <manvolnum>1</manvolnum> </citerefentry> in the
  <filename><replaceable>foo</replaceable>-<replaceable>oldversion</replaceable></filename>
-Line 4778 
 run the <command>uupdate</command> comma
+Line 4987 
 run the <command>uupdate</command> comma
  uupdate</literal> at the end of the URL.  </para> </footnote>
  </para>
  <para>
- You can release this updated source by repeating what you did in <xref linkend="completebuild"/> , <xref linkend="checkit"/> , and <xref linkend="upload"/> .
+ You can release this updated source by repeating what you did in <xref linkend="completebuild"/>, <xref linkend="checkit"/>, and <xref linkend="upload"/>.
  </para>
  </section>
  <section id="packagestyle"><title>Updating the packaging style</title>
-Line 4811 
 If you want to update the <filename>rule
+Line 5020 
 If you want to update the <filename>rule
  <filename>Makefile</filename> inclusion mechanism of the Common Debian Build
  System (<systemitem role="package">cdbs</systemitem>) to the
  <command>dh</command> syntax, see
- <ulink url="">cdbs-doc.pdf.gz</ulink> and understand its
+ <ulink url="&cdbs-doc;">cdbs-doc.pdf.gz</ulink> and understand its
  <literal>DEB_*</literal> configuration variables.  <footnote><para> In the
  <systemitem role="package">cdbs</systemitem> (0.4.74) package, there are some
  negative descriptions of the <filename>rules</filename> file created by the
-Line 4863 
 commands, remove such things and make it
+Line 5072 
 commands, remove such things and make it
  </listitem>
  </itemizedlist>
  <para>
- You need to do other tasks described in <xref linkend="newupstream"/> , too.
+ You need to do other tasks described in <xref linkend="newupstream"/>, too.
  </para>
  </section>
  <section id="reminders"><title>Reminders for updating packages</title>

 Legend:



Removed from v.8640
 


changed lines


 
Added in v.8718
 Legend:



Removed from v.8640
 


changed lines


 
Added in v.8718
-Removed from v.8640
+Added in v.8718

	ViewVC Help
Powered by ViewVC 1.1.5