CINXE.COM

<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Guide for Debian Maintainers</title> <link rel="stylesheet" type="text/css" href="debian.css"/> <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"/> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <link rel="home" href="index.en.html" title="Guide for Debian Maintainers"/> <link rel="next" href="ch01.en.html" title="Chapter 1. Preface"/> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">Guide for Debian Maintainers</th> </tr> <tr> <td align="left"> </td> <th width="60%" align="center"> </th> <td align="right"> <a accesskey="n" href="ch01.en.html"><img src="images/next.png" alt="Next"/></a></td> </tr> </table> <hr/> </div> <div xml:lang="en" class="book"><div class="titlepage"><div><div><h1 class="title"><a id="idp1"/>Guide for Debian Maintainers</h1></div><div><div class="authorgroup"> <div class="author"><h3 class="author">Osamu Aoki</h3><code class="email"><<a class="email" href="mailto:osamu@debian.org">osamu@debian.org</a>></code></div> </div></div><div>Copyright © 2014-2024 Osamu Aoki</div><div><div class="legalnotice"><a id="idp3"/> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. This guide was made using the following previous documents as its reference: <div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"> “Making a Debian Package (AKA the Debmake Manual)”, copyright © 1997 Jaldhar Vyas. </li><li class="listitem"> “The New-Maintainer’s Debian Packaging Howto”, copyright © 1997 Will Lowe. </li><li class="listitem"> “Debian New Maintainers’ Guide”, copyright © 1998-2002 Josip Rodin, 2005-2017 Osamu Aoki, 2010 Craig Small, and 2010 Raphaël Hertzog. </li></ul></div> The latest version of this guide should be available: <div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"> in the <a class="ulink" href="https://tracker.debian.org/pkg/debmake-doc">debmake-doc package</a> and </li><li class="listitem"> at the <a class="ulink" href="https://www.debian.org/doc/devel-manuals">Debian Documentation web site</a>. </li></ul></div> </div></div><div><div class="abstract">Abstract This “Guide for Debian Maintainers” (2024-10-01) tutorial guide describes the building of the Debian package to ordinary Debian users and prospective developers using the debmake command. This guide focuses on the modern packaging style and comes with many simple examples. <div class="itemizedlist"><ul class="itemizedlist"><li class="listitem"> POSIX shell script packaging </li><li class="listitem"> Python3 script packaging </li><li class="listitem"> C with Makefile/Autotools/CMake </li><li class="listitem"> multiple binary packages with shared library etc. </li></ul></div> This “Guide for Debian Maintainers” can be considered as the successor to the “Debian New Maintainers’ Guide”. </div></div></div><hr/></div><div class="toc">Table of Contents<dl class="toc"><dt><a href="ch01.en.html">1. Preface</a></dt><dt><a href="ch02.en.html">2. Overview</a></dt><dt><a href="ch03.en.html">3. Prerequisites</a></dt><dd><dl><dt><a href="ch03.en.html#people">3.1. People around Debian</a></dt><dt><a href="ch03.en.html#contribute">3.2. How to contribute</a></dt><dt><a href="ch03.en.html#social">3.3. Social dynamics of Debian</a></dt><dt><a href="ch03.en.html#reminders">3.4. Technical reminders</a></dt><dt><a href="ch03.en.html#debian-doc">3.5. Debian documentation</a></dt><dt><a href="ch03.en.html#help">3.6. Help resources</a></dt><dt><a href="ch03.en.html#situation">3.7. Archive situation</a></dt><dt><a href="ch03.en.html#approaches">3.8. Contribution approaches</a></dt><dt><a href="ch03.en.html#novice">3.9. Novice contributor and maintainer</a></dt></dl></dd><dt><a href="ch04.en.html">4. Tool Setups</a></dt><dd><dl><dt><a href="ch04.en.html#email-setup">4.1. Email setup</a></dt><dt><a href="ch04.en.html#mc-setup">4.2. mc setup</a></dt><dt><a href="ch04.en.html#git-setup">4.3. git setup</a></dt><dt><a href="ch04.en.html#quilt-setup">4.4. quilt setup</a></dt><dt><a href="ch04.en.html#devscripts-setup">4.5. devscripts setup</a></dt><dt><a href="ch04.en.html#sbuild-setup">4.6. sbuild setup</a></dt><dt><a href="ch04.en.html#chroot-persistent">4.7. Persistent chroot setup</a></dt><dt><a href="ch04.en.html#gbp-setup">4.8. gbp setup</a></dt><dt><a href="ch04.en.html#proxy">4.9. HTTP proxy</a></dt><dt><a href="ch04.en.html#repropro">4.10. Private Debian repository</a></dt><dt><a href="ch04.en.html#vm">4.11. Virtual machines</a></dt><dt><a href="ch04.en.html#mDNS">4.12. Local network with virtual machines</a></dt></dl></dd><dt><a href="ch05.en.html">5. Simple packaging</a></dt><dd><dl><dt><a href="ch05.en.html#packaging-tarball">5.1. Packaging tarball</a></dt><dt><a href="ch05.en.html#big-picture">5.2. Big picture</a></dt><dt><a href="ch05.en.html#what-debmake">5.3. What is debmake?</a></dt><dt><a href="ch05.en.html#what-debuild">5.4. What is debuild?</a></dt><dt><a href="ch05.en.html#step-upstream">5.5. Step 1: Get the upstream source</a></dt><dt><a href="ch05.en.html#step-debmake">5.6. Step 2: Generate template files with debmake</a></dt><dt><a href="ch05.en.html#step-maintainer">5.7. Step 3: Modification to the template files</a></dt><dt><a href="ch05.en.html#step-debuild">5.8. Step 4: Building package with debuild</a></dt><dt><a href="ch05.en.html#alt-patch">5.9. Step 3 (alternatives): Modification to the upstream source</a></dt><dt><a href="ch05.en.html#diff-u-ap">5.10. Patch by “diff -u” approach</a></dt><dt><a href="ch05.en.html#dquilt-ap">5.11. Patch by dquilt approach</a></dt><dt><a href="ch05.en.html#auto-commit-ap">5.12. Patch by “dpkg-source --auto-commit” approach</a></dt></dl></dd><dt><a href="ch06.en.html">6. Basics for packaging</a></dt><dd><dl><dt><a href="ch06.en.html#workflow">6.1. Packaging workflow</a></dt><dt><a href="ch06.en.html#debhelper">6.2. debhelper package</a></dt><dt><a href="ch06.en.html#name-version">6.3. Package name and version</a></dt><dt><a href="ch06.en.html#native">6.4. Native Debian package</a></dt><dt><a href="ch06.en.html#rules">6.5. debian/rules file</a></dt><dt><a href="ch06.en.html#control">6.6. debian/control file</a></dt><dt><a href="ch06.en.html#changelog">6.7. debian/changelog file</a></dt><dt><a href="ch06.en.html#copyright">6.8. debian/copyright file</a></dt><dt><a href="ch06.en.html#patches">6.9. debian/patches/* files</a></dt><dt><a href="ch06.en.html#include-binaries">6.10. debian/source/include-binaries file</a></dt><dt><a href="ch06.en.html#watch">6.11. debian/watch file</a></dt><dt><a href="ch06.en.html#signing-key">6.12. debian/upstream/signing-key.asc file</a></dt><dt><a href="ch06.en.html#salsa-ci-yml">6.13. debian/salsa-ci.yml file</a></dt><dt><a href="ch06.en.html#debianconf">6.14. Other debian/* files</a></dt></dl></dd><dt><a href="ch07.en.html">7. Sanitization of the source</a></dt><dd><dl><dt><a href="ch07.en.html#files-excluded">7.1. Fix with Files-Excluded</a></dt><dt><a href="ch07.en.html#rules-clean">7.2. Fix with “debian/rules clean”</a></dt><dt><a href="ch07.en.html#extend-diff-ignore">7.3. Fix with extend-diff-ignore</a></dt><dt><a href="ch07.en.html#tar-ignore">7.4. Fix with tar-ignore</a></dt><dt><a href="ch07.en.html#git-clean">7.5. Fix with “git clean -dfx”</a></dt></dl></dd><dt><a href="ch08.en.html">8. More on packaging</a></dt><dd><dl><dt><a href="ch08.en.html#custom">8.1. Package customization</a></dt><dt><a href="ch08.en.html#rules-custom">8.2. Customized debian/rules</a></dt><dt><a href="ch08.en.html#rules-variables">8.3. Variables for debian/rules</a></dt><dt><a href="ch08.en.html#newversion">8.4. New upstream release</a></dt><dt><a href="ch08.en.html#dquilt-manage">8.5. Manage patch queue with dquilt</a></dt><dt><a href="ch08.en.html#build-commands">8.6. Build commands</a></dt><dt><a href="ch08.en.html#sbuild">8.7. Note on sbuild</a></dt><dt><a href="ch08.en.html#special-cases">8.8. Special build cases</a></dt><dt><a href="ch08.en.html#origtar">8.9. Upload orig.tar.gz</a></dt><dt><a href="ch08.en.html#skipedupload">8.10. Skipped uploads</a></dt><dt><a href="ch08.en.html#bug">8.11. Bug reports</a></dt></dl></dd><dt><a href="ch09.en.html">9. Advanced packaging</a></dt><dd><dl><dt><a href="ch09.en.html#historical-perspective">9.1. Historical perspective</a></dt><dt><a href="ch09.en.html#current-trend">9.2. Current trends</a></dt><dt><a href="ch09.en.html#build-system">9.3. Note on build system</a></dt><dt><a href="ch09.en.html#ci">9.4. Continuous integration</a></dt><dt><a href="ch09.en.html#bootstrap">9.5. Bootstrapping</a></dt><dt><a href="ch09.en.html#harden">9.6. Compiler hardening</a></dt><dt><a href="ch09.en.html#reproducible">9.7. Reproducible build</a></dt><dt><a href="ch09.en.html#substvar">9.8. Substvar</a></dt><dt><a href="ch09.en.html#lib">9.9. Library package</a></dt><dt><a href="ch09.en.html#multiarch">9.10. Multiarch</a></dt><dt><a href="ch09.en.html#split">9.11. Split of a Debian binary package</a></dt><dt><a href="ch09.en.html#package-split-example">9.12. Package split scenario and examples</a></dt><dt><a href="ch09.en.html#ma-lib-path">9.13. Multiarch library path</a></dt><dt><a href="ch09.en.html#ma-header-path">9.14. Multiarch header file path</a></dt><dt><a href="ch09.en.html#ma-pc-path">9.15. Multiarch *.pc file path</a></dt><dt><a href="ch09.en.html#symbols">9.16. Library symbols</a></dt><dt><a href="ch09.en.html#libnames">9.17. Library package name</a></dt><dt><a href="ch09.en.html#lib-trans">9.18. Library transition</a></dt><dt><a href="ch09.en.html#binnmu">9.19. binNMU safe</a></dt><dt><a href="ch09.en.html#dbg">9.20. Debugging information</a></dt><dt><a href="ch09.en.html#dbgsym">9.21. -dbgsym package</a></dt><dt><a href="ch09.en.html#debconf">9.22. debconf</a></dt></dl></dd><dt><a href="ch10.en.html">10. Packaging with git</a></dt><dd><dl><dt><a href="ch10.en.html#salsa-repo">10.1. Salsa repository</a></dt><dt><a href="ch10.en.html#salsa-account">10.2. Salsa account setup</a></dt><dt><a href="ch10.en.html#salsa-ci">10.3. Salsa CI service</a></dt><dt><a href="ch10.en.html#branch-names">10.4. Branch names</a></dt><dt><a href="ch10.en.html#git-patch-unapplied">10.5. Patch unapplied Git repository</a></dt><dt><a href="ch10.en.html#git-patch-applied">10.6. Patch applied Git repository</a></dt><dt><a href="ch10.en.html#gbp">10.7. Note on gbp</a></dt><dt><a href="ch10.en.html#dgit">10.8. Note on dgit</a></dt><dt><a href="ch10.en.html#gbp-pq-ap">10.9. Patch by “gbp-pq” approach</a></dt><dt><a href="ch10.en.html#gbp-manage">10.10. Manage patch queue with gbp-pq</a></dt><dt><a href="ch10.en.html#debsnap">10.11. gbp import-dscs --debsnap</a></dt><dt><a href="ch10.en.html#dgit-maint-debrebase">10.12. Note on dgit-maint-debrebase workflow</a></dt><dt><a href="ch10.en.html#quasi-native">10.13. Quasi-native Debian packaging</a></dt></dl></dd><dt><a href="ch11.en.html">11. Tips</a></dt><dd><dl><dt><a href="ch11.en.html#utf-8-build">11.1. Build under UTF-8</a></dt><dt><a href="ch11.en.html#utf-8-conv">11.2. UTF-8 conversion</a></dt><dt><a href="ch11.en.html#debug">11.3. Hints for Debugging</a></dt></dl></dd><dt><a href="ch12.en.html">12. Tool usages</a></dt><dd><dl><dt><a href="ch12.en.html#debdiff">12.1. debdiff</a></dt><dt><a href="ch12.en.html#dget">12.2. dget</a></dt><dt><a href="ch12.en.html#mk-origtargz">12.3. mk-origtargz</a></dt><dt><a href="ch12.en.html#origtargz">12.4. origtargz</a></dt><dt><a href="ch12.en.html#git-deborig">12.5. git deborig</a></dt><dt><a href="ch12.en.html#dpkg-source-b">12.6. dpkg-source -b</a></dt><dt><a href="ch12.en.html#dpkg-source-x">12.7. dpkg-source -x</a></dt><dt><a href="ch12.en.html#debc">12.8. debc</a></dt><dt><a href="ch12.en.html#piuparts">12.9. piuparts</a></dt><dt><a href="ch12.en.html#bts">12.10. bts</a></dt></dl></dd><dt><a href="ch13.en.html">13. More Examples</a></dt><dd><dl><dt><a href="ch13.en.html#emptypkg">13.1. Cherry-pick templates</a></dt><dt><a href="ch13.en.html#nomakefile">13.2. No Makefile (shell, CLI)</a></dt><dt><a href="ch13.en.html#makefile-sh">13.3. Makefile (shell, CLI)</a></dt><dt><a href="ch13.en.html#pyproject">13.4. pyproject.toml (Python3, CLI)</a></dt><dt><a href="ch13.en.html#makefile-sh-gui">13.5. Makefile (shell, GUI)</a></dt><dt><a href="ch13.en.html#pyproject-gui">13.6. pyproject.toml (Python3, GUI)</a></dt><dt><a href="ch13.en.html#makefile-single">13.7. Makefile (single-binary package)</a></dt><dt><a href="ch13.en.html#configure-single">13.8. Makefile.in + configure (single-binary package)</a></dt><dt><a href="ch13.en.html#autotools-single">13.9. Autotools (single-binary package)</a></dt><dt><a href="ch13.en.html#cmake-single">13.10. CMake (single-binary package)</a></dt><dt><a href="ch13.en.html#autotools-multi">13.11. Autotools (multi-binary package)</a></dt><dt><a href="ch13.en.html#cmake-multi">13.12. CMake (multi-binary package)</a></dt><dt><a href="ch13.en.html#i18n-example">13.13. Internationalization</a></dt><dt><a href="ch13.en.html#details">13.14. Details</a></dt></dl></dd><dt><a href="ch14.en.html">14. debmake(1) manpage</a></dt><dd><dl><dt><a href="ch14.en.html#_name">14.1. NAME</a></dt><dt><a href="ch14.en.html#_synopsis">14.2. SYNOPSIS</a></dt><dt><a href="ch14.en.html#_description">14.3. DESCRIPTION</a></dt><dd><dl><dt><a href="ch14.en.html#_optional_arguments">14.3.1. optional arguments:</a></dt></dl></dd><dt><a href="ch14.en.html#_examples">14.4. EXAMPLES</a></dt><dt><a href="ch14.en.html#_helper_packages">14.5. HELPER PACKAGES</a></dt><dt><a href="ch14.en.html#_caveat">14.6. CAVEAT</a></dt><dt><a href="ch14.en.html#_debug">14.7. DEBUG</a></dt><dt><a href="ch14.en.html#_author">14.8. AUTHOR</a></dt><dt><a href="ch14.en.html#_license">14.9. LICENSE</a></dt><dt><a href="ch14.en.html#_see_also">14.10. SEE ALSO</a></dt></dl></dd><dt><a href="ch15.en.html">15. debmake options</a></dt><dd><dl><dt><a href="ch15.en.html#ai-option">15.1. Shortcut options (-a, -i)</a></dt><dt><a href="ch15.en.html#boption">15.2. debmake -b</a></dt><dt><a href="ch15.en.html#coption">15.3. debmake -cc</a></dt><dt><a href="ch15.en.html#dt-option">15.4. Snapshot upstream tarball (-d, -t)</a></dt><dt><a href="ch15.en.html#joption">15.5. debmake -j</a></dt><dt><a href="ch15.en.html#koption">15.6. debmake -k</a></dt><dt><a href="ch15.en.html#poption">15.7. debmake -P</a></dt><dt><a href="ch15.en.html#toption">15.8. debmake -T</a></dt><dt><a href="ch15.en.html#xoption">15.9. debmake -x</a></dt></dl></dd></dl></div> </div> <div class="navfooter"> <hr/> <table width="100%" summary="Navigation footer"> <tr> <td align="left"> </td> <td align="center"> </td> <td align="right"> <a accesskey="n" href="ch01.en.html"><img src="images/next.png" alt="Next"/></a></td> </tr> <tr> <td align="left" valign="top"> </td> <td align="center"> </td> <td align="right" valign="top"> Chapter 1. Preface</td> </tr> </table> </div> </body> </html>