/[ddp]/manuals/trunk/maint-guide/maint-guide.sgml

Diff of /manuals/trunk/maint-guide/maint-guide.sgml

Parent Directory | Revision Log | View Patch Patch

-revision 892 by joy,
Fri Nov 12 16:19:02 1999 UTC
+revision 893 by joy,
Fri Dec 24 14:58:14 1999 UTC
 Line 15
     </author>
    -->
-    <version>version 0.97, 27. September 1999.</version>
+    <version>version 0.98, 24. December 1999.</version>
     <copyright>
     <copyrightsummary>Copyright &copy; 1998, 1999 Josip Rodin.</copyrightsummary>
-    <p>This document may used under the terms of any fully DFSG compliant
+    <p>This document may used under the terms the GNU General Public License
-    license, preferably GNU General Public License version 2+.
+    version 2 or higher.
-    <p>With permission of their authors, I have used and modified portions
+    <p>This document was made using with these two documents as examples:
-    of these two documents:
     <p>Making a Debian Package (AKA the Debmake Manual), copyright &copy;
 Jaldhar Vyas <email/jaldhar@debian.org/.
-Line 56
+Line 55
    <sect id="needprogs">Programs you need for development
-   <p>Before you start anything, you should make sure that you properly install
+   <p>Before you start anything, you should make sure that you properly
-   some packages with <manref name="dpkg" section="8"> (ie. `dpkg -i package`,
+   install some additional packages with <manref name="dpkg" section="8">
-   or through some of the front-ends like dselect or apt).
+   (ie. `dpkg -i package`, or through some of the front-ends like dselect or
-   This document has been written while the 2.1 'slink' distribution was the
+   apt). Note that the list doesn't contain any packages marked `essential'
-   officially stable release of Debian, and the 2.2 'potato' was being
+   or `required' - we expect that you have those installed already.
-   created, thus the packages named here are mostly those from 'potato'.
+   <p>This document has been written while the 2.1 'slink' distribution
+   was the officially stable release of Debian, and the 2.2 'potato' was
+   being created, thus the packages named here are mostly those from
+   'potato'.
    <p>Following packages come with standard installation of Debian 2.1, so
    you probably have them (and additional packages they depend on) already.
-Line 83
+Line 86
    <item><em>file</em> - this handy program can determine what type a file is.
    (see <manref name="file" section="1">)
-   <item><em>fileutils</em> - the essential Linux utilities, like ls, chmod,
-   rm and others. (see `info --file /usr/info/fileutils.info.gz`)
    <item><em>gcc</em> - the GNU C compiler. Most Linux programs are written
    in C. However, if your program is written in some other programming
    language, like C++, Fortran, Pascal, you should get g++, g77, or gpc,
 Line 137
    is necessary for some parts of the build process. (see
    <manref name="fakeroot" section="1">)
-   <item><em>lintian</em> - this is a package checker, that can let you know
+   <item><em>lintian</em> - this is the Debian package checker, that can let
-   of any common mistakes after you build the package, and explain the
+   you know of any common mistakes after you build the package, and explain
-   errors found. (see <manref name="lintian" section="1">,
+   the errors found. (see <manref name="lintian" section="1">,
    /usr/share/doc/lintian/lintian.html/index.html)
    </list>
 Line 277
    <p>So the first thing to do is to find and download the original package.
    I presume that you already have the source file that you picked up at
-   the author's homepage. Linux sources usually come in tar/gzip format,
+   the author's homepage. Sources for free Linux programs usually come in
-   with extension .tar.gz or .tgz, and usually contain the subdirectory
+   tar/gzip format, with extension .tar.gz, and usually contain the
-   called program-version and all the sources in it. If your program's
+   subdirectory called program-version and all the sources in it. If your
-   source comes as some other sort of archive (for instance, the filename
+   program's source comes as some other sort of archive (for instance, the
-   ends in <TT>.Z</TT> or <TT>.zip</TT>), unpack it with appropriate tools,
+   filename ends in <TT>.Z</TT> or <TT>.zip</TT>), unpack it with appropriate
-   or ask on debian-mentors if you're not sure how to unpack it correctly
+   tools, or ask on debian-mentors if you're not sure how to unpack it
-   (hint: issue `file archive.extension`).
+   correctly (hint: issue `file archive.extension`).
    <p>As an example, I'll use program named 'gentoo', an X11 GTK+ file
    manager. Note that the program is already packaged, and has changed
    substantially from the version while this text was first written.
-   <p>Create subdirectory under /usr/local/src named as your program's name
+   <p>Create subdirectory under your home directory named 'debian' or 'deb'
-   (/usr/local/src/gentoo in this case). Place the downloaded archive in it,
+   or anything you find appropriate (or the program's name, ~/gentoo would
-   and uncompress it with `tar -xzf gentoo-0.9.12.tar.gz`. That (somewhat
+   do fine in this case). Place the downloaded archive in it, and uncompress
-   lengthy) process will make no output (except if there are any errors -
+   it (with `tar xzf gentoo-0.9.12.tar.gz`). Make sure there are no errors
-   then you must download it again or check if it is really a tar/gzip
+   even some `unimportant' ones, because there will most probably be problems
-   archive), but you will get the sources unpacked in a subdirectory called
+   unpacking on other people's systems, whose unpacking tools may or may not
-   'gentoo-0.9.12' in /usr/local/src/gentoo.
+   ignore those errors.
-   <p>Change to that directory and <strong>thoroughly</strong> read the
+   <p>Now you have another subdirectory, called 'gentoo-0.9.12'. Change to
-   provided documentation. It is usually in files named README*, INSTALL*,
+   that directory and <strong>thoroughly</strong> read the provided
-   *.lsm or *.html. In there you will find instructions on how to correctly
+   documentation. Usually there exist files named README*, INSTALL*, *.lsm
-   compile and install the program (most probably to /usr/local/bin directory).
+   or *.html. You must find instructions on how to correctly compile and
+   install the program (most probably they'll assume you want to install to
+   /usr/local/bin directory; you won't be doing that, but more on that later).
    <p>The process varies from program to program, but a lot of modern
    programs come with a `configure' script that configures the source under
-Line 338
+Line 340
    <p>Make sure you're in the program source directory, and issue this:
    <p><example>
-   dh_make -e your.maintainer@address
+   dh_make -e your.maintainer@address -f gentoo-0.9.12.tar.gz
    </example>
    <p>Of course, replace the string "your.maintainer@address" with your
-   e-mail address for inclusion in the changelog entry and other files.
+   e-mail address for inclusion in the changelog entry and other files,
+   and the filename with the name of your original source archive. See
+   <manref name="dh_make" section="1"> for details.
    <p>Some information will come up. It will ask you what sort of package you
    want to create. Gentoo is a single binary package - it creates only one
    binary, and thus one .deb file - so we will select the first option, with
    the 's' key, check the information on the screen and confirm with pressing
    &lt;enter&gt;. As a new maintainer you are discouraged to create
-   multi-binary packages, or the libraries, as explained earlier.
+   multi-binary packages, or the libraries, as explained earlier. It's not
+   that hard, but it requires a bit more knowledge so we won't describe all
+   of it here.
    <p>Please note that you should run dh_make <strong>only once</strong>,
    and that it won't behave correctly if you run it again in the same,
-Line 359
+Line 365
    <chapt id="modify">Modifying the source
-   <p>When dh_make is finished, and you adjusted the program's own Makefile,
+   <p>Normally, programs install themselves in the /usr/local subdirectories.
-   you can `cd ..` to see a new directory that has been created, and it is
-   called 'gentoo-0.9.12.orig'. It contains the original source code which
-   will hereafter remain untouched. The 'gentoo-0.9.12' directory still
-   exists, and there you will make changes.
-   <p>Normally, programs install themselves in the /usr/local subdirectories.
    But, Debian packages must not use that directory, since it is reserved for
-   system administrator's (or user's) private use. This means that you have to
+   system administrator's (or user's) private use. This means that you have
-   take a look at gentoo's Makefile. This is the script <manref name="make" section="1">
+   to take a look at your program's build system, usually starting with the
-   will use to automate building this program. For more details on Makefiles,
+   Makefile. This is the script <manref name="make" section="1"> will use to
-   look in <ref id="rules">.
+   automate building this program. For more details on Makefiles, look in
+   <ref id="rules">.
    <p>Note that there isn't space here to go into <em>all</em> the details
    of fixing but here are a few problems you often run across.
-Line 491
+Line 492
    <sect id="nolibs">Differing libraries
    <p>There is one other common problem: libraries are often different from
-   platform to platform. For example, Makefile can contain a reference to
+   platform to platform. For example, Makefile can contain a reference to a
-   a library which doesn't exist on Debian. In that case, we need to change
+   library which doesn't exist on Debian, or even Linux. In that case, we
-   it to a library which does exist in Debian, and serves the same purpose.
+   need to change it to a library which does exist in Debian, and serves the
-   The best way is to comment out (<em>not to delete!</em>) those lines
+   same purpose. The best way is to comment out those lines because there may
-   because there may be others that will try to compile on different platforms
+   be others that will try to compile on different platforms so that they can
-   so that they can have some hints about what could be the problem.
+   have some hints about what could be the problem.
    <p>So, if there is a line in your program's Makefile that says something
    like this (and your program doesn't compile):
-Line 511
+Line 512
    #LIBS = -lcurses -lsomething -lsomethingelse
    </example>
-   <chapt id="crules">The debian/control and debian/rules file
+   <chapt id="crules">Required stuff under debian/
-   <p>There is a new subdirectory in gentoo-0.9.12, it is called 'debian'.
+   <p>There is a new subdirectory under the program's main directory
-   There are a number of files in this directory. We will be editing these
+   (`gentoo-0.9.12'), it is called `debian'. There are a number of files
-   in order to customize the behavior of the package. The most important of
+   in this directory. We will be editing these in order to customize
-   them are 'control' and 'rules'.
+   the behavior of the package. The most important of them are `control',
+   `changelog', `copyright' and 'rules', which are required for all packages.
-   <sect id="control">the `control' file
+   <sect id="control">`control' file
    <p>This file contains various values which dpkg and dselect will use to
    manage the package. Here is the control file dh_make creates for us.
-   <p><example>1  Source: gentoo
+   <p><example>
+ Source: gentoo
  Section: unknown
  Priority: optional
  Maintainer: Josip Rodin &lt;jrodin@jagor.srce.hr&gt;
-Line 614
+Line 617
    <item>Conflicts:
    <p>The package will not be installed until all the packages it conflicts
-   with have been removed.</item>
+   with have been removed. Use this if your program absolutely will not run
+   (or will cause severe breakage) if a particular package is present.</item>
    <item>Provides:
    <p>For some types of packages where there are multiple alternatives
-Line 641
+Line 645
    <tt>&gt;&gt;</tt> for strictly earlier, earlier or equal, exactly equal,
    later or equal and strictly later, respectively.
-   <p>The last feature I want to show you is $(shlibs:Depends). This will be
+   <p>The last feature you need to know about is $(shlibs:Depends). This will
-   automatically filled in by <manref name="dh_shlibdeps" section="1"> (see
+   be automatically generated by <manref name="dh_shlibdeps" section="1"> and
-   later) with the names of any shared libraries, such as libc6 or xlib6g,
+   filled in by <manref name="dh_gencontrol" section="1"> with the names of
-   your program uses, so you don't have to specify them yourself. Having said
+   any shared libraries your program uses, such as libc6 or xlib6g, so you
-   all that, we can leave line 9 exactly as it is now.
+   don't have to specify them yourself. Having said all that, we can leave
+   line 9 exactly as it is now.
    <p>Line 10 is where the list of suggestions go. Here it's only 'file',
    because can use some features provided by that program/package.
-Line 686
+Line 691
    </example>
    (I've added the line numbers.)
-   <sect id="rules">the `rules' file
+   <sect id="copyright">`copyright' file
-   <p>Now we go back to the 'debian' directory to take a look at rules which
-   <manref name="dpkg-buildpackage" section="1"> will use to actually create
-   the package. This file is actually another Makefile, since it is executed
-   with 'make -f', but different than the one in the upstream source.
-   <p>Every 'rules' file, as any other Makefile, consists of several rules
-   of how to build the source. Rules consist of targets, filenames or names
-   of actions that should be carried out (for example, 'build:' or 'install:').
-   Rules that you want to execute you should call as the command line arguments
-   (for example, 'rules build' or 'rules install'). After the target name,
-   you can name the dependency, program or file that that rule depends on.
-   After that there can be any number of commands (starting with &lt;tab&gt;!),
-   until an empty line is found. There begins another rule. Comments begin
-   with hashes ('#'), and end with end of the line. You can invoke rules
-   either from other rules or from command line (ie. `debian/rules clean`).
-   <p>You are probably confused now, but it will all be clear upon examination
-   of the 'rules' file that dh_make gives us as a default. You should also
-   read the 'make' entry in info for more information.
-   <p><example>
- #!/usr/bin/make -f
- # Made with the aid of dh_make, by Craig Small
- # Sample debian/rules that uses debhelper. GNU copyright 1997 by Joey Hess.
- # Some lines taken from debmake, by Christoph Lameter.
- # Uncomment this to turn on verbose mode.
- #export DH_VERBOSE=1
- build: build-stamp
-build-stamp:
-   dh_testdir
-   # Add here commands to compile the package.
-   $(MAKE)
-   touch build-stamp
-clean:
-   dh_testdir
-   dh_testroot
-   rm -f build-stamp install-stamp
-   # Add here commands to clean up after the build process.
-   -$(MAKE) clean
-   dh_clean
-install: install-stamp
-install-stamp: build-stamp
-   dh_testdir
-   dh_testroot
-   dh_clean -k
-   dh_installdirs
-   # Add here commands to install the package into debian/tmp.
-   $(MAKE) install DESTDIR=`pwd`/debian/tmp
-   touch install-stamp
-# Build architecture-independent files here.
-binary-indep: build install
-# We have nothing to do by default.
-# Build architecture-dependent files here.
-binary-arch: build install
-#  dh_testversion
-   dh_testdir
-   dh_testroot
-   dh_installdocs
-   dh_installexamples
-   dh_installmenu
-#  dh_installemacsen
-#  dh_installinit
-   dh_installcron
-   dh_installmanpages
-#  dh_undocumented
-   dh_installchangelogs
-   dh_strip
-   dh_compress
-   dh_fixperms
-   dh_suidregister
-   dh_installdeb
-   dh_shlibdeps
-   dh_gencontrol
-#  dh_makeshlibs
-   dh_md5sums
-   dh_builddeb
-source diff:
-   @echo >&2 'source and diff are obsolete - use dpkg-source -b'; false
-binary: binary-indep binary-arch
-.PHONY: build clean binary-indep binary-arch binary
-   </example>
-   (I've added the line numbers.)
-   <p>You are probably familiar with lines like line 1 from shell and perl
-   scripts. It means this file is to be run through make. Empty lines are
-   ignored. Lines beginning with '#' (hash) are treated as comments and also
-   ignored.
-   <p>Lines 9 through 17 describe the 'build' (and its child build-stamp)
-   rule which runs the applications own Makefile to compile the program.
-   <p>Things rarely work perfectly the first time so the 'clean' rule
-   specified in lines 18-26 clean up any unneeded junk left over from
-   previous failed attempts.
-   <p>The installation process, the 'install' rule, starts with line 29.
-   On line 34, all necessary directories are created in the 'debian'
-   directory. Line 37 runs the install target from gentoo's Makefile - and
-   installs in the debian/tmp directory - this is why we specified
-   $(DESTDIR) as the root installation directory in gentoo's Makefile.
-   <p>As the comments suggest, 'binary-indep' rule on lines 41-43 is used
-   to build architecture independent packages, but we don't have any.
-   <p>Next is 'binary-arch' rule, on lines 46 through 68, in which we run
-   several small utilities from the debhelper package that do various
-   operations on your package to make it conform to Debian policy.
-   <p>The names start with dh_ and after that you can see what every little
-   utility really does:
-   <list>
-   <item><manref name="dh_testdir" section="1"> check that you are in the
-   right directory (/usr/local/src/gentoo/gentoo-0.9.12/),
-   <item><manref name="dh_testroot" section="1"> checks that you have root
-   permissions,
-   <item><manref name="dh_installdirs" section="1"> creates directories
-   mentioned in 'dirs' file [doesn't exist here],
-   <item><manref name="dh_installdocs" section="1"> copies documentation to
-   debian/tmp/usr/share/doc/gentoo directory,
-   <item><manref name="dh_installmenu" section="1"> copies menu file to
-   debian/tmp/usr/lib/menu/gentoo,
-   <item><manref name="dh_installmanpages" section="1"> copies manpages and
-   links them correctly,
-   <item><manref name="dh_installchangelogs" section="1"> copies changelogs
-   to debian/tmp/usr/share/doc/gentoo directory,
-   <item><manref name="dh_installinit" section="1"> copies init.d script
-   [doesn't exist here],
-   <item><manref name="dh_installcron" section="1"> copies crontab script to
-   debian/tmp/etc/cron.* [doesn't exist here],
-   <item><manref name="dh_installexamples" section="1"> copies example files
-   to debian/tmp/usr/share/doc/gentoo/examples [doesn't exist here],
-   <item><manref name="dh_strip" section="1"> strips debugging headers from
-   executable files to make them smaller,
-   <item><manref name="dh_compress" section="1"> gzips man pages and
-   documentation larger than 4 kb,
-   <item><manref name="dh_fixperms" section="1"> checks and fixes invalid
-   permissions in debian/tmp directory,
-   <item><manref name="dh_suidregister" section="1"> sets up files to register
-   setuid executables with <manref name="suidregister" section="8"> [doesn't exist here],
-   <item><manref name="dh_installdeb" section="1"> copies package related
-   files under debian/tmp directory,
-   <item><manref name="dh_shlibdeps" section="1"> calculates dependencies
-   of the executables,
-   <item><manref name="dh_gencontrol" section="1"> generates and installs
-   the control file,
-   <item><manref name="dh_makeshlibs" section="1"> generates shared libs
-   dependencies file [doesn't exist here],
-   <item><manref name="dh_md5sums" section="1"> generates MD5 checksums, and
-   finally,
-   <item><manref name="dh_builddeb" section="1"> finally builds the package.
-   </list>
-   <p>Every one of these dh_* scripts has its own man page, for more
-   information please read it. There are other dh_* scripts not mentioned
-   here, and if you might need them, read the debhelper documentation.
-   <p>Lines 70-74 are just some necessities on which you can read in the
-   make manual. For now, they're not important to know about.
-   <p>The important part to know about the rules file created by dh_make is
-   that it is just a suggestion. It will work for simple packages but for
-   more complicated ones, don't be afraid to add and subtract from it to fit
-   your needs. This especially applies to the binary-arch sections, where
-   you should comment out lines that call features you don't need, in this
-   case I'll comment out lines 47, 53, 54, 57 and 66 because gentoo doesn't
-   need them. Only thing that you must not change are the names of the rules,
-   because they are needed to be named this way because all the tools use
-   these names, mandated by our Packaging manual.
-   <p>Of course, some tuning is required here: on the line 58 I'll add
-   'FIXES' because that is the name of the changelog file. For any other
-   option, please read the man page of dh_* program involved.
-   <chapt id="dother">Other files in debian/ dir
-   <sect id="copyright">copyright
    <p>This file contains the package's copyright information. It's format
    is not dictated by the Policy, but the contents is (section 6.5).
-Line 925
+Line 737
    </example>
    (I've added the line numbers.)
-   <sect id="readdeb">README.Debian
+   <sect id="changelog">`changelog' file
-   <p>Any extra details or discrepancies between the original package and
-   your debianized version should be documented here. Dh_make created
-   a default one, this is what it looks like:
-   <example>
-   gentoo for Debian
-   ----------------------
-   &lt;possible notes regarding this package - if none, delete this file&gt;
-   Josip Rodin &lt;jrodin@jagor.srce.hr&gt;, Wed, 11 Nov 1998 21:02:14 +0100
-   </example>
-   <p>Since we don't have anything to put there - it is allowed to delete
-   the file.
-   <sect id="changelog">changelog
    <p>This is a required file, which has a special format described in
    the Packaging Manual (section 3.2.3). This format is used by dpkg and
-Line 1029
+Line 823
    </example>
    (I've added the line numbers.)
+   <sect id="rules">`rules' file
+   <p>Now we need to go back to the 'debian' directory to take a look at rules
+   which <manref name="dpkg-buildpackage" section="1"> will use to actually
+   create the package. This file is actually another Makefile, since it is
+   executed with 'make -f', but different than the one in the upstream source.
+   <p>Every 'rules' file, as any other Makefile, consists of several rules
+   of how to build the source. Rules consist of targets, filenames or names
+   of actions that should be carried out (for example, 'build:' or 'install:').
+   Rules that you want to execute you should call as the command line arguments
+   (for example, 'rules build' or 'rules install'). After the target name,
+   you can name the dependency, program or file that that rule depends on.
+   After that there can be any number of commands (starting with &lt;tab&gt;!),
+   until an empty line is found. There begins another rule. Comments begin
+   with hashes ('#'), and end with end of the line. You can invoke rules
+   either from other rules or from command line (ie. `debian/rules clean`).
+   <p>You are probably confused now, but it will all be clear upon examination
+   of the 'rules' file that dh_make gives us as a default. You should also
+   read the 'make' entry in info for more information.
+   <p>The important part to know about the rules file created by dh_make, is
+   that it is just a suggestion. It will work for simple packages but for
+   more complicated ones, don't be afraid to add and subtract from it to fit
+   your needs. Only thing that you must not change are the names of the
+   rules, because they are needed to be named this way because all the tools
+   use these names, mandated by our Packaging manual.
+   <p><example>
+ #!/usr/bin/make -f
+ # Made with the aid of dh_make, by Craig Small
+ # Sample debian/rules that uses debhelper. GNU copyright 1997 by Joey Hess.
+ # Some lines taken from debmake, by Christoph Lameter.
+ # Uncomment this to turn on verbose mode.
+ #export DH_VERBOSE=1
+ # This is the debhelper compatability version to use.
+export DH_COMPAT=1
+build: build-stamp
+build-stamp:
+   dh_testdir
+   # Add here commands to compile the package.
+   $(MAKE)
+   touch build-stamp
+clean:
+   dh_testdir
+   dh_testroot
+   rm -f build-stamp
+   # Add here commands to clean up after the build process.
+   -$(MAKE) clean
+   dh_clean
+install: build-stamp
+   dh_testdir
+   dh_testroot
+   dh_clean -k
+   dh_installdirs
+   # Add here commands to install the package into debian/tmp.
+   $(MAKE) install DESTDIR=`pwd`/debian/tmp
+# Build architecture-independent files here.
+binary-indep: build install
+# We have nothing to do by default.
+# Build architecture-dependent files here.
+binary-arch: build install
+#  dh_testversion
+   dh_testdir
+   dh_testroot
+#  dh_installdebconf
+   dh_installdocs
+   dh_installexamples
+   dh_installmenu
+#  dh_installemacsen
+#  dh_installpam
+#  dh_installinit
+   dh_installcron
+   dh_installmanpages
+   dh_installinfo
+#  dh_undocumented
+   dh_installchangelogs
+   dh_link
+   dh_strip
+   dh_compress
+   dh_fixperms
+   # You may want to make some executables suid here.
+   dh_suidregister
+#  dh_makeshlibs
+   dh_installdeb
+#  dh_perl
+   dh_shlibdeps
+   dh_gencontrol
+   dh_md5sums
+   dh_builddeb
+binary: binary-indep binary-arch
+.PHONY: build clean binary-indep binary-arch binary install
+   </example>
+   (I've added the line numbers.)
+   <p>You are probably familiar with lines like line 1 from shell and perl
+   scripts. It means this file is to be run through make. Empty lines, and
+   lines beginning with `#' (hash) are ignored.
+   <p>Lines 12 through 19 describe the 'build' (and its child build-stamp)
+   rule, which runs the applications own Makefile to compile the program.
+   <p>The 'clean' rule, as specified in lines 21-29, cleans up any unneeded
+   binary or auto-generated stuff, left over from building the package.
+   This rule must be working at all times (even when the source tree <em/is/
+   cleaned up!), so please use the forcing options (e.g. for rm, that is
+   `-f'), or ignore return values (with a `-' in front of a command name).
+   <p>The installation process, the 'install' rule, starts with line 31.
+   It basically runs the install rule from the program's main Makefile,
+   but installs in `pwd`/debian/tmp directory - this is why we specified
+   $(DESTDIR) as the root installation directory in gentoo's Makefile.
+   <p>As the comments suggest, 'binary-indep' rule, on the line 41, is used
+   to build architecture independent packages. As we don't have any, nothing
+   will be done there.
+   <p>Next is 'binary-arch' rule, on lines 45 through 73, in which we run
+   several small utilities from the debhelper package that do various
+   operations on your package files to make them all conform to the Policy.
+   <p>The names start with dh_, and the rest is the description of what the
+   particular utility really does. It is all quite self-explanatory, but
+   here are some additional explanations:
+   <list>
+   <item><manref name="dh_testdir" section="1"> checks that you are in the
+         right directory (i.e. the top-level source directory),
+   <item><manref name="dh_testroot" section="1"> checks that you have root
+         permissions which is needed for binary* targets, and clean,
+   <item><manref name="dh_installmanpages" section="1"> copies all the
+         manpages it can find in the source tree to package (beware, this is
+         DWIM),
+   <item><manref name="dh_strip" section="1"> strips debugging headers from
+         executable files and libraries, to make them smaller,
+   <item><manref name="dh_compress" section="1"> gzips man pages and
+         documentation larger than 4 kb,
+   <item><manref name="dh_installdeb" section="1"> copies package related
+         files (e.g. the maintainer scripts) under debian/tmp/DEBIAN directory,
+   <item><manref name="dh_shlibdeps" section="1"> calculates shared libraries
+         dependencies of the libraries and executables,
+   <item><manref name="dh_gencontrol" section="1"> adds stuff to, and
+         installs, the control file,
+   <item><manref name="dh_md5sums" section="1"> generates MD5 checksums for
+         all the files in the package.
+   </list>
+   <p>For more complete information on what do all these dh_* scripts do, and
+   what are their other options, please read respective manual pages. There
+   are some other, possibly very useful, dh_* scripts, which were not
+   mentioned here. If you need them, read the debhelper documentation.
+   <p>The binary-arch section is the one where you really should comment out
+   lines that call features you don't need. For gentoo, I'll comment out
+   lines about testversion, emacsen, pam, init, cron, manpages, info,
+   undocumented, suidregister, makeshlibs, and perl, simply because gentoo
+   doesn't need them. Also, on the line 60, I'll need to add ' FIXES', because
+   that is the name of the upstream changelog file.
+   <p>The last two lines (along with any other not explained ones) are just
+   some more-or-less neccessary things, regarding which you can read in the
+   make manual, and the packaging manual. For now, they're not important to
+   know about.
+   <chapt id="dother">Other files under debian/
+   <p>You will see that there exist several other files in the debian/
+   subdirectory, most of them with the `.ex' suffix, meaning that they are
+   examples. If you wish or need to use any of those features, examine them
+   and the related documentation (hint: the Policy Manual), rename them to
+   remove the `.ex' suffix, and modify them and the rules file if neccessary.
+   Some of those files, those commonly used ones, are explained in the
+   following sections.
+   <sect id="readdeb">README.Debian
+   <p>Any extra details or discrepancies between the original package and
+   your debianized version should be documented here. Dh_make created
+   a default one, this is what it looks like:
+   <example>
+   gentoo for Debian
+   ----------------------
+   &lt;possible notes regarding this package - if none, delete this file&gt;
+   Josip Rodin &lt;jrodin@jagor.srce.hr&gt;, Wed, 11 Nov 1998 21:02:14 +0100
+   </example>
+   <p>Since we don't have anything to put there - it is allowed to delete
+   the file.
    <sect id="conffiles">conffiles
    <p>One of the most annoying things about software is when you spend a
-Line 1154
+Line 1155
    <sect id="build">Building the package
-   <p>Enter the program's main directory (/usr/local/src/gentoo/gentoo-0.9.12/)
+   <p>Enter the program's main directory and then issue this command:
-   and then issue this command:
    <p><example>
    dpkg-buildpackage -rfakeroot
 Line 1163
    <p>This will do everything for you, you'll just have to enter your
    PGP secret key, twice. After it's done, you will see four new files
-   in /usr/local/src/gentoo directory:
+   in the directory above (~/debian/):
    <p><list>
    <item><em>gentoo_0.9.12-1_i386.deb</em>
 Line 1263
    <manref name="dupload.conf" section="5"> manual page to understand
    what does each of these options mean.
-   <p>Then connect to your Internet provider, make sure once again that
+   <p>Then connect to your Internet provider, and issue this command:
-   you are in /usr/local/src/gentoo directory, and issue this command:
    <p><example>
    dupload --to master gentoo_0.9.12-1_i386.changes

 Legend:



Removed from v.892
 


changed lines


 
Added in v.893
 Legend:



Removed from v.892
 


changed lines


 
Added in v.893
-Removed from v.892
+Added in v.893

	ViewVC Help
Powered by ViewVC 1.1.5