章 5. Simple packaging

內容目錄

5.1. Packaging tarball
5.2. 大致流程
5.3. 什麼是 debmake?
5.4. 什麼是 debuild?
5.5. 第一步:取得上游原始碼
5.6. Step 2: Generate template files with debmake
5.7. 第三步:編輯模板檔案
5.8. Step 4: Building package with debuild
5.9. Step 3 (alternatives): Modification to the upstream source
5.10. Patch by diff -u approach
5.11. Patch by dquilt approach
5.12. Patch by dpkg-source --auto-commit approach

There is an old Latin saying: Longum iter est per praecepta, breve et efficax per exempla (It’s a long way by the rules, but short and efficient with examples).

這裡給出了從簡單的 C 語言原始碼建立簡單的 Debian 套件的例子,並假設上游使用了 Makefile 作為構建系統。

我們假設上游原始碼壓縮包(tarball)名稱為 debhello-0.0.tar.gz

這一類原始碼設計可以用這樣的方式安裝成為非系統檔案:

Basics for the install from the upstream tarball. 

 $ tar -xzmf debhello-0.0.tar.gz
 $ cd debhello-0.0
 $ make
 $ make install

Debian packaging requires changing this make install process to install files to the target system image location instead of the normal location under /usr/local.

[注意]注意

在其它更加複雜的構建系統下構建 Debian 套件的例子可以在 章 14, 更多範例 找到。

從上游原始碼壓縮包 debhello-0.0.tar.gz 構建單個非原生 Debian 套件的大致流程可以總結如下:

  • 維護者取得上游原始碼壓縮包 debhello-0.0.tar.gz 並將其內容解壓縮至 debhello-0.0 目錄中。
  • debmake 命令對上游原始碼樹進行 debian 化(debianize),具體來說,是建立一個 debian 目錄並僅向該目錄中新增各類模板檔案。

    • 名為 debhello_0.0.orig.tar.gz 的符號連結被建立並指向 debhello-0.0.tar.gz 檔案。
    • 維護者須自行編輯修改模板檔案。
  • debuild 命令基於已 debian 化的原始碼樹構建二進位制套件。

    • debhello-0.0-1.debian.tar.xz 將被建立,它包含了 debian 目錄。

套件構建的大致流程. 

 $ tar -xzmf debhello-0.0.tar.gz
 $ cd debhello-0.0
 $ debmake
   ... manual customization
 $ debuild
   ...

[提示]提示

The debuild command in this and following examples may be substituted by equivalent commands such as the sbuild command.

[提示]提示

如果上游原始碼壓縮包提供了 .tar.xz 格式文件,請使用這樣的壓縮包來替代 .tar.gz.tar.bz2 格式。xz 壓縮與 gzipbzip2 壓縮相比提供了更好的壓縮比。

[注意]注意

Actual packaging activities are often performed manually without using debmake while referencing only existing similar packages and Debian Policy Manual.

The debmake command is the helper script for the Debian packaging. (章 15, debmake(1) 手冊頁”)

  • It creates good template files for the Debian packages.
  • 它總是將大多數選項的狀態與引數設定為合理的預設值。
  • 它能產生上游原始碼套件,並按需建立所需的符號連結。
  • 它不會覆寫 debian/ 目錄下已存在的配置文件。
  • 它支援多架構(multiarch)套件。
  • It provides short extracted license texts as debian/copyright in decent accuracy to help license review.

這些特性使得使用 debmake 進行 Debian 打包工作變得簡單而現代化。

In retrospective, I created debmake to simplify this documentation. I consider debmake to be more-or-less a demonstration session generator for tutorial purpose.

The debmake command isn’t the only helper script to make a Debian package. If you are interested alternative packaging helper tools, please see:

這裡給出與 debuild 命令類似的一系列命令的一個彙總。

[注意]注意

如需瞭解詳細內容,請見 dpkg-buildpackage(1)。

我們先要取得上游原始碼。

下載 debhello-0.0.tar.gz

 $ wget http://www.example.org/download/debhello-0.0.tar.gz
 ...
 $ tar -xzmf debhello-0.0.tar.gz
 $ tree
.
├── debhello-0.0
│   ├── Makefile
│   ├── README.md
│   └── src
│       └── hello.c
└── debhello-0.0.tar.gz

3 directories, 4 files

這裡的 C 原始碼 hello.c 非常的簡單。

hello.c

 $ cat debhello-0.0/src/hello.c
#include <stdio.h>
int
main()
{
        printf("Hello, world!\n");
        return 0;
}

這裡,原始碼中的 Makefile 支援 GNU 編碼標準” 和 FHS(檔案系統層級規範)。特別地:

  • 構建二進位制程式時會考慮 $(CPPFLAGS)$(CFLAGS)$(LDFLAGS),等等。
  • 安裝檔案時採納 $(DESTDIR) 作為目標系統鏡像的路徑字首
  • 安裝檔案時使用 $(prefix) 的值,以便我們將其設定覆蓋為 /usr

Makefile

 $ cat debhello-0.0/Makefile
prefix = /usr/local

all: src/hello

src/hello: src/hello.c
        @echo "CFLAGS=$(CFLAGS)" | \
                fold -s -w 70 | \
                sed -e 's/^/# /'
        $(CC) $(CPPFLAGS) $(CFLAGS) $(LDCFLAGS) -o $@ $^

install: src/hello
        install -D src/hello \
                $(DESTDIR)$(prefix)/bin/hello

clean:
        -rm -f src/hello

distclean: clean

uninstall:
        -rm -f $(DESTDIR)$(prefix)/bin/hello

.PHONY: all install clean distclean uninstall

[注意]注意

$(CFLAGS)echo 命令用於在接下來的例子中驗證所設定的構建引數。

debmake 命令的輸出十分詳細,如下所示,它可以展示程式的具體操作內容。

The output from the debmake command. 

 $ cd /path/to/debhello-0.0
 $ debmake -x1
I: set parameters
I: sanity check of parameters
I: pkg="debhello", ver="0.0", rev="1"
I: *** start packaging in "debhello-0.0". ***
I: provide debhello_0.0.orig.tar.?z for non-native Debian package
I: pwd = "/path/to"
I: $ ln -sf debhello-0.0.tar.gz debhello_0.0.orig.tar.gz
I: pwd = "/path/to/debhello-0.0"
I: parse binary package settings:
I: binary package=debhello Type=bin / Arch=any M-A=foreign
I: analyze the source tree
I: build_type = make
I: scan source for copyright+license text and file extensions
I:  50 %, ext = md
I:  50 %, ext = c
I: check_all_licenses
I: ...
I: check_all_licenses completed for 3 files.
I: bunch_all_licenses
I: format_all_licenses
I: make debian/* template files
I: debmake -x "1" ...
I: creating => debian/control
I: creating => debian/copyright
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra0_changel...
I: creating => debian/changelog
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra0_rules.t...
I: creating => debian/rules
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra0source_f...
I: creating => debian/source/format
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1_README....
I: creating => debian/README.Debian
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1_README....
I: creating => debian/README.source
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1_clean.t...
I: creating => debian/clean
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1_gbp.con...
I: creating => debian/gbp.conf
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1_salsa-c...
I: creating => debian/salsa-ci.yml
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1_watch.t...
I: creating => debian/watch
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1tests_co...
I: creating => debian/tests/control
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1upstream...
I: creating => debian/upstream/metadata
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1patches_...
I: creating => debian/patches/series
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1source.n...
I: creating => debian/source/local-options.ex
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1source.n...
I: creating => debian/source/local-patch-header.ex
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1single_d...
I: creating => debian/dirs
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1single_i...
I: creating => debian/install
I: substituting => /usr/lib/python3/dist-packages/debmake/data/extra1single_l...
I: creating => debian/links
I: $ wrap-and-sort -vast
debian/control
debian/tests/control
debian/copyright
debian/dirs
debian/install
debian/links
--- Modified files ---
debian/control
debian/dirs
debian/install
debian/links
I: $ wrap-and-sort -vast complete.  Now, debian/* may have a blank line at th...

debmake 命令基於命令列選項產生所有這些模板檔案。如果沒有指定具體選項,debmake 命令將為您自動選擇合理的預設值:

  • 原始碼套件名稱:debhello
  • 上游版本:0.0
  • 二進位制套件名稱:debhello
  • Debian 修訂版本:1
  • 套件型別: bin(ELF 二進位制可執行程式套件)
  • The -x option: -x1 (without maintainer script supports for simplicity)
[注意]注意

Here, the debmake command is invoked with the -x1 option to keep this tutorial simple. Use of default -x3 option is highly recommended.

我們來檢查一下自動產生的模板檔案。

基本 debmake 命令執行後的原始碼樹。. 

 $ cd /path/to
 $ tree
.
├── debhello-0.0
│   ├── Makefile
│   ├── README.md
│   ├── debian
│   │   ├── README.Debian
│   │   ├── README.source
│   │   ├── changelog
│   │   ├── clean
│   │   ├── control
│   │   ├── copyright
│   │   ├── dirs
│   │   ├── gbp.conf
│   │   ├── install
│   │   ├── links
│   │   ├── patches
│   │   │   └── series
│   │   ├── rules
│   │   ├── salsa-ci.yml
│   │   ├── source
│   │   │   ├── format
│   │   │   ├── local-options.ex
│   │   │   └── local-patch-header.ex
│   │   ├── tests
│   │   │   └── control
│   │   ├── upstream
│   │   │   └── metadata
│   │   └── watch
│   └── src
│       └── hello.c
├── debhello-0.0.tar.gz
└── debhello_0.0.orig.tar.gz -> debhello-0.0.tar.gz

8 directories, 24 files

這裡的 debian/rules 檔案是應當由套件維護者提供的構建指令碼。此時該檔案是由 debmake 命令產生的模板檔案。

debian/rules(模板檔案):. 

 $ cd /path/to/debhello-0.0
 $ cat debian/rules
#!/usr/bin/make -f
# You must remove unused comment lines for the released package.
#export DH_VERBOSE = 1
#export DEB_BUILD_MAINT_OPTIONS = hardening=+all
#export DEB_CFLAGS_MAINT_APPEND  = -Wall -pedantic
#export DEB_LDFLAGS_MAINT_APPEND = -Wl,-O1

%:
        dh $@

#override_dh_auto_install:
#       dh_auto_install -- prefix=/usr

#override_dh_install:
#       dh_install --list-missing -X.pyc -X.pyo

這便是使用 dh 命令時標準的 debian/rules 檔案。(某些內容已被註釋,可供後續修改使用。)

這裡的 debian/control 檔案提供了 Debian 套件的主要參數。此時該檔案是由 debmake 命令產生的模板檔案。

debian/control(模板檔案):. 

 $ cat debian/control
Source: debhello
Section: unknown
Priority: optional
Maintainer: "Osamu Aoki" <osamu@debian.org>
Build-Depends:
 debhelper-compat (= 13),
Standards-Version: 4.7.0
Homepage: <insert the upstream URL, if relevant>
Rules-Requires-Root: no
#Vcs-Git: https://salsa.debian.org/debian/debhello.git
#Vcs-Browser: https://salsa.debian.org/debian/debhello

Package: debhello
Architecture: any
Multi-Arch: foreign
Depends:
 ${misc:Depends},
 ${shlibs:Depends},
Description: auto-generated package by debmake
 This Debian binary package was auto-generated by the
 debmake(1) command provided by the debmake package.

[警告]警告

If you leave Section: unknown in the template debian/control file unchanged, the lintian error may cause the build to fail.

Since this is the ELF binary executable package, the debmake command sets Architecture: any and Multi-Arch: foreign. Also, it sets required substvar parameters as Depends: ${shlibs:Depends}, ${misc:Depends}. These are explained in 章 6, Basics for packaging”.

[注意]注意

Please note this debian/control file uses the RFC-822 style as documented in 5.2 Source package control files — debian/control of the Debian Policy Manual. The use of the empty line and the leading space are significant.

這裡的 debian/copyright 提供了 Debian 套件版權資料的總結。此時該檔案是由 debmake 命令產生的模板檔案。

debian/copyright(模板檔案):. 

 $ cat debian/copyright
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: debhello
Upstream-Contact: <preferred name and address to reach the upstream project>
Source: <url://example.com>
#
# Please double check copyright with the licensecheck(1) command.

Files:     Makefile
           README.md
           src/hello.c
Copyright: __NO_COPYRIGHT_NOR_LICENSE__
License:   __NO_COPYRIGHT_NOR_LICENSE__

#----------------------------------------------------------------------------...
# Files marked as NO_LICENSE_TEXT_FOUND may be covered by the following
# license/copyright files.

作為維護者,要製作一個合適的 Debian 套件當然需要對模板內容進行一些手工的調整。

In order to install files as a part of the system files, the $(prefix) value of /usr/local in the Makefile should be overridden to be /usr. This can be accommodated by the following the debian/rules file with the override_dh_auto_install target setting prefix=/usr.

debian/rules(維護者版本):. 

 $ cd /path/to/debhello-0.0
 $ vim debian/rules
 ... hack, hack, hack, ...
 $ cat debian/rules
#!/usr/bin/make -f
export DH_VERBOSE = 1
export DEB_BUILD_MAINT_OPTIONS = hardening=+all
export DEB_CFLAGS_MAINT_APPEND  = -Wall -pedantic
export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed

%:
        dh $@

override_dh_auto_install:
        dh_auto_install -- prefix=/usr

如上在 debian/rules 檔案中匯出=DH_VERBOSE 環境變數可以強制 debhelper 工具輸出細粒度的構建報告。

Exporting DEB_BUILD_MAINT_OPTION as above sets the hardening options as described in the FEATURE AREAS/ENVIRONMENT in dpkg-buildflags(1). [9]

如上匯出 DEB_CFLAGS_MAINT_APPEND 可以強制 C 編譯器給出所有型別的警告內容。

如上匯出 DEB_LDFLAGS_MAINT_APPEND 可以強制連結器只對真正需要的程式庫進行連結。[10]

The dh_auto_install command for the Makefile based build system essentially runs $(MAKE) install DESTDIR=debian/debhello. The creation of this override_dh_auto_install target changes its behavior to $(MAKE) install DESTDIR=debian/debhello prefix=/usr.

這裡是維護者版本的 debian/controldebian/copyright 檔案。

debian/control(維護者版本):. 

 $ vim debian/control
 ... hack, hack, hack, ...
 $ cat debian/control
Source: debhello
Section: devel
Priority: optional
Maintainer: Osamu Aoki <osamu@debian.org>
Build-Depends:
 debhelper-compat (= 13),
Standards-Version: 4.6.2
Homepage: https://salsa.debian.org/debian/debmake-doc
Rules-Requires-Root: no

Package: debhello
Architecture: any
Multi-Arch: foreign
Depends:
 ${misc:Depends},
 ${shlibs:Depends},
Description: Simple packaging example for debmake
 This Debian binary package is an example package.
 (This is an example only)

debian/copyright(維護者版本):. 

 $ vim debian/copyright
 ... hack, hack, hack, ...
 $ cat debian/copyright
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: debhello
Upstream-Contact: Osamu Aoki <osamu@debian.org>
Source: https://salsa.debian.org/debian/debmake-doc

Files:     *
Copyright: 2015-2021 Osamu Aoki <osamu@debian.org>
License:   Expat
 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.

Let’s remove unused template files and edit remaining template files:

  • debian/README.source
  • debian/source/local-option.ex
  • debian/source/local-patch-header.ex
  • debian/patches/series (No upstream patch)
  • clean
  • dirs
  • install
  • links

debian/. 下面的模板檔案(0.0 版):. 

 $ rm -f debian/clean debian/dirs debian/install debian/links
 $ rm -f debian/README.source debian/source/*.ex
 $ rm -rf debian/patches
 $ tree -F debian
debian/
├── README.Debian
├── changelog
├── control
├── copyright
├── gbp.conf
├── rules*
├── salsa-ci.yml
├── source/
│   └── format
├── tests/
│   └── control
├── upstream/
│   └── metadata
└── watch

4 directories, 11 files

[提示]提示

對於來自 debhelper 套件的各個 dh_* 命令來說,它們在讀取所使用的配置文件時通常把以 # 開頭的行視為註釋行。

您可以使用 debuild 或者等效的命令工具(參見 節 5.4, “什麼是 debuild?””)在這個原始碼樹內構建一個非原生 Debian 套件。命令的輸出通常十分詳細,如下所示,它會對構建中執行的操作進行解釋。

Building package with debuild

 $ cd /path/to/debhello-0.0
 $ debuild
 dpkg-buildpackage -us -uc -ui -i
dpkg-buildpackage: info: source package debhello
dpkg-buildpackage: info: source version 0.0-1
dpkg-buildpackage: info: source distribution unstable
dpkg-buildpackage: info: source changed by Osamu Aoki <osamu@debian.org>
 dpkg-source -i --before-build .
dpkg-buildpackage: info: host architecture amd64
 debian/rules clean
dh clean
   dh_auto_clean
        make -j12 distclean
 ...
 debian/rules binary
dh binary
   dh_update_autotools_config
   dh_autoreconf
   dh_auto_configure
   dh_auto_build
        make -j12 "INSTALL=install --strip-program=true"
make[1]: Entering directory '/path/to/debhello-0.0'
# CFLAGS=-g -O2 -Werror=implicit-function-declaration
 ...
Finished running lintian.

這裡驗證了 CFLAGS 已經得到了更新,新增了 -Wall-pendatic 引數;這是我們先前在 DEB_CFLAGS_MAINT_APPEND 變數中所指定的。

根據 lintian 的報告,您應該如同後文中的例子那樣(請見 章 14, 更多範例)為套件新增 man 手冊頁。我們這裡暫且跳過這部分內容。

現在我們來看看成果如何。

debhello 0.0 版使用 debuild 命令產生的文件:. 

 $ cd /path/to
 $ tree -FL 1
./
├── debhello-0.0/
├── debhello-0.0.tar.gz
├── debhello-dbgsym_0.0-1_amd64.deb
├── debhello_0.0-1.debian.tar.xz
├── debhello_0.0-1.dsc
├── debhello_0.0-1_amd64.build
├── debhello_0.0-1_amd64.buildinfo
├── debhello_0.0-1_amd64.changes
├── debhello_0.0-1_amd64.deb
└── debhello_0.0.orig.tar.gz -> debhello-0.0.tar.gz

2 directories, 9 files

您可以看見生成的全部檔案。

  • debhello_0.0.orig.tar.gz 是指向上游原始碼壓縮包的符號連結。
  • debhello_0.0-1.debian.tar.xz 包含了維護者生成的內容。
  • debhello_0.0-1.dsc 是 Debian 原始碼套件的元資料檔案。
  • debhello_0.0-1_amd64.deb 是 Debian 二進制套件。
  • debhello-dbgsym_0.0-1_amd64.deb 是 Debian 的除錯符號二進位制套件。另請參見 節 10.21, “-dbgsym package”
  • debhello_0.0-1_amd64.build 是構建日誌文件。
  • debhello_0.0-1_amd64.buildinfodpkg-genbuildinfo(1) 生成的元資料檔案。
  • debhello_0.0-1_amd64.changes 是 Debian 二進位制套件的元資料檔案。

debhello_0.0-1.debian.tar.xz 包含了 Debian 對上游原始碼的修改,具體如下所示。

壓縮檔案 debhello_0.0-1.debian.tar.xz 的內容:. 

 $ tar -tzf debhello-0.0.tar.gz
debhello-0.0/
debhello-0.0/src/
debhello-0.0/src/hello.c
debhello-0.0/Makefile
debhello-0.0/README.md
 $ tar --xz -tf debhello_0.0-1.debian.tar.xz
debian/
debian/README.Debian
debian/changelog
debian/control
debian/copyright
debian/gbp.conf
debian/rules
debian/salsa-ci.yml
debian/source/
debian/source/format
debian/tests/
debian/tests/control
debian/upstream/
debian/upstream/metadata
debian/watch

debhello_0.0-1_amd64.deb 包含了將要安裝至目標系統中的檔案。

The debhello-debsym_0.0-1_amd64.deb contains the debug symbol files to be installed to the target system.

所有二進位制包的包內容:. 

 $ dpkg -c debhello-dbgsym_0.0-1_amd64.deb
drwxr-xr-x root/root ...  ./
drwxr-xr-x root/root ...  ./usr/
drwxr-xr-x root/root ...  ./usr/lib/
drwxr-xr-x root/root ...  ./usr/lib/debug/
drwxr-xr-x root/root ...  ./usr/lib/debug/.build-id/
drwxr-xr-x root/root ...  ./usr/lib/debug/.build-id/c4/
-rw-r--r-- root/root ...  ./usr/lib/debug/.build-id/c4/cec6427d45de48efc7f263...
drwxr-xr-x root/root ...  ./usr/share/
drwxr-xr-x root/root ...  ./usr/share/doc/
lrwxrwxrwx root/root ...  ./usr/share/doc/debhello-dbgsym -> debhello
 $ dpkg -c debhello_0.0-1_amd64.deb
drwxr-xr-x root/root ...  ./
drwxr-xr-x root/root ...  ./usr/
drwxr-xr-x root/root ...  ./usr/bin/
-rwxr-xr-x root/root ...  ./usr/bin/hello
drwxr-xr-x root/root ...  ./usr/share/
drwxr-xr-x root/root ...  ./usr/share/doc/
drwxr-xr-x root/root ...  ./usr/share/doc/debhello/
-rw-r--r-- root/root ...  ./usr/share/doc/debhello/README.Debian
-rw-r--r-- root/root ...  ./usr/share/doc/debhello/changelog.Debian.gz
-rw-r--r-- root/root ...  ./usr/share/doc/debhello/copyright

生成的依賴列表會給出所有二進位制套件的依賴。

生成的所有二進位制套件的依賴列表(v=0.0):. 

 $ dpkg -f debhello-dbgsym_0.0-1_amd64.deb pre-depends \
            depends recommends conflicts breaks
Depends: debhello (= 0.0-1)
 $ dpkg -f debhello_0.0-1_amd64.deb pre-depends \
            depends recommends conflicts breaks
Depends: libc6 (>= 2.34)

[注意]注意

在將套件上傳至 Debian 倉庫之前,仍然有很多細節需要進行處理。

[注意]注意

如果跳過了對 debmake 命令自動生成的配置檔案的手工調整步驟,所生成的二進位制套件可能缺少有用的套件描述資訊,某些政策的要求也無法滿足。這個不正式的套件對於 dpkg 命令來說可以正常處理,也許這樣對您本地的部署來說已經足夠好了。

The above example did not touch the upstream source to make the proper Debian package. An alternative approach as the maintainer is to modify files in the upstream source. For example, Makefile may be modified to set the $(prefix) value to /usr.

[注意]注意

The above 節 5.7, “第三步:編輯模板檔案” using the debian/rules file is the better approach for packaging for this example. But let’s continue on with this alternative approaches as a leaning experience.

In the following, let’s consider 3 simple variants of this alternative approach to generate debian/patches/* files representing modifications to the upstream source in the Debian source format 3.0 (quilt). These substitute 節 5.7, “第三步:編輯模板檔案”” in the above step-by-step example:

Please note the debian/rules file used for these examples doesn’t have the override_dh_auto_install target as follows:

debian/rules(備選的維護者版本):. 

 $ cd /path/to/debhello-0.0
 $ vim debian/rules
 ... hack, hack, hack, ...
 $ cat debian/rules
#!/usr/bin/make -f
export DH_VERBOSE = 1
export DEB_BUILD_MAINT_OPTIONS = hardening=+all
export DEB_CFLAGS_MAINT_APPEND  = -Wall -pedantic
export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed

%:
        dh $@

Here, the patch file 000-prefix-usr.patch is created using the diff command.

Patch by diff -u

 $ cp -a debhello-0.0 debhello-0.0.orig
 $ vim debhello-0.0/Makefile
 ... hack, hack, hack, ...
 $ diff -Nru debhello-0.0.orig debhello-0.0 >000-prefix-usr.patch
 $ cat 000-prefix-usr.patch
diff -Nru debhello-0.0.orig/Makefile debhello-0.0/Makefile
--- debhello-0.0.orig/Makefile  2024-11-29 07:57:10.299591959 +0000
+++ debhello-0.0/Makefile       2024-11-29 07:57:10.391593434 +0000
@@ -1,4 +1,4 @@
-prefix = /usr/local
+prefix = /usr

 all: src/hello

 $ rm -rf debhello-0.0
 $ mv -f debhello-0.0.orig debhello-0.0

Please note that the upstream source tree is restored to the original state after generating a patch file 000-prefix-usr.patch.

This 000-prefix-usr.patch is edited to be DEP-3 conforming and moved to the right location as below.

000-prefix-usr.patch (DEP-3): 

 $ echo '000-prefix-usr.patch' >debian/patches/series
 $ vim ../000-prefix-usr.patch
 ... hack, hack, hack, ...
 $ mv -f ../000-prefix-usr.patch debian/patches/000-prefix-usr.patch
 $ cat debian/patches/000-prefix-usr.patch
From: Osamu Aoki <osamu@debian.org>
Description: set prefix=/usr patch
diff -Nru debhello-0.0.orig/Makefile debhello-0.0/Makefile
--- debhello-0.0.orig/Makefile
+++ debhello-0.0/Makefile
@@ -1,4 +1,4 @@
-prefix = /usr/local
+prefix = /usr

 all: src/hello

[注意]注意

When generating the Debian source package by dpkg-source via dpkg-buildpackage in the following step of 節 5.8, “Step 4: Building package with debuild, the dpkg-source command assumes that no patch was applied to the upstream source, since the .pc/applied-patches is missing.

Here, the patch file 000-prefix-usr.patch is created using the dquilt command.

dquilt is a simple wrapper of the quilt program. The syntax and function of the dquilt command is the same as the quilt(1) command, except for the fact that the generated patch is stored in the debian/patches/ directory.

Patch by dquilt

 $ dquilt new 000-prefix-usr.patch
Patch debian/patches/000-prefix-usr.patch is now on top
 $ dquilt add Makefile
File Makefile added to patch debian/patches/000-prefix-usr.patch
 ... hack, hack, hack, ...
 $ head -1 Makefile
prefix = /usr
 $ dquilt refresh
Refreshed patch debian/patches/000-prefix-usr.patch
 $ dquilt header -e --dep3
 ... edit the DEP-3 patch header with editor
 $ tree -a
.
├── .pc
│   ├── .quilt_patches
│   ├── .quilt_series
│   ├── .version
│   ├── 000-prefix-usr.patch
│   │   ├── .timestamp
│   │   └── Makefile
│   └── applied-patches
├── Makefile
├── README.md
├── debian
│   ├── README.Debian
│   ├── README.source
│   ├── changelog
│   ├── clean
│   ├── control
│   ├── copyright
│   ├── dirs
│   ├── gbp.conf
│   ├── install
│   ├── links
│   ├── patches
│   │   ├── 000-prefix-usr.patch
│   │   └── series
│   ├── rules
│   ├── salsa-ci.yml
│   ├── source
│   │   ├── format
│   │   ├── local-options.ex
│   │   └── local-patch-header.ex
│   ├── tests
│   │   └── control
│   ├── upstream
│   │   └── metadata
│   └── watch
└── src
    └── hello.c

9 directories, 29 files
 $ cat debian/patches/series
000-prefix-usr.patch
 $ cat debian/patches/000-prefix-usr.patch
Description: set prefix=/usr patch
Author: Osamu Aoki <osamu@debian.org>
Index: debhello-0.0/Makefile
===================================================================
--- debhello-0.0.orig/Makefile
+++ debhello-0.0/Makefile
@@ -1,4 +1,4 @@
-prefix = /usr/local
+prefix = /usr

 all: src/hello

Here, Makefile in the upstream source tree doesn’t need to be restored to the original state for the packaging.

[注意]注意

When generating the Debian source package by dpkg-source via dpkg-buildpackage in the following step of 節 5.8, “Step 4: Building package with debuild, the dpkg-source command assumes that patches were applied to the upstream source, since the .pc/applied-patches exists.

The upstream source tree can be restored to the original state for the packaging.

The upstream source tree (restored): 

 $ dquilt pop -a
Removing patch debian/patches/000-prefix-usr.patch
Restoring Makefile

No patches applied
 $ head -1 Makefile
prefix = /usr/local
 $ tree -a .pc
.pc
├── .quilt_patches
├── .quilt_series
└── .version

1 directory, 3 files

Here, Makefile is restored and the .pc/applied-patches is missing.

Here, the patch file isn’t created in this step but the source files are setup to create debian/patches/* files in the following step of 節 5.8, “Step 4: Building package with debuild”.

我們先來編輯上游原始碼。

Modified Makefile

 $ vim Makefile
 ... hack, hack, hack, ...
 $ head -n1 Makefile
prefix = /usr

Let’s edit debian/source/local-options:

debian/source/local-options for auto-commit

 $ mv debian/source/local-options.ex debian/source/local-options
 $ vim debian/source/local-options
 ... hack, hack, hack, ...
 $ cat debian/source/local-options
# == Patch applied strategy (merge) ==
#
# The source outside of debian/ directory is modified by maintainer and
# different from the upstream one:
#   * Workflow using dpkg-source commit (commit all to VCS after dpkg-source ...
#       https://www.debian.org/doc/manuals/debmake-doc/ch04.en.html#dpkg-sour...
#   * Workflow described in dgit-maint-merge(7)
#
single-debian-patch
auto-commit

Let’s edit debian/source/local-patch-header:

debian/source/local-patch-header for auto-commit

 $ mv debian/source/local-patch-header.ex debian/source/local-patch-header
 $ vim debian/source/local-patch-header
 ... hack, hack, hack, ...
 $ cat debian/source/local-patch-header
Description: debian-changes
Author: Osamu Aoki <osamu@debian.org>

Let’s remove debian/patches/* files and other unused template files.

Remove unused template files. 

 $ rm -f debian/clean debian/dirs debian/install debian/links
 $ rm -f debian/README.source debian/source/*.ex
 $ rm -rf debian/patches
 $ tree debian
debian
├── README.Debian
├── changelog
├── control
├── copyright
├── gbp.conf
├── rules
├── salsa-ci.yml
├── source
│   ├── format
│   ├── local-options
│   └── local-patch-header
├── tests
│   └── control
├── upstream
│   └── metadata
└── watch

4 directories, 13 files

There are no debian/patches/* files at the end of this step.

[注意]注意

When generating the Debian source package by dpkg-source via dpkg-buildpackage in the following step of 節 5.8, “Step 4: Building package with debuild, the dpkg-source command uses options specified in debian/source/local-options to auto-commit modification applied to the upstream source as patches/debian-changes.

Let’s inspect the Debian source package generated after the following 節 5.8, “Step 4: Building package with debuild step and extracting files from debhello-0.0.debian.tar.xz.

Inspect debhello-0.0.debian.tar.xz after debuild

 $ tar --xz -xvf debhello_0.0-1.debian.tar.xz
debian/
debian/README.Debian
debian/changelog
debian/control
debian/copyright
debian/gbp.conf
debian/patches/
debian/patches/debian-changes
debian/patches/series
debian/rules
debian/salsa-ci.yml
debian/source/
debian/source/format
debian/tests/
debian/tests/control
debian/upstream/
debian/upstream/metadata
debian/watch

Let’s check generated debian/patches/* files.

Inspect debian/patches/* after debuild

 $ cat debian/patches/series
debian-changes
 $ cat debian/patches/debian-changes
Description: debian-changes
Author: Osamu Aoki <osamu@debian.org>

--- debhello-0.0.orig/Makefile
+++ debhello-0.0/Makefile
@@ -1,4 +1,4 @@
-prefix = /usr/local
+prefix = /usr

 all: src/hello

The Debian source package debhello-0.0.debian.tar.xz is confirmed to be generated properly with debian/patches/* files for the Debian modification.



[9] This is a cliché to force a read-only relocation link for the hardening and to prevent the lintian warning W: debhello: hardening-no-relro usr/bin/hello. This is not really needed for this example but should be harmless. The lintian tool seems to produce a false positive warning for this case which has no linked library.

[10] 這裡的做法是為了避免在依賴程式庫情況複雜的情況下過度連結,例如某些 GNOME 程式。這樣做對這裡的簡單例子來說並不是必要的,但應當是無害的。