chiark / gitweb /
Mention collab-maint in the VCS section. Closes: #496815
[developers-reference.git] / tools.dbk
index a9b4b816da0f35085f559c3529edcfbd3dfcda43..ba8a8463e4b695e3f675c969d0f219788ef6064b 100644 (file)
--- a/tools.dbk
+++ b/tools.dbk
@@ -26,7 +26,7 @@ exclusion of a competing tool.
 Most of the descriptions of these packages come from the actual package
 descriptions themselves.  Further information can be found in the package
 documentation itself.  You can also see more info with the command
-<command>apt-cache show &lt;package-name&gt;</command>.
+<command>apt-cache show <replaceable>package-name</replaceable></command>.
 </para>
 <section id="tools-core">
 <title>Core tools</title>
@@ -58,7 +58,7 @@ role="package">debconf-doc</systemitem> package.
 </para>
 <para>
 Many feel that this system should be used for all packages which require
-interactive configuration; see <xref linkend="bpp-config-mgmt"/> .  <systemitem
+interactive configuration; see <xref linkend="bpp-config-mgmt"/>.  <systemitem
 role="package">debconf</systemitem> is not currently required by Debian Policy,
 but that may change in the future.
 </para>
@@ -70,8 +70,8 @@ but that may change in the future.
 <systemitem role="package">fakeroot</systemitem> simulates root privileges.
 This enables you to build packages without being root (packages usually want to
 install files with root ownership).  If you have <systemitem
-role="package">fakeroot</systemitem> installed, you can build packages as a
-regular user: <literal>dpkg-buildpackage -rfakeroot</literal>.
+role="package">fakeroot</systemitem> installed,
+<command>dpkg-buildpackage</command> will use it automatically.
 </para>
 </section>
 
@@ -113,10 +113,10 @@ latest <command>lintian</command> output for the whole development distribution
 </section>
 
 <section id="debdiff">
-<title><systemitem role="package">debdiff</systemitem></title>
+<title><command>debdiff</command></title>
 <para>
 <command>debdiff</command> (from the <systemitem
-role="package">devscripts</systemitem> package, <xref linkend="devscripts"/> )
+role="package">devscripts</systemitem> package, <xref linkend="devscripts"/>)
 compares file lists and control files of two packages.  It is a simple
 regression test, as it will help you notice if the number of binary packages
 has changed since the last upload, or if something has changed in the control
@@ -175,27 +175,6 @@ them by doing <literal>apt-cache search ^dh-</literal>.
 </para>
 </section>
 
-<section id="debmake">
-<title><systemitem role="package">debmake</systemitem></title>
-<para>
-<systemitem role="package">debmake</systemitem>, a precursor to <systemitem
-role="package">debhelper</systemitem>, is a more coarse-grained
-<filename>debian/rules</filename> assistant.  It includes two main programs:
-<command>deb-make</command>, which can be used to help a maintainer convert a
-regular (non-Debian) source archive into a Debian source package; and
-<command>debstd</command>, which incorporates in one big shot the same sort of
-automated functions that one finds in <systemitem
-role="package">debhelper</systemitem>.
-</para>
-<para>
-The consensus is that <systemitem role="package">debmake</systemitem> is now
-deprecated in favor of <systemitem role="package">debhelper</systemitem>.  It
-is a bug to use <systemitem role="package">debmake</systemitem> in new
-packages.  New packages using <systemitem role="package">debmake</systemitem>
-will be rejected from the archive.
-</para>
-</section>
-
 <section id="dh-make">
 <title><systemitem role="package">dh-make</systemitem></title>
 <para>
@@ -203,7 +182,7 @@ The <systemitem role="package">dh-make</systemitem> package contains
 <command>dh_make</command>, a program that creates a skeleton of files
 necessary to build a Debian package out of a source tree.  As the name
 suggests, <command>dh_make</command> is a rewrite of <systemitem
-role="package">debmake</systemitem> and its template files use dh_* programs
+role="package">debmake</systemitem> and its template files use <command>dh_*</command> programs
 from <systemitem role="package">debhelper</systemitem>.
 </para>
 <para>
@@ -214,24 +193,6 @@ the package entirely functional and Policy-compliant.
 </para>
 </section>
 
-<section id="yada">
-<title><systemitem role="package">yada</systemitem></title>
-<para>
-<systemitem role="package">yada</systemitem> is another packaging helper tool.
-It uses a <filename>debian/packages</filename> file to auto-generate
-<filename>debian/rules</filename> and other necessary files in the
-<filename>debian/</filename> subdirectory.  The
-<filename>debian/packages</filename> file contains instruction to build
-packages and there is no need to create any <filename>Makefile</filename>
-files.  There is possibility to use macro engine similar to the one used in
-SPECS files from RPM source packages.
-</para>
-<para>
-For more informations see <literal><ulink
-url="http://yada.alioth.debian.org/">YADA site</ulink></literal>.
-</para>
-</section>
-
 <section id="equivs">
 <title><systemitem role="package">equivs</systemitem></title>
 <para>
@@ -251,17 +212,17 @@ packages.
 The following packages help with the package building process, general driving
 <command>dpkg-buildpackage</command> as well as handling supporting tasks.
 </para>
-<section id="cvs-buildpackage">
-<title><systemitem role="package">cvs-buildpackage</systemitem></title>
+<section id="git-buildpackage">
+<title><systemitem role="package">git-buildpackage</systemitem></title>
 <para>
-<systemitem role="package">cvs-buildpackage</systemitem> provides the
-capability to inject or import Debian source packages into a CVS repository,
-build a Debian package from the CVS repository, and helps in integrating
+<systemitem role="package">git-buildpackage</systemitem> provides the
+capability to inject or import Debian source packages into a Git repository,
+build a Debian package from the Git repository, and helps in integrating
 upstream changes into the repository.
 </para>
 <para>
-These utilities provide an infrastructure to facilitate the use of CVS by
-Debian maintainers.  This allows one to keep separate CVS branches of a package
+These utilities provide an infrastructure to facilitate the use of Git by
+Debian maintainers.  This allows one to keep separate Git branches of a package
 for <literal>stable</literal>, <literal>unstable</literal> and possibly
 <literal>experimental</literal> distributions, along with the other benefits
 of a version control system.
@@ -293,9 +254,8 @@ package's build-dependencies are correct, and to be sure that unnecessary and
 wrong build dependencies will not exist in the resulting package.
 </para>
 <para>
-A related package is <systemitem role="package">pbuilder-uml</systemitem>,
-which goes even further by doing the build within a User Mode Linux
-environment.
+A related package is <systemitem role="package">cowbuilder</systemitem>,
+which speeds up the build process using COW filesystem on any standard Linux filesystem.
 </para>
 </section>
 
@@ -342,10 +302,10 @@ signature and checksums before uploading, and the possibility of running
 </section>
 
 <section id="dcut">
-<title><systemitem role="package">dcut</systemitem></title>
+<title><command>dcut</command></title>
 <para>
-The <systemitem role="package">dcut</systemitem> script (part of the package
-<xref linkend="dput"/> ) helps in removing files from the ftp upload directory.
+The <command>dcut</command> script (part of the package <systemitem role="package">dput</systemitem>,
+<xref linkend="dput"/>) helps in removing files from the ftp upload directory.
 </para>
 </section>
 
@@ -416,14 +376,6 @@ and Slackware packages.
 </para>
 </section>
 
-<section id="debsums">
-<title><systemitem role="package">debsums</systemitem></title>
-<para>
-<command>debsums</command> checks installed packages against their MD5 sums.
-Note that not all packages have MD5 sums, since they aren't required by Policy.
-</para>
-</section>
-
 <section id="dpkg-dev-el">
 <title><systemitem role="package">dpkg-dev-el</systemitem></title>
 <para>
@@ -436,10 +388,10 @@ latest entry in a <filename>debian/changelog</filename> file.
 </section>
 
 <section id="dpkg-depcheck">
-<title><systemitem role="package">dpkg-depcheck</systemitem></title>
+<title><command>dpkg-depcheck</command></title>
 <para>
 <command>dpkg-depcheck</command> (from the <systemitem
-role="package">devscripts</systemitem> package, <xref linkend="devscripts"/> )
+role="package">devscripts</systemitem> package, <xref linkend="devscripts"/>)
 runs a command under <command>strace</command> to determine all the packages
 that were used by the said command.
 </para>
@@ -454,7 +406,9 @@ dpkg-depcheck -b debian/rules build
 </screen>
 <para>
 <command>dpkg-depcheck</command> can also be used to check for run-time
-dependencies, especially if your package uses exec(2) to run other programs.
+dependencies, especially if your package uses <citerefentry>
+<refentrytitle>exec</refentrytitle> <manvolnum>2</manvolnum> </citerefentry>
+to run other programs.
 </para>
 <para>
 For more information please see <citerefentry>