Table of Contents
有一句古老的拉丁諺語:“fabricando fit faber”(“熟能生巧”)。
強烈建議使用簡單的包來練習和試驗 Debian 打包的所有步驟。本章為您的練習提供了許多上游案例。
這也可以作為許多程式設計主題的介紹範例。
請注意,Debian 對以下事項非常注意:
通過以下方式以實現通用作業系統:
在 Chapter 4, 簡單例子 中介紹的典型打包範例是本章節的先決條件。
在以下數小節中,有些細節被刻意模糊。請嘗試閱讀相關檔案,並且嘗試自行釐清它們。
![]() |
Tip |
---|---|
打包範例的最佳來源就是目前的 Debian 歸檔本身。請使用 “Debian 程式碼搜尋” 服務來查找相關範例。 |
以下是一個從空目錄由零開始構建簡單的 Debian 套件的範例。
這是一個很棒的平臺,可以使您獲得所有的模板檔案,而不會使您正在處理的上游原始碼樹變得一團糟。
讓我們假設這個空目錄為 debhello-0.1。
$ mkdir debhello-0.1 $ tree . └── debhello-0.1 1 directory, 0 files
讓我們通過指定 -x4 選項來生成最大數量的模板檔案。
此外,讓我們使用 “-p debhello -t -u 0.1 -r 1” 選項來製作遺失的上游原始碼套件。
$ debmake -t -p debhello -u 0.1 -r 1 -x4 I: set parameters I: ================================================================= ... I: sanity check of parameters W: -p "debhello" != auto set value "" W: -u "0.1" != auto set value "0~2107020726" W: -r "1" != auto set value "" ... I: debmake -x "4" ... I: creating => debian/control I: creating => debian/copyright I: substituting => /usr/share/debmake/extra0/changelog ... I: creating => debian/license-examples/GPL-3.0+ I: substituting => /usr/share/debmake/extra4/LGPL-2.1+ I: creating => debian/license-examples/LGPL-2.1+ I: substituting => /usr/share/debmake/extra4/LGPL-3.0+ I: creating => debian/license-examples/LGPL-3.0+ I: $ wrap-and-sort
我們來檢查一下自動產生的模板檔案。
$ cd .. $ tree . ├── debhello-0.1 │ └── debian │ ├── README.Debian │ ├── changelog │ ├── clean │ ├── compat.ex │ ├── control │ ├── copyright │ ├── debhello.bug-control.ex │ ├── debhello.bug-presubj.ex │ ├── debhello.bug-script.ex │ ├── debhello.conffiles.ex │ ├── debhello.cron.d.ex │ ├── debhello.cron.daily.ex │ ├── debhello.cron.hourly.ex │ ├── debhello.cron.monthly.ex │ ├── debhello.cron.weekly.ex │ ├── debhello.default.ex │ ├── debhello.dirs.ex │ ├── debhello.emacsen-install.ex │ ├── debhello.emacsen-remove.ex │ ├── debhello.emacsen-startup.ex │ ├── debhello.init.ex │ ├── debhello.lintian-overrides.ex │ ├── debhello.service.ex │ ├── debhello.tmpfile.ex │ ├── debhello.upstart.ex │ ├── install │ ├── license-examples │ │ ├── Apache-2.0 │ │ ├── Artistic-1.0 │ │ ├── BSD-3-Clause │ │ ├── Expat │ │ ├── GPL-2.0+ │ │ ├── GPL-3.0+ │ │ ├── LGPL-2.1+ │ │ └── LGPL-3.0+ │ ├── links │ ├── manpage.1.ex │ ├── manpage.asciidoc.ex │ ├── manpage.sgml.ex │ ├── manpage.xml.ex │ ├── patches │ │ └── series │ ├── postinst │ ├── postrm │ ├── preinst │ ├── prerm │ ├── rules │ ├── source │ │ ├── control │ │ ├── format │ │ ├── local-options │ │ ├── options │ │ └── patch-header │ ├── source.lintian-overrides.ex │ ├── tests │ │ └── control │ ├── upstream │ │ └── metadata │ └── watch ├── debhello-0.1.tar.gz └── debhello_0.1.orig.tar.gz -> debhello-0.1.tar.gz 7 directories, 56 files
現在,您可以複製 debhello-0.1/debian/ 目錄下所有生成的模板檔案到您的套件中。
![]() |
Tip |
---|---|
通過使用 -T 選項(教材模式)呼叫 debmake 命令,可以使生成的模板檔案更加詳細。 |
此處是一個從 POSIX shell 命令列介面程式建立簡單的 Debian 套件的範例,我們假設它沒有使用任何構建系統。
讓我們假設上游的原始碼套件為 debhello-0.2.tar.gz。
此類原始碼不具有自動化方法,所以必須手動安裝檔案。
For example:
$ tar -xzmf debhello-0.2.tar.gz $ cd debhello-0.2 $ sudo cp scripts/hello /bin/hello ...
Let’s get this source as tar file from a remote site and make it the Debian package.
下載 debhello-0.2.tar.gz.
$ wget http://www.example.org/download/debhello-0.2.tar.gz ... $ tar -xzmf debhello-0.2.tar.gz $ tree . ├── debhello-0.2 │ ├── LICENSE │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ └── hello.1 │ └── scripts │ └── hello └── debhello-0.2.tar.gz 4 directories, 6 files
這裡的 POSIX shell 指令碼 hello 非常的簡單。
hello(v=0.2).
$ cat debhello-0.2/scripts/hello #!/bin/sh -e echo "Hello from the shell!" echo "" echo -n "Type Enter to exit this program: " read X
此處的 hello.desktop 支援 桌面項(Desktop Entry)規範。
hello.desktop(v=0.2).
$ cat debhello-0.2/data/hello.desktop [Desktop Entry] Name=Hello Name[fr]=Bonjour Comment=Greetings Comment[fr]=Salutations Type=Application Keywords=hello Exec=hello Terminal=true Icon=hello.png Categories=Utility;
此處的 hello.png 是圖示的影象檔案。
讓我們使用 debmake 命令來打包。這裡使用 -b':sh' 選項來指明生成的二進位制包是一個 shell 指令碼。
$ cd debhello-0.2 $ debmake -b':sh' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="0.2", rev="1" I: *** start packaging in "debhello-0.2". *** I: provide debhello_0.2.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-0.2.tar.gz debhello_0.2.orig.tar.gz I: pwd = "/path/to/debhello-0.2" I: parse binary package settings: :sh I: binary package=debhello Type=script / Arch=all M-A=foreign I: analyze the source tree I: build_type = Unknown I: scan source for copyright+license text and file extensions I: 33 %, ext = desktop ...
讓我們來檢查一下自動產生的模板檔案。
執行基本的 debmake 命令後的原始碼樹。(v=0.2).
$ cd .. $ tree . ├── debhello-0.2 │ ├── LICENSE │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── debian │ │ ├── README.Debian │ │ ├── changelog │ │ ├── control │ │ ├── copyright │ │ ├── patches │ │ │ └── series │ │ ├── rules │ │ ├── source │ │ │ ├── control │ │ │ ├── format │ │ │ ├── local-options │ │ │ ├── options │ │ │ └── patch-header │ │ ├── tests │ │ │ └── control │ │ ├── upstream │ │ │ └── metadata │ │ └── watch │ ├── man │ │ └── hello.1 │ └── scripts │ └── hello ├── debhello-0.2.tar.gz └── debhello_0.2.orig.tar.gz -> debhello-0.2.tar.gz 9 directories, 21 files
debian/rules(模板檔案,v=0.2):.
$ cat debhello-0.2/debian/rules #!/usr/bin/make -f # You must remove unused comment lines for the released package. #export DH_VERBOSE = 1 %: dh $@
這基本上是帶有 dh 命令的標準 debian/rules 檔案。因為這是個指令碼套件,所以這個 debian/rules 模板檔案沒有與構建標記(build flag)相關的內容。
debian/control(模板檔案,v=0.2):.
$ cat debhello-0.2/debian/control Source: debhello Section: unknown Priority: optional Maintainer: "Firstname Lastname" <email.address@example.org> Build-Depends: debhelper-compat (= 13) Standards-Version: 4.5.1 Homepage: <insert the upstream URL, if relevant> Rules-Requires-Root: no Package: debhello Architecture: all Multi-Arch: foreign Depends: ${misc:Depends} Description: auto-generated package by debmake This Debian binary package was auto-generated by the debmake(1) command provided by the debmake package.
因為這是個 shell 指令碼包,所以 debmake 命令設定了“Architecture: all”和“Multi-Arch: foreign”。此外,它還將所需的 substvar 引數設定為“Depends: ${misc:Depends}”。Chapter 5, 基本內容 對此進行了解釋。
因為這個上游原始碼缺少上游的 Makefile,所以這個功能需要由維護者提供。這個上游原始碼僅包含指令碼檔案和資料檔案,沒有 C 的源碼檔案,因此 構建(build) 的過程可以被跳過,但是需要實現 安裝(install) 的過程。對於這種情況,通過新增 debian/install 和 debian/manpages 檔案可以很好地實現這一功能,且不會使 debian/rules 檔案變得複雜。
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=0.2):.
$ vim debhello-0.2/debian/rules ... hack, hack, hack, ... $ cat debhello-0.2/debian/rules #!/usr/bin/make -f export DH_VERBOSE = 1 %: dh $@
debian/control(維護者版本,v=0.2):.
$ vim debhello-0.2/debian/control ... hack, hack, hack, ... $ cat debhello-0.2/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13) Standards-Version: 4.5.1 Homepage: https://salsa.debian.org/debian/debmake-doc Rules-Requires-Root: no Package: debhello Architecture: all Multi-Arch: foreign Depends: ${misc:Depends} Description: Simple packaging example for debmake This Debian binary package is an example package. (This is an example only)
![]() |
Warning |
---|---|
如果您對 debian/control 模板檔案中的“Section: unknown”部分不作修改的話,後續的 lintian 錯誤可能導致構建失敗。 |
debian/install(維護者版本,v=0.2):.
$ vim debhello-0.2/debian/install ... hack, hack, hack, ... $ cat debhello-0.2/debian/install data/hello.desktop usr/share/applications data/hello.png usr/share/pixmaps scripts/hello usr/bin
debian/manpages(維護者版本,v=0.2):.
$ vim debhello-0.2/debian/manpages ... hack, hack, hack, ... $ cat debhello-0.2/debian/manpages man/hello.1
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
debian/ 目錄下的模板檔案。(v=0.2):.
$ tree debhello-0.2/debian debhello-0.2/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── install ├── manpages ├── patches │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 16 files
您可以在此原始碼樹中使用 debuild 命令(或其等效命令)建立非原生的 Debian 套件。如下所示,該命令的輸出非常詳細,並且解釋了它所做的事。
$ cd debhello-0.2 $ debuild dpkg-buildpackage -us -uc -ui -i -i ... debian/rules clean dh clean ... debian/rules binary dh binary dh_update_autotools_config dh_autoreconf create-stamp debian/debhelper-build-stamp dh_prep rm -f -- debian/debhello.substvars rm -fr -- debian/.debhelper/generated/debhello/ debian/debhello/ debi... dh_install install -d debian/debhello/usr/bin cp --reflink=auto -a ./scripts/hello debian/debhello/usr/bin/ ...
現在我們來看看成果如何。
通過 debuild 生成的第 0.2 版的 debhello 檔案:.
$ cd .. $ tree -FL 1 . ├── debhello-0.2/ ├── debhello-0.2.tar.gz ├── debhello_0.2-1.debian.tar.xz ├── debhello_0.2-1.dsc ├── debhello_0.2-1_all.deb ├── debhello_0.2-1_amd64.build ├── debhello_0.2-1_amd64.buildinfo ├── debhello_0.2-1_amd64.changes └── debhello_0.2.orig.tar.gz -> debhello-0.2.tar.gz 1 directory, 8 files
您可以看見生成的全部檔案。
debhello_0.2-1.debian.tar.xz 包含了 Debian 對上游原始碼的修改,具體如下所示。
壓縮過的歸檔檔案 debhello_0.2-1.debian.tar.xz 中的內容物:.
$ tar -tzf debhello-0.2.tar.gz debhello-0.2/ debhello-0.2/data/ debhello-0.2/data/hello.desktop debhello-0.2/data/hello.png debhello-0.2/man/ debhello-0.2/man/hello.1 debhello-0.2/scripts/ debhello-0.2/scripts/hello debhello-0.2/LICENSE $ tar --xz -tf debhello_0.2-1.debian.tar.xz debian/ debian/README.Debian debian/changelog debian/control debian/copyright debian/install debian/manpages debian/patches/ debian/patches/series debian/rules debian/source/ debian/source/control debian/source/format debian/source/options debian/source/patch-header debian/tests/ debian/tests/control debian/upstream/ debian/upstream/metadata debian/watch
debhello_0.2-1_amd64.deb 包含了將要安裝至系統中的檔案,如下所示。
debhello_0.2-1_all.deb 二進位制套件中的內容:.
$ dpkg -c debhello_0.2-1_all.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/applications/ -rw-r--r-- root/root ... ./usr/share/applications/hello.desktop 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 drwxr-xr-x root/root ... ./usr/share/man/ drwxr-xr-x root/root ... ./usr/share/man/man1/ -rw-r--r-- root/root ... ./usr/share/man/man1/hello.1.gz drwxr-xr-x root/root ... ./usr/share/pixmaps/ -rw-r--r-- root/root ... ./usr/share/pixmaps/hello.png
此處是生成的 debhello_0.2-1_all.deb 的依賴項列表。
debhello_0.2-1_all.deb 的依賴項列表:.
$ dpkg -f debhello_0.2-1_all.deb pre-depends depends recommends conflicts br...
(No extra dependency packages required since this is a POSIX shell program.)
![]() |
Note |
---|---|
If you wish to replace upstream provided PNG file data/hello.png with maintainer provided one
debian/hello.png, editing debian/install isn’t enough. When you add
debian/hello.png, you need to add a line
" |
下面是從 POSIX shell 命令列介面程式建立簡單的 Debian 套件的範例,我們假設它使用 Makefile 作為構建系統。
讓我們假設上游的原始碼套件為 debhello-1.0.tar.gz。
這一類原始碼設計可以用這樣的方式安裝成為非系統檔案:
$ tar -xzmf debhello-1.0.tar.gz $ cd debhello-1.0 $ make install
Debian 的打包需要對“make install”流程進行改變,從而將檔案安裝至目標系統映象所在位置,而非通常使用的 /usr/local 下的位置。
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.0.tar.gz.
$ wget http://www.example.org/download/debhello-1.0.tar.gz ... $ tar -xzmf debhello-1.0.tar.gz $ tree . ├── debhello-1.0 │ ├── LICENSE │ ├── Makefile │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ └── hello.1 │ └── scripts │ └── hello └── debhello-1.0.tar.gz 4 directories, 7 files
這裡的 Makefile 正確使用 $(DESTDIR) 和 $(prefix)。其他的所有檔案都和 Section 8.2, “無 Makefile(shell,命令列介面)” 中的一樣,並且大多數的打包工作也都一樣。
Makefile(v=1.0).
$ cat debhello-1.0/Makefile prefix = /usr/local all: : # do nothing install: install -D scripts/hello \ $(DESTDIR)$(prefix)/bin/hello install -m 644 -D data/hello.desktop \ $(DESTDIR)$(prefix)/share/applications/hello.desktop install -m 644 -D data/hello.png \ $(DESTDIR)$(prefix)/share/pixmaps/hello.png install -m 644 -D man/hello.1 \ $(DESTDIR)$(prefix)/share/man/man1/hello.1 clean: : # do nothing distclean: clean uninstall: -rm -f $(DESTDIR)$(prefix)/bin/hello -rm -f $(DESTDIR)$(prefix)/share/applications/hello.desktop -rm -f $(DESTDIR)$(prefix)/share/pixmaps/hello.png -rm -f $(DESTDIR)$(prefix)/share/man/man1/hello.1 .PHONY: all install clean distclean uninstall
讓我們使用 debmake 命令來打包。這裡使用 -b':sh' 選項來指明生成的二進位制包是一個 shell 指令碼。
$ cd debhello-1.0 $ debmake -b':sh' -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.0", rev="1" I: *** start packaging in "debhello-1.0". *** I: provide debhello_1.0.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.0.tar.gz debhello_1.0.orig.tar.gz I: pwd = "/path/to/debhello-1.0" I: parse binary package settings: :sh I: binary package=debhello Type=script / Arch=all M-A=foreign I: analyze the source tree I: build_type = make I: scan source for copyright+license text and file extensions I: 33 %, ext = desktop ...
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=1.0):.
$ cat debhello-1.0/debian/rules #!/usr/bin/make -f # You must remove unused comment lines for the released package. #export DH_VERBOSE = 1 %: dh $@ #override_dh_auto_install: # dh_auto_install -- prefix=/usr #override_dh_install: # dh_install --list-missing -X.pyc -X.pyo
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=1.0):.
$ vim debhello-1.0/debian/rules ... hack, hack, hack, ... $ cat debhello-1.0/debian/rules #!/usr/bin/make -f export DH_VERBOSE = 1 %: dh $@ override_dh_auto_install: dh_auto_install -- prefix=/usr
因為上游原始碼含有正確的上游 Makefile 文件,所以沒有必要再去建立 debian/install 和 debian/manpages 檔案。
debian/control 檔案和 Section 8.2, “無 Makefile(shell,命令列介面)” 中的完全一致。
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
debian/ 目錄下的模板檔案。(v=1.0):.
$ tree debhello-1.0/debian debhello-1.0/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── patches │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 14 files
其餘的打包操作基本上和 Section 8.2, “無 Makefile(shell,命令列介面)” 中的相同。
Many interesting upstream Python program packages are packaged using the setuptools based setup.py. Usually, these source packages are built into Python specific binary distribution format wheel and wheel packages are distributed to end users. Then, end users find these from package listing sites such as the Python Package Index (PyPI) and install these wheel packages using pip to the user’s environment.
In order to make Debian package of these Python programs, you must start
with their source packages. The current Debian packaging practice of such
Python programs uses dh_python3
(1) and
pybuild
(1) from dh_python
package.
Although setuptools isn’t mentioned in
pybuild
(1), you can treat these as if these are packaged
using the distutils based setup.py since setuptools
is an enhanced extension of distutils.
[23]
Let’s assume the upstream tarball to be debhello-1.1.tar.gz.
"Installing Python Modules (Legacy version)" explains how to install source to the system using distutils. Essentially, the source is installed using distutils as:
$ tar -xzmf debhello-1.1.tar.gz $ cd debhello-1.1 $ python3 setup.py install
Debian packaging requires changing the last line to “python3 setup.py install --install-layout=deb” to install files into the target system image location. This is automatically addressed when using the dh command for Debian packaging.
Here is an example of creating a simple Debian package from a Python3 CLI program using the setuptools based setup.py as its build system.
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.1.tar.gz.
$ wget http://www.example.org/download/debhello-1.1.tar.gz ... $ tar -xzmf debhello-1.1.tar.gz $ tree . ├── debhello-1.1 │ ├── LICENSE │ ├── MANIFEST.in │ ├── README.md │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── manpages │ │ └── hello.1 │ ├── pyproject.toml │ ├── setup.cfg │ ├── setup.py │ └── src │ └── debhello │ ├── __init__.py │ └── __main__.py └── debhello-1.1.tar.gz 5 directories, 12 files
Here, the content of this debhello source tree as follows.
setup.py (v=1.1) — a boilar plate setup.py for the backward compatibility.
$ cat debhello-1.1/setup.py # coding: utf-8 import setuptools setuptools.setup()
setup.cfg (v=1.1) — modern static metadata.
$ cat debhello-1.1/setup.cfg [metadata] name = debhello version = attr: debhello.__version__ description = Hello Python (CLI) long_description = file: README.md classifiers = Development Status :: 5 - Production/Stable Intended Audience :: Developers Topic :: System :: Archiving :: Packaging License :: OSI Approved :: MIT License Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3.5 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 author = Osamu Aoki author_email = osamu@debian.org maintainer = Osamu Aoki maintainer_email = osamu@debian.org url = https://salsa.debian.org/debian/debmake-doc project_urls = Documentation = https://salsa.debian.org/debian/debmake-doc keywords = debhello license = MIT [options] package_dir = = src packages = find: python_requires = >=3.4 setup_requires = setuptools >= 42 [options.packages.find] where = src [options.entry_points] console_scripts = hello = debhello.__main__:main
pyproject.toml (v=1.1) — PEP 517 configuration.
$ cat debhello-1.1/pyproject.toml [build-system] requires = [ "setuptools>=42", "wheel" ] build-backend = "setuptools.build_meta"
MANIFEST.in (v=1.1) — for distutils to make sdist.
$ cat debhello-1.1/MANIFEST.in include data/* include manpages/*
src/debhello/__init__.py (v=1.1) — program version definition.
$ cat debhello-1.1/src/debhello/__init__.py __version__ = '1.1.0'
src/debhello/__main__.py (v=1.1) — command entry point.
$ cat debhello-1.1/src/debhello/__main__.py """ debhello command line entry (enable python -m debhello syntax) """ import sys import debhello def main(): # needed for console script print(' ========== Hello Python3 ==========') print('argv = {}'.format(sys.argv)) print('version = {}'.format(debhello.__version__)) return if __name__ == "__main__": sys.exit(main())
讓我們使用 debmake 命令來打包。這裡使用 -b':py3' 選項來指明生成的二進位制包包含 Python3 指令碼和模組檔案。
$ cd debhello-1.1 $ debmake -b':py3' -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.1", rev="1" I: *** start packaging in "debhello-1.1". *** I: provide debhello_1.1.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.1.tar.gz debhello_1.1.orig.tar.gz I: pwd = "/path/to/debhello-1.1" I: parse binary package settings: :py3 I: binary package=debhello Type=python3 / Arch=all M-A=foreign I: analyze the source tree W: unknown python version. check setup.py. I: build_type = I: scan source for copyright+license text and file extensions ...
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=1.1):.
$ cat debhello-1.1/debian/rules #!/usr/bin/make -f # You must remove unused comment lines for the released package. #export DH_VERBOSE = 1 %: dh $@ --with python3
這基本上是帶有 dh 命令的標準 debian/rules 檔案。
使用“--with python3”選項會呼叫 dh_python3 來計算 Python 依賴項、將維護者指令碼新增到位元組碼檔案等。參見 dh_python3(1)。
使用“--buildsystem=pybuild”選項會為要求的 Python 版本呼叫各種構建系統,以便構建模組和擴充套件。參見 pybuild(1)。
debian/control(模板檔案,v=1.1):.
$ cat debhello-1.1/debian/control Source: debhello Section: unknown Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13), dh-python, python3-all Standards-Version: 4.5.1 Homepage: <insert the upstream URL, if relevant> Rules-Requires-Root: no Package: debhello Architecture: all Multi-Arch: foreign Depends: ${misc:Depends}, ${python3:Depends} Description: auto-generated package by debmake This Debian binary package was auto-generated by the debmake(1) command provided by the debmake package.
因為這是 Python3 套件,debmake 命令會設定“Architecture: all”和“Multi-Arch: foreign”。此外,它還將所需的 substvar 引數設定為“Depends: ${python3:Depends}, ${misc:Depends}”。Chapter 5, 基本內容 對這些做出瞭解釋。
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=1.1):.
$ vim debhello-1.1/debian/rules ... hack, hack, hack, ... $ cat debhello-1.1/debian/rules #!/usr/bin/make -f export PYBUILD_NAME=debhello export PYBUILD_VERBOSE=1 export DH_VERBOSE=1 %: dh $@ --with python3 --buildsystem=pybuild
debian/control(維護者版本,v=1.1):.
$ vim debhello-1.1/debian/control ... hack, hack, hack, ... $ cat debhello-1.1/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13), dh-python, python3-all, python3-setuptools Standards-Version: 4.5.1 Rules-Requires-Root: no Vcs-Browser: https://salsa.debian.org/debian/debmake-doc Vcs-Git: https://salsa.debian.org/debian/debmake-doc.git Homepage: https://salsa.debian.org/debian/debmake-doc Package: debhello Architecture: all Depends: ${misc:Depends}, ${python3:Depends} Description: Simple packaging example for debmake This is an example package to demonstrate Debian packaging using the debmake command. . The generated Debian package uses the dh command offered by the debhelper package and the dpkg source format `3.0 (quilt)'.
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
This debhello command comes with the upstream-provided manpage and desktop file but the upstream setup.cfg doesn’t install them. So you need to update debian/install and debian/manpages as follows:
debian/install (maintainer version, v=1.1):
$ vim debhello-1.1/debian/install ... hack, hack, hack, ... $ cat debhello-1.1/debian/install data/hello.desktop usr/share/applications data/hello.png usr/share/pixmaps
debian/manpages (maintainer version, v=1.1):
$ vim debhello-1.1/debian/manpages ... hack, hack, hack, ... $ cat debhello-1.1/debian/manpages manpages/hello.1
其餘的打包工作與 Section 8.3, “Makefile(shell,命令列介面)” 中的幾乎一致。
debian/ 目錄下的模板檔案。(v=1.1):.
$ tree debhello-1.1/debian debhello-1.1/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── install ├── manpages ├── patches │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 16 files
此處是生成的 debhello_1.1-1_all.deb 包的依賴項列表。
debhello_1.1-1_all.deb 的依賴項列表:.
$ dpkg -f debhello_1.1-1_all.deb pre-depends depends recommends conflicts br... Depends: python3:any
此處是一個從 POSIX shell 圖形介面程式構建簡單的 Debian 套件的範例,我們假設程式使用 Makefile 作為構建系統。
上游是基於 Section 8.3, “Makefile(shell,命令列介面)” 中的原始碼,並帶有增強的圖形介面支持。
讓我們假設上游的原始碼套件為 debhello-1.2.tar.gz。
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.2.tar.gz.
$ wget http://www.example.org/download/debhello-1.2.tar.gz ... $ tar -xzmf debhello-1.2.tar.gz $ tree . ├── debhello-1.2 │ ├── LICENSE │ ├── Makefile │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ └── hello.1 │ └── scripts │ └── hello └── debhello-1.2.tar.gz 4 directories, 7 files
此處的 hello 已經被重寫以便使用 zenity 命令來使其成為 GTK+ 圖形介面程序。
hello(v=1.2).
$ cat debhello-1.2/scripts/hello #!/bin/sh -e zenity --info --title "hello" --text "Hello from the shell!"
這裡,作為圖形介面程式,桌面檔案被更新為 Terminal=false。
hello.desktop(v=1.2).
$ cat debhello-1.2/data/hello.desktop [Desktop Entry] Name=Hello Name[fr]=Bonjour Comment=Greetings Comment[fr]=Salutations Type=Application Keywords=hello Exec=hello Terminal=false Icon=hello.png Categories=Utility;
其餘的所有檔案都與 Section 8.3, “Makefile(shell,命令列介面)” 中的一致。
讓我們使用 debmake 命令來打包。這裡使用 -b':sh' 選項來指明生成的二進位制包是一個 shell 指令碼。
$ cd debhello-1.2 $ debmake -b':sh' -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.2", rev="1" I: *** start packaging in "debhello-1.2". *** I: provide debhello_1.2.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.2.tar.gz debhello_1.2.orig.tar.gz I: pwd = "/path/to/debhello-1.2" I: parse binary package settings: :sh I: binary package=debhello Type=script / Arch=all M-A=foreign I: analyze the source tree I: build_type = make I: scan source for copyright+license text and file extensions I: 33 %, ext = desktop ...
讓我們來檢查一下自動產生的模板檔案。
debian/control(模板檔案,v=1.2):.
$ cat debhello-1.2/debian/control Source: debhello Section: unknown Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13) Standards-Version: 4.5.1 Homepage: <insert the upstream URL, if relevant> Rules-Requires-Root: no Package: debhello Architecture: all Multi-Arch: foreign Depends: ${misc:Depends} Description: auto-generated package by debmake This Debian binary package was auto-generated by the debmake(1) command provided by the debmake package.
作為維護者,我們要把這個 Debian 套件做得更好。
debian/control(維護者版本,v=1.2):.
$ vim debhello-1.2/debian/control ... hack, hack, hack, ... $ cat debhello-1.2/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13) Standards-Version: 4.5.1 Homepage: https://salsa.debian.org/debian/debmake-doc Rules-Requires-Root: no Package: debhello Architecture: all Multi-Arch: foreign Depends: zenity, ${misc:Depends} Description: Simple packaging example for debmake This Debian binary package is an example package. (This is an example only)
請注意,這裡需要手動新增 zenity 依賴。
debian/rules 檔案與 Section 8.3, “Makefile(shell,命令列介面)” 中的完全一致。
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
debian/ 目錄下的模板檔案。(v=1.2):.
$ tree debhello-1.2/debian debhello-1.2/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── patches │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 14 files
其餘的打包工作與 Section 8.3, “Makefile(shell,命令列介面)” 中的幾乎一致。
此處是 debhello_1.2-1_all.deb 的依賴項列表。
debhello_1.2-1_all.deb 的依賴項列表:.
$ dpkg -f debhello_1.2-1_all.deb pre-depends depends recommends conflicts br... Depends: zenity
Here is an example of creating a simple Debian package from a Python3 GUI program using the setuptools based setup.py as its build system.
上游是基於 Section 8.4, “setup.py(Python3,命令列介面)” 中的原始碼,並帶有增強的圖形介面、桌面圖示、手冊頁。
讓我們假設上游原始碼套件為 debhello-1.3.tar.gz。
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.3.tar.gz.
$ wget http://www.example.org/download/debhello-1.3.tar.gz ... $ tar -xzmf debhello-1.3.tar.gz $ tree . ├── debhello-1.3 │ ├── LICENSE │ ├── MANIFEST.in │ ├── README.md │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── manpages │ │ └── hello.1 │ ├── pyproject.toml │ ├── setup.cfg │ ├── setup.py │ └── src │ └── debhello │ ├── __init__.py │ └── __main__.py └── debhello-1.3.tar.gz 5 directories, 12 files
Here, the content of this debhello source tree as follows.
setup.py (v=1.3) — a boilar plate setup.py for the backward compatibility.
$ cat debhello-1.3/setup.py import setuptools setuptools.setup()
setup.cfg (v=1.3) — modern static metadata.
$ cat debhello-1.3/setup.cfg [metadata] name = debhello version = attr: debhello.__version__ description = Hello Python (GUI) long_description = file: README.md classifiers = Development Status :: 5 - Production/Stable Intended Audience :: Developers Topic :: System :: Archiving :: Packaging License :: OSI Approved :: MIT License Programming Language :: Python Programming Language :: Python :: 3 Programming Language :: Python :: 3.5 Programming Language :: Python :: 3.6 Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 author = Osamu Aoki author_email = osamu@debian.org maintainer = Osamu Aoki maintainer_email = osamu@debian.org url = https://salsa.debian.org/debian/debmake-doc project_urls = Documentation = https://salsa.debian.org/debian/debmake-doc keywords = debhello license = MIT [options] package_dir = = src packages = find: python_requires = >=3.4 setup_requires = setuptools >= 42 [options.packages.find] where = src [options.entry_points] console_scripts = hello = debhello.__main__:main
pyproject.toml (v=1.3) — PEP 517 configuration.
$ cat debhello-1.3/pyproject.toml [build-system] requires = [ "setuptools>=42", "wheel" ] build-backend = "setuptools.build_meta"
MANIFEST.in (v=1.3) — for distutils to make sdist.
$ cat debhello-1.3/MANIFEST.in include data/* include manpages/*
src/debhello/__init__.py (v=1.3) — program version definition.
$ cat debhello-1.3/src/debhello/__init__.py __version__ = '1.3.0'
src/debhello/__main__.py (v=1.3) — command entry point.
$ cat debhello-1.3/src/debhello/__main__.py #!/usr/bin/python3 from gi.repository import Gtk class TopWindow(Gtk.Window): def __init__(self): Gtk.Window.__init__(self) self.title = "Hello World!" self.counter = 0 self.border_width = 10 self.set_default_size(400, 100) self.set_position(Gtk.WindowPosition.CENTER) self.button = Gtk.Button(label="Click me!") self.button.connect("clicked", self.on_button_clicked) self.add(self.button) self.connect("delete-event", self.on_window_destroy) def on_window_destroy(self, *args): Gtk.main_quit(*args) def on_button_clicked(self, widget): self.counter += 1 widget.set_label("Hello, World!\nClick count = %i" % self.counter) def main(): window = TopWindow() window.show_all() Gtk.main() if __name__ == '__main__': main()
讓我們使用 debmake 命令來打包。這裡使用 -b':py3' 選項來指明生成的二進位制包包含 Python3 指令碼和模組檔案。
$ cd debhello-1.3 $ debmake -b':py3' -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.3", rev="1" I: *** start packaging in "debhello-1.3". *** I: provide debhello_1.3.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.3.tar.gz debhello_1.3.orig.tar.gz I: pwd = "/path/to/debhello-1.3" I: parse binary package settings: :py3 I: binary package=debhello Type=python3 / Arch=all M-A=foreign I: analyze the source tree W: unknown python version. check setup.py. I: build_type = I: scan source for copyright+license text and file extensions ...
其餘的步驟與 Section 8.4, “setup.py(Python3,命令列介面)” 中的基本一致。
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=1.3):.
$ vim debhello-1.3/debian/rules ... hack, hack, hack, ... $ cat debhello-1.3/debian/rules #!/usr/bin/make -f export PYBUILD_NAME=debhello export PYBUILD_VERBOSE=1 export DH_VERBOSE=1 %: dh $@ --with python3 --buildsystem=pybuild
debian/control(維護者版本,v=1.3):.
$ vim debhello-1.3/debian/control ... hack, hack, hack, ... $ cat debhello-1.3/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13), dh-python, python3-all Standards-Version: 4.5.1 Homepage: https://salsa.debian.org/debian/debmake-doc Rules-Requires-Root: no Package: debhello Architecture: all Multi-Arch: foreign Depends: gir1.2-gtk-3.0, python3-gi, ${misc:Depends}, ${python3:Depends} Description: Simple packaging example for debmake This Debian binary package is an example package. (This is an example only)
請注意,此處需要手動新增 python3-gi 和 gir1.2-gtk-3.0 依賴。
其餘的打包工作與 Section 8.4, “setup.py(Python3,命令列介面)” 中的幾乎完全一致。
此處是 debhello_1.3-1_all.deb 的依賴項列表。
debhello_1.3-1_all.deb 的依賴項列表:.
$ dpkg -f debhello_1.3-1_all.deb pre-depends depends recommends conflicts br... Depends: gir1.2-gtk-3.0, python3-gi, python3:any
這裡給出了從簡單的 C 語言原始碼建立簡單的 Debian 套件的例子,並假設上游使用了 Makefile 作為構建系統。
此處的上游原始碼是 Chapter 4, 簡單例子 中的原始碼的增強版本。它帶有手冊頁、桌面檔案和桌面圖示。並且為了更加貼合實際,它還有一個外部程式庫檔案 libm。
讓我們假設上游原始碼套件為 debhello-1.4.tar.gz。
這一類原始碼設計可以用這樣的方式安裝成為非系統檔案:
$ tar -xzmf debhello-1.4.tar.gz $ cd debhello-1.4 $ make $ make install
Debian 的打包需要對“make install”流程進行改變,從而將檔案安裝至系統映象所在位置,而非通常使用的 /usr/local 下的位置。
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.4.tar.gz.
$ wget http://www.example.org/download/debhello-1.4.tar.gz ... $ tar -xzmf debhello-1.4.tar.gz $ tree . ├── debhello-1.4 │ ├── LICENSE │ ├── Makefile │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ └── hello.1 │ └── src │ ├── config.h │ └── hello.c └── debhello-1.4.tar.gz 4 directories, 8 files
此處的原始碼如下所示。
src/hello.c(v=1.4):.
$ cat debhello-1.4/src/hello.c #include "config.h" #include <math.h> #include <stdio.h> int main() { printf("Hello, I am " PACKAGE_AUTHOR "!\n"); printf("4.0 * atan(1.0) = %10f8\n", 4.0*atan(1.0)); return 0; }
src/config.h(v=1.4):.
$ cat debhello-1.4/src/config.h #define PACKAGE_AUTHOR "Osamu Aoki"
Makefile(v=1.4):.
$ cat debhello-1.4/Makefile prefix = /usr/local all: src/hello src/hello: src/hello.c $(CC) $(CPPFLAGS) $(CFLAGS) $(LDFLAGS) -o $@ $^ -lm install: src/hello install -D src/hello \ $(DESTDIR)$(prefix)/bin/hello install -m 644 -D data/hello.desktop \ $(DESTDIR)$(prefix)/share/applications/hello.desktop install -m 644 -D data/hello.png \ $(DESTDIR)$(prefix)/share/pixmaps/hello.png install -m 644 -D man/hello.1 \ $(DESTDIR)$(prefix)/share/man/man1/hello.1 clean: -rm -f src/hello distclean: clean uninstall: -rm -f $(DESTDIR)$(prefix)/bin/hello -rm -f $(DESTDIR)$(prefix)/share/applications/hello.desktop -rm -f $(DESTDIR)$(prefix)/share/pixmaps/hello.png -rm -f $(DESTDIR)$(prefix)/share/man/man1/hello.1 .PHONY: all install clean distclean uninstall
請注意,此 Makefile 含有正確的手冊頁、桌面檔案、桌面圖示的 install 物件。
讓我們使用 debmake 命令打包。
$ cd debhello-1.4 $ debmake -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.4", rev="1" I: *** start packaging in "debhello-1.4". *** I: provide debhello_1.4.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.4.tar.gz debhello_1.4.orig.tar.gz I: pwd = "/path/to/debhello-1.4" 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: 40 %, ext = c ...
其餘的工作與 Section 4.6, “第二步:使用 debmake 產生模板檔案” 中的幾乎一致。
像 Section 4.7, “第三步:編輯模板檔案” 中所寫的一樣,讓我們這些維護者來把這個 Debian 套件做的更好。
如果環境變數 DEB_BUILD_MAINT_OPTIONS 沒有在 debian/rules 檔案中進行匯出,lintian 會在連結 libm 時丟擲警告:“W: debhello: hardening-no-relro usr/bin/hello”。
debian/control 檔案與 Section 4.7, “第三步:編輯模板檔案” 中的完全一致,因為 libm 程式庫是 libc6 程式庫的一部分,所以它總是可獲得的(優先順序:必需 / Priority: required)。
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
debian/ 目錄下的模板檔案。(v=1.4):.
$ tree debhello-1.4/debian debhello-1.4/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── patches │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 14 files
其餘的打包步驟與 Section 4.8, “第四步:使用 debuild 構建套件” 中的基本一致。
此處是生成的二進位制包的依賴項列表。
生成的二進位制包的依賴項列表(v=1.4):.
$ dpkg -f debhello-dbgsym_1.4-1_amd64.deb pre-depends depends recommends con... Depends: debhello (= 1.4-1) $ dpkg -f debhello_1.4-1_amd64.deb pre-depends depends recommends conflicts ... Depends: libc6 (>= 2.3.4)
這裡給出了從簡單的 C 語言原始碼建立簡單的 Debian 套件的例子,並假設上游使用了 Makefile.in 和 configure 作為構建系統。
此處的原始碼範例是 Section 8.7, “Makefile(單個二進位制套件)” 中的原始碼的增強版本。它也有一個外部連結程式庫 libm,並且它的原始碼可以使用 configure 指令碼進行配置,然後生成相應的 Makefile、src/config.h 檔案。
讓我們假設上游原始碼套件為 debhello-1.5.tar.gz。
此型別的原始碼旨在作為非系統檔案安裝,例如:
$ tar -xzmf debhello-1.5.tar.gz $ cd debhello-1.5 $ ./configure --with-math $ make $ make install
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.5.tar.gz.
$ wget http://www.example.org/download/debhello-1.5.tar.gz ... $ tar -xzmf debhello-1.5.tar.gz $ tree . ├── debhello-1.5 │ ├── LICENSE │ ├── Makefile.in │ ├── configure │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ └── hello.1 │ └── src │ └── hello.c └── debhello-1.5.tar.gz 4 directories, 8 files
此處的原始碼如下所示。
src/hello.c(v=1.5):.
$ cat debhello-1.5/src/hello.c #include "config.h" #ifdef WITH_MATH # include <math.h> #endif #include <stdio.h> int main() { printf("Hello, I am " PACKAGE_AUTHOR "!\n"); #ifdef WITH_MATH printf("4.0 * atan(1.0) = %10f8\n", 4.0*atan(1.0)); #else printf("I can't do MATH!\n"); #endif return 0; }
Makefile.in(v=1.5):.
$ cat debhello-1.5/Makefile.in prefix = @prefix@ all: src/hello src/hello: src/hello.c $(CC) @VERBOSE@ \ $(CPPFLAGS) \ $(CFLAGS) \ $(LDFLAGS) \ -o $@ $^ \ @LINKLIB@ install: src/hello install -D src/hello \ $(DESTDIR)$(prefix)/bin/hello install -m 644 -D data/hello.desktop \ $(DESTDIR)$(prefix)/share/applications/hello.desktop install -m 644 -D data/hello.png \ $(DESTDIR)$(prefix)/share/pixmaps/hello.png install -m 644 -D man/hello.1 \ $(DESTDIR)$(prefix)/share/man/man1/hello.1 clean: -rm -f src/hello distclean: clean uninstall: -rm -f $(DESTDIR)$(prefix)/bin/hello -rm -f $(DESTDIR)$(prefix)/share/applications/hello.desktop -rm -f $(DESTDIR)$(prefix)/share/pixmaps/hello.png -rm -f $(DESTDIR)$(prefix)/share/man/man1/hello.1 .PHONY: all install clean distclean uninstall
configure(v=1.5):.
$ cat debhello-1.5/configure #!/bin/sh -e # default values PREFIX="/usr/local" VERBOSE="" WITH_MATH="0" LINKLIB="" PACKAGE_AUTHOR="John Doe" # parse arguments while [ "${1}" != "" ]; do VAR="${1%=*}" # Drop suffix =* VAL="${1#*=}" # Drop prefix *= case "${VAR}" in --prefix) PREFIX="${VAL}" ;; --verbose|-v) VERBOSE="-v" ;; --with-math) WITH_MATH="1" LINKLIB="-lm" ;; --author) PACKAGE_AUTHOR="${VAL}" ;; *) echo "W: Unknown argument: ${1}" esac shift done # setup configured Makefile and src/config.h sed -e "s,@prefix@,${PREFIX}," \ -e "s,@VERBOSE@,${VERBOSE}," \ -e "s,@LINKLIB@,${LINKLIB}," \ <Makefile.in >Makefile if [ "${WITH_MATH}" = 1 ]; then echo "#define WITH_MATH" >src/config.h else echo "/* not defined: WITH_MATH */" >src/config.h fi echo "#define PACKAGE_AUTHOR \"${PACKAGE_AUTHOR}\"" >>src/config.h
請注意,configure 命令替換 Makefile.in 檔案中的 @…@ 字串以生成 Makefile 與 src/config.h。
讓我們使用 debmake 命令打包。
$ cd debhello-1.5 $ debmake -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.5", rev="1" I: *** start packaging in "debhello-1.5". *** I: provide debhello_1.5.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.5.tar.gz debhello_1.5.orig.tar.gz I: pwd = "/path/to/debhello-1.5" I: parse binary package settings: I: binary package=debhello Type=bin / Arch=any M-A=foreign I: analyze the source tree I: build_type = configure I: scan source for copyright+license text and file extensions I: 20 %, ext = in ...
結果與 Section 4.6, “第二步:使用 debmake 產生模板檔案” 中的相似,但是並不完全一致。
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=1.5):.
$ cat debhello-1.5/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,--as-needed %: dh $@
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=1.5):.
$ vim debhello-1.5/debian/rules ... hack, hack, hack, ... $ cat debhello-1.5/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_configure: dh_auto_configure -- \ --with-math \ --author="Osamu Aoki"
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
其餘的打包步驟與 Section 4.8, “第四步:使用 debuild 構建套件” 中的基本一致。
這裡給出了從簡單的 C 語言原始碼建立簡單的 Debian 套件的例子,並假設上游使用了 Autotools = Autoconf (Makefile.am 和 configure.ac) 作為構建系統。參見 Section 5.18.1, “Autotools”。
此種原始碼通常也帶有上游自動生成的 Makefile.in 和 configure 檔案。在 autotools-dev 套件的幫助下,我們可以按 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中所介紹的,使用這些檔案進行打包。
更好的做法是,如果上游提供的 Makefile.am 和 configure.ac 相容最新版本,我們可以使用最新的 Autoconf 和 Automake 套件重新生成這些(Makefile 和 configure)檔案。這麼做有利於移植到新的 CPU 架構上等優勢。此項工作可以使用帶有 “--with autoreconf” 選項的 dh 命令來自動化。
讓我們假設上游的原始碼套件為 debhello-1.6.tar.gz。
此型別的原始碼旨在作為非系統檔案安裝,例如:
$ tar -xzmf debhello-1.6.tar.gz $ cd debhello-1.6 $ autoreconf -ivf # optional $ ./configure --with-math $ make $ make install
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.6.tar.gz.
$ wget http://www.example.org/download/debhello-1.6.tar.gz ... $ tar -xzmf debhello-1.6.tar.gz $ tree . ├── debhello-1.6 │ ├── LICENSE │ ├── Makefile.am │ ├── configure.ac │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ ├── Makefile.am │ │ └── hello.1 │ └── src │ ├── Makefile.am │ └── hello.c └── debhello-1.6.tar.gz 4 directories, 10 files
此處的原始碼如下所示。
src/hello.c(v=1.6):.
$ cat debhello-1.6/src/hello.c #include "config.h" #ifdef WITH_MATH # include <math.h> #endif #include <stdio.h> int main() { printf("Hello, I am " PACKAGE_AUTHOR "!\n"); #ifdef WITH_MATH printf("4.0 * atan(1.0) = %10f8\n", 4.0*atan(1.0)); #else printf("I can't do MATH!\n"); #endif return 0; }
Makefile.am(v=1.6):.
$ cat debhello-1.6/Makefile.am SUBDIRS = src man $ cat debhello-1.6/man/Makefile.am dist_man_MANS = hello.1 $ cat debhello-1.6/src/Makefile.am bin_PROGRAMS = hello hello_SOURCES = hello.c
configure.ac(v=1.6):.
$ cat debhello-1.6/configure.ac # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. AC_PREREQ([2.69]) AC_INIT([debhello],[2.1],[foo@example.org]) AC_CONFIG_SRCDIR([src/hello.c]) AC_CONFIG_HEADERS([config.h]) echo "Standard customization chores" AC_CONFIG_AUX_DIR([build-aux]) AM_INIT_AUTOMAKE([foreign]) # Add #define PACKAGE_AUTHOR ... in config.h with a comment AC_DEFINE(PACKAGE_AUTHOR, ["Osamu Aoki"], [Define PACKAGE_AUTHOR]) echo "Add --with-math option functionality to ./configure" AC_ARG_WITH([math], [AS_HELP_STRING([--with-math], [compile with math library @<:@default=yes@:>@])], [], [with_math="yes"] ) echo "==== withval := \"$withval\"" echo "==== with_math := \"$with_math\"" # m4sh if-else construct AS_IF([test "x$with_math" != "xno"],[ echo "==== Check include: math.h" AC_CHECK_HEADER(math.h,[],[ AC_MSG_ERROR([Couldn't find math.h.] ) ]) echo "==== Check library: libm" AC_SEARCH_LIBS(atan, [m]) #AC_CHECK_LIB(m, atan) echo "==== Build with LIBS := \"$LIBS\"" AC_DEFINE(WITH_MATH, [1], [Build with the math library]) ],[ echo "==== Skip building with math.h." AH_TEMPLATE(WITH_MATH, [Build without the math library]) ]) # Checks for programs. AC_PROG_CC AC_CONFIG_FILES([Makefile man/Makefile src/Makefile]) AC_OUTPUT
![]() |
Tip |
---|---|
如果沒有像上述例子中,在 AM_INIT_AUTOMAKE() 中指定嚴格級別(strictness level)為 “foreign”,那麼 automake 會預設嚴格級別為 “gnu”,並需要在頂級目錄中有若干檔案。參見 automake 文件的 “3.2 Strictness”。 |
讓我們使用 debmake 命令打包。
$ cd debhello-1.6 $ debmake -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.6", rev="1" I: *** start packaging in "debhello-1.6". *** I: provide debhello_1.6.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.6.tar.gz debhello_1.6.orig.tar.gz I: pwd = "/path/to/debhello-1.6" I: parse binary package settings: I: binary package=debhello Type=bin / Arch=any M-A=foreign I: analyze the source tree I: build_type = Autotools with autoreconf I: scan source for copyright+license text and file extensions I: 38 %, ext = am ...
結果與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的類似,但是並不完全一致。
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=1.6):
$ cat debhello-1.6/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,--as-needed %: dh $@ --with autoreconf #override_dh_install: # dh_install --list-missing -X.la -X.pyc -X.pyo
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=1.6):.
$ vim debhello-1.6/debian/rules ... hack, hack, hack, ... $ cat debhello-1.6/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 $@ --with autoreconf override_dh_auto_configure: dh_auto_configure -- \ --with-math
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
其餘的打包步驟與 Section 4.8, “第四步:使用 debuild 構建套件” 中的基本一致。
此處是一個從簡單的 C 語言原始碼程式生成簡單的 Debian 套件的範例,我們假設上游使用 CMake(CMakeLists.txt 和若干形似 config.h.in 的檔案)作為構建系統。參見 Section 5.18.2, “CMake”。
cmake 命令根據 CMakeLists.txt 檔案和它的 -D 選項來生成 Makefile 檔案。此外,它還會根據 configure_file(…) 中指定的條目來替換帶有 @…@ 的字串、更改 #cmakedefine …。
讓我們假設上游的原始碼套件為 debhello-1.7.tar.gz。
此型別的原始碼旨在作為非系統檔案安裝,例如:
$ tar -xzmf debhello-1.7.tar.gz $ cd debhello-1.7 $ mkdir obj-x86_64-linux-gnu # for out-of-tree build $ cd obj-x86_64-linux-gnu $ cmake .. $ make $ make install
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-1.7.tar.gz.
$ wget http://www.example.org/download/debhello-1.7.tar.gz ... $ tar -xzmf debhello-1.7.tar.gz $ tree . ├── debhello-1.7 │ ├── CMakeLists.txt │ ├── LICENSE │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── man │ │ ├── CMakeLists.txt │ │ └── hello.1 │ └── src │ ├── CMakeLists.txt │ ├── config.h.in │ └── hello.c └── debhello-1.7.tar.gz 4 directories, 10 files
此處的原始碼如下所示。
src/hello.c(v=1.7):.
$ cat debhello-1.7/src/hello.c #include "config.h" #ifdef WITH_MATH # include <math.h> #endif #include <stdio.h> int main() { printf("Hello, I am " PACKAGE_AUTHOR "!\n"); #ifdef WITH_MATH printf("4.0 * atan(1.0) = %10f8\n", 4.0*atan(1.0)); #else printf("I can't do MATH!\n"); #endif return 0; }
src/config.h.in(v=1.7):.
$ cat debhello-1.7/src/config.h.in /* name of the package author */ #define PACKAGE_AUTHOR "@PACKAGE_AUTHOR@" /* math library support */ #cmakedefine WITH_MATH
CMakeLists.txt(v=1.7):.
$ cat debhello-1.7/CMakeLists.txt cmake_minimum_required(VERSION 2.8) project(debhello) set(PACKAGE_AUTHOR "Osamu Aoki") add_subdirectory(src) add_subdirectory(man) $ cat debhello-1.7/man/CMakeLists.txt install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/hello.1 DESTINATION share/man/man1 ) $ cat debhello-1.7/src/CMakeLists.txt # Always define HAVE_CONFIG_H add_definitions(-DHAVE_CONFIG_H) # Interactively define WITH_MATH option(WITH_MATH "Build with math support" OFF) #variable_watch(WITH_MATH) # Generate config.h from config.h.in configure_file( "${CMAKE_CURRENT_SOURCE_DIR}/config.h.in" "${CMAKE_CURRENT_BINARY_DIR}/config.h" ) include_directories("${CMAKE_CURRENT_BINARY_DIR}") add_executable(hello hello.c) install(TARGETS hello RUNTIME DESTINATION bin )
讓我們使用 debmake 命令打包。
$ cd debhello-1.7 $ debmake -e osamu@debian.org -f 'Osamu Aoki' I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="1.7", rev="1" I: *** start packaging in "debhello-1.7". *** I: provide debhello_1.7.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-1.7.tar.gz debhello_1.7.orig.tar.gz I: pwd = "/path/to/debhello-1.7" I: parse binary package settings: I: binary package=debhello Type=bin / Arch=any M-A=foreign I: analyze the source tree I: build_type = Cmake I: scan source for copyright+license text and file extensions I: 38 %, ext = text ...
結果與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的類似,但是並不完全一致。
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=1.7):.
$ cat debhello-1.7/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,--as-needed %: dh $@ #override_dh_auto_configure: # dh_auto_configure -- \ # -DCMAKE_LIBRARY_ARCHITECTURE="$(DEB_TARGET_MULTIARCH)"
debian/control(模板檔案,v=1.7):.
$ cat debhello-1.7/debian/control Source: debhello Section: unknown Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: cmake, debhelper-compat (= 13) Standards-Version: 4.5.1 Homepage: <insert the upstream URL, if relevant> Rules-Requires-Root: no 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.
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=1.7):.
$ vim debhello-1.7/debian/rules ... hack, hack, hack, ... $ cat debhello-1.7/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_configure: dh_auto_configure -- -DWITH-MATH=1
debian/control(維護者版本,v=1.7):.
$ vim debhello-1.7/debian/control ... hack, hack, hack, ... $ cat debhello-1.7/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: cmake, debhelper-compat (= 13) Standards-Version: 4.5.1 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/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
其餘的打包工作與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的近乎一致。
此處是從一個簡單的 C 語言原始碼程式建立一個包含可執行套件、共享程式庫包、開發檔案包和除錯符號包的一系列 Debian 二進位制包的範例,我們假設上游使用 Autotools = Autoconf 和 Automake (使用 Makefile.am 和 configure.ac 作為輸入檔案)作為構建系統。參見 Section 5.18.1, “Autotools”。
讓我們用與 Section 8.9, “Autotools(單個二進位制檔案)” 中的相同的方式打包。
讓我們假設上游原始碼套件為 debhello-2.0.tar.gz。
此型別的原始碼旨在作為非系統檔案安裝,例如:
$ tar -xzmf debhello-2.0.tar.gz $ cd debhello-2.0 $ autoreconf -ivf # optional $ ./configure --with-math $ make $ make install
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-2.0.tar.gz.
$ wget http://www.example.org/download/debhello-2.0.tar.gz ... $ tar -xzmf debhello-2.0.tar.gz $ tree . ├── debhello-2.0 │ ├── LICENSE │ ├── Makefile.am │ ├── configure.ac │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── lib │ │ ├── Makefile.am │ │ ├── sharedlib.c │ │ └── sharedlib.h │ ├── man │ │ ├── Makefile.am │ │ └── hello.1 │ └── src │ ├── Makefile.am │ └── hello.c └── debhello-2.0.tar.gz 5 directories, 13 files
此處的原始碼如下所示。
src/hello.c(v=2.0):.
$ cat debhello-2.0/src/hello.c #include "config.h" #include <stdio.h> #include <sharedlib.h> int main() { printf("Hello, I am " PACKAGE_AUTHOR "!\n"); sharedlib(); return 0; }
lib/sharedlib.h 與 lib/sharedlib.c(v=1.6):.
$ cat debhello-2.0/lib/sharedlib.h int sharedlib(); $ cat debhello-2.0/lib/sharedlib.c #include <stdio.h> int sharedlib() { printf("This is a shared library!\n"); return 0; }
Makefile.am(v=2.0):.
$ cat debhello-2.0/Makefile.am # recursively process `Makefile.am` in SUBDIRS SUBDIRS = lib src man $ cat debhello-2.0/man/Makefile.am # manpages (distributed in the source package) dist_man_MANS = hello.1 $ cat debhello-2.0/lib/Makefile.am # libtool librares to be produced lib_LTLIBRARIES = libsharedlib.la # source files used for lib_LTLIBRARIES libsharedlib_la_SOURCES = sharedlib.c # C pre-processor flags used for lib_LTLIBRARIES #libsharedlib_la_CPPFLAGS = # Headers files to be installed in <prefix>/include include_HEADERS = sharedlib.h # Versioning Libtool Libraries with version triplets libsharedlib_la_LDFLAGS = -version-info 1:0:0 $ cat debhello-2.0/src/Makefile.am # program executables to be produced bin_PROGRAMS = hello # source files used for bin_PROGRAMS hello_SOURCES = hello.c # C pre-processor flags used for bin_PROGRAMS AM_CPPFLAGS = -I$(srcdir) -I$(top_srcdir)/lib # Extra options for the linker for hello # hello_LDFLAGS = # Libraries the `hello` binary to be linked hello_LDADD = $(top_srcdir)/lib/libsharedlib.la
configure.ac(v=2.0):.
$ cat debhello-2.0/configure.ac # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. AC_PREREQ([2.69]) AC_INIT([debhello],[2.2],[foo@example.org]) AC_CONFIG_SRCDIR([src/hello.c]) AC_CONFIG_HEADERS([config.h]) echo "Standard customization chores" AC_CONFIG_AUX_DIR([build-aux]) AM_INIT_AUTOMAKE([foreign]) # Set default to --enable-shared --disable-static LT_INIT([shared disable-static]) # find the libltdl sources in the libltdl sub-directory LT_CONFIG_LTDL_DIR([libltdl]) # choose one LTDL_INIT([recursive]) #LTDL_INIT([subproject]) #LTDL_INIT([nonrecursive]) # Add #define PACKAGE_AUTHOR ... in config.h with a comment AC_DEFINE(PACKAGE_AUTHOR, ["Osamu Aoki"], [Define PACKAGE_AUTHOR]) # Checks for programs. AC_PROG_CC # only for the recursive case AC_CONFIG_FILES([Makefile lib/Makefile man/Makefile src/Makefile]) AC_OUTPUT
讓我們用 debmake 命令將這些打包到多個包中:
此處的 -b',libsharedlib1,libsharedlib-dev' 選項是用以指明生成的二進位制包。
$ cd debhello-2.0 $ debmake -b',libsharedlib1,libsharedlib-dev' -e osamu@debian.org -f 'Osamu ... I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="2.0", rev="1" I: *** start packaging in "debhello-2.0". *** I: provide debhello_2.0.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-2.0.tar.gz debhello_2.0.orig.tar.gz I: pwd = "/path/to/debhello-2.0" I: parse binary package settings: ,libsharedlib1,libsharedlib-dev I: binary package=debhello Type=bin / Arch=any M-A=foreign I: binary package=libsharedlib1 Type=lib / Arch=any M-A=same I: binary package=libsharedlib-dev Type=dev / Arch=any M-A=same I: analyze the source tree I: build_type = Autotools with autoreconf ...
結果與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的相似,但是這個具有更多的模板檔案。
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=2.0):.
$ cat debhello-2.0/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,--as-needed %: dh $@ --with autoreconf #override_dh_install: # dh_install --list-missing -X.la -X.pyc -X.pyo
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=2.0):.
$ vim debhello-2.0/debian/rules ... hack, hack, hack, ... $ cat debhello-2.0/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 $@ --with autoreconf override_dh_missing: dh_missing -X.la
debian/control(維護者版本,v=2.0):.
$ vim debhello-2.0/debian/control ... hack, hack, hack, ... $ cat debhello-2.0/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: debhelper-compat (= 13), dh-autoreconf Standards-Version: 4.5.1 Homepage: https://salsa.debian.org/debian/debmake-doc Rules-Requires-Root: no Package: debhello Architecture: any Multi-Arch: foreign Depends: libsharedlib1 (= ${binary:Version}), ${misc:Depends}, ${shlibs:Depends} Description: Simple packaging example for debmake This package contains the compiled binary executable. . This Debian binary package is an example package. (This is an example only) Package: libsharedlib1 Section: libs Architecture: any Multi-Arch: same Pre-Depends: ${misc:Pre-Depends} Depends: ${misc:Depends}, ${shlibs:Depends} Description: Simple packaging example for debmake This package contains the shared library. Package: libsharedlib-dev Section: libdevel Architecture: any Multi-Arch: same Depends: libsharedlib1 (= ${binary:Version}), ${misc:Depends} Description: Simple packaging example for debmake This package contains the development files.
debian/*.install(維護者版本,v=2.0):.
$ vim debhello-2.0/debian/debhello.install ... hack, hack, hack, ... $ cat debhello-2.0/debian/debhello.install usr/bin/* usr/share/* $ vim debhello-2.0/debian/libsharedlib1.install ... hack, hack, hack, ... $ cat debhello-2.0/debian/libsharedlib1.install usr/lib/*/*.so.* $ vim debhello-2.0/debian/libsharedlib-dev.install ... hack, hack, hack, ... $ cat debhello-2.0/debian/libsharedlib-dev.install ###usr/lib/*/pkgconfig/*.pc usr/include usr/lib/*/*.so
因為上游原始碼已經具有正確的自動生成的 Makefile 檔案,所以沒有必要再去建立 debian/install 和 debian/manpages 文件。
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
debian/ 目錄下的模板檔案。(v=2.0):.
$ tree debhello-2.0/debian debhello-2.0/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── debhello.install ├── libsharedlib-dev.install ├── libsharedlib1.install ├── libsharedlib1.symbols ├── patches │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 18 files
其餘的打包工作與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的近乎一致。
此處是生成的二進位制包的依賴項列表。
生成的二進位制包的依賴項列表(v=2.0):.
$ dpkg -f debhello-dbgsym_2.0-1_amd64.deb pre-depends depends recommends con... Depends: debhello (= 2.0-1) $ dpkg -f debhello_2.0-1_amd64.deb pre-depends depends recommends conflicts ... Depends: libsharedlib1 (= 2.0-1), libc6 (>= 2.2.5) $ dpkg -f libsharedlib-dev_2.0-1_amd64.deb pre-depends depends recommends co... Depends: libsharedlib1 (= 2.0-1) $ dpkg -f libsharedlib1-dbgsym_2.0-1_amd64.deb pre-depends depends recommend... Depends: libsharedlib1 (= 2.0-1) $ dpkg -f libsharedlib1_2.0-1_amd64.deb pre-depends depends recommends confl... Depends: libc6 (>= 2.2.5)
此處是從一個簡單的 C 語言原始碼程式建立一系列包含可執行套件、共享程式庫包、開發文件包和除錯符號包的 Debian 二進位制包的範例,我們假設上游使用 CMake(CMakeLists.txt 和其他形如 config.h.in 的檔案)作為構建系統。參見 Section 5.18.2, “CMake”。
讓我們假設上游原始碼套件為 debhello-2.1.tar.gz。
此型別的原始碼旨在作為非系統檔案安裝,例如:
$ tar -xzmf debhello-2.1.tar.gz $ cd debhello-2.1 $ mkdir obj-x86_64-linux-gnu $ cd obj-x86_64-linux-gnu $ cmake .. $ make $ make install
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-2.1.tar.gz.
$ wget http://www.example.org/download/debhello-2.1.tar.gz ... $ tar -xzmf debhello-2.1.tar.gz $ tree . ├── debhello-2.1 │ ├── CMakeLists.txt │ ├── LICENSE │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── lib │ │ ├── CMakeLists.txt │ │ ├── sharedlib.c │ │ └── sharedlib.h │ ├── man │ │ ├── CMakeLists.txt │ │ └── hello.1 │ └── src │ ├── CMakeLists.txt │ ├── config.h.in │ └── hello.c └── debhello-2.1.tar.gz 5 directories, 13 files
此處的原始碼如下所示。
src/hello.c(v=2.1):.
$ cat debhello-2.1/src/hello.c #include "config.h" #include <stdio.h> #include <sharedlib.h> int main() { printf("Hello, I am " PACKAGE_AUTHOR "!\n"); sharedlib(); return 0; }
src/config.h.in(v=2.1):.
$ cat debhello-2.1/src/config.h.in /* name of the package author */ #define PACKAGE_AUTHOR "@PACKAGE_AUTHOR@"
lib/sharedlib.c 與 lib/sharedlib.h(v=2.1):.
$ cat debhello-2.1/lib/sharedlib.h int sharedlib(); $ cat debhello-2.1/lib/sharedlib.c #include <stdio.h> int sharedlib() { printf("This is a shared library!\n"); return 0; }
CMakeLists.txt(v=2.1):.
$ cat debhello-2.1/CMakeLists.txt cmake_minimum_required(VERSION 2.8) project(debhello) set(PACKAGE_AUTHOR "Osamu Aoki") add_subdirectory(lib) add_subdirectory(src) add_subdirectory(man) $ cat debhello-2.1/man/CMakeLists.txt install( FILES ${CMAKE_CURRENT_SOURCE_DIR}/hello.1 DESTINATION share/man/man1 ) $ cat debhello-2.1/src/CMakeLists.txt # Always define HAVE_CONFIG_H add_definitions(-DHAVE_CONFIG_H) # Generate config.h from config.h.in configure_file( "${CMAKE_CURRENT_SOURCE_DIR}/config.h.in" "${CMAKE_CURRENT_BINARY_DIR}/config.h" ) include_directories("${CMAKE_CURRENT_BINARY_DIR}") include_directories("${CMAKE_SOURCE_DIR}/lib") add_executable(hello hello.c) target_link_libraries(hello sharedlib) install(TARGETS hello RUNTIME DESTINATION bin )
讓我們使用 debmake 命令打包。
$ cd debhello-2.1 $ debmake -b',libsharedlib1,libsharedlib-dev' -e osamu@debian.org -f 'Osamu ... I: set parameters ... I: sanity check of parameters I: pkg="debhello", ver="2.1", rev="1" I: *** start packaging in "debhello-2.1". *** I: provide debhello_2.1.orig.tar.gz for non-native Debian package I: pwd = "/path/to" I: $ ln -sf debhello-2.1.tar.gz debhello_2.1.orig.tar.gz I: pwd = "/path/to/debhello-2.1" I: parse binary package settings: ,libsharedlib1,libsharedlib-dev I: binary package=debhello Type=bin / Arch=any M-A=foreign I: binary package=libsharedlib1 Type=lib / Arch=any M-A=same I: binary package=libsharedlib-dev Type=dev / Arch=any M-A=same I: analyze the source tree I: build_type = Cmake ...
結果與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的類似,但是並不完全一致。
讓我們來檢查一下自動產生的模板檔案。
debian/rules(模板檔案,v=2.1):.
$ cat debhello-2.1/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,--as-needed %: dh $@ #override_dh_auto_configure: # dh_auto_configure -- \ # -DCMAKE_LIBRARY_ARCHITECTURE="$(DEB_TARGET_MULTIARCH)"
作為維護者,我們要把這個 Debian 套件做得更好。
debian/rules(維護者版本,v=2.1):.
$ vim debhello-2.1/debian/rules ... hack, hack, hack, ... $ cat debhello-2.1/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 DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH) %: dh $@ override_dh_auto_configure: dh_auto_configure -- \ -DCMAKE_LIBRARY_ARCHITECTURE="$(DEB_HOST_MULTIARCH)"
debian/control(維護者版本,v=2.1):.
$ vim debhello-2.1/debian/control ... hack, hack, hack, ... $ cat debhello-2.1/debian/control Source: debhello Section: devel Priority: optional Maintainer: Osamu Aoki <osamu@debian.org> Build-Depends: cmake, debhelper-compat (= 13) Standards-Version: 4.5.1 Homepage: https://salsa.debian.org/debian/debmake-doc Rules-Requires-Root: no Package: debhello Architecture: any Multi-Arch: foreign Depends: libsharedlib1 (= ${binary:Version}), ${misc:Depends}, ${shlibs:Depends} Description: Simple packaging example for debmake This package contains the compiled binary executable. . This Debian binary package is an example package. (This is an example only) Package: libsharedlib1 Section: libs Architecture: any Multi-Arch: same Pre-Depends: ${misc:Pre-Depends} Depends: ${misc:Depends}, ${shlibs:Depends} Description: Simple packaging example for debmake This package contains the shared library. Package: libsharedlib-dev Section: libdevel Architecture: any Multi-Arch: same Depends: libsharedlib1 (= ${binary:Version}), ${misc:Depends} Description: Simple packaging example for debmake This package contains the development files.
debian/*.install(維護者版本,v=2.1):.
$ vim debhello-2.1/debian/debhello.install ... hack, hack, hack, ... $ cat debhello-2.1/debian/debhello.install usr/bin/* usr/share/* $ vim debhello-2.1/debian/libsharedlib1.install ... hack, hack, hack, ... $ cat debhello-2.1/debian/libsharedlib1.install usr/lib/*/*.so.* $ vim debhello-2.1/debian/libsharedlib-dev.install ... hack, hack, hack, ... $ cat debhello-2.1/debian/libsharedlib-dev.install ###usr/lib/*/pkgconfig/*.pc usr/include usr/lib/*/*.so
需要對上游的 CMakeList.txt 進行修補,以便應對多架構的路徑。
debian/patches/*(維護者版本,v=2.1):.
... hack, hack, hack, ... $ cat debhello-2.1/debian/libsharedlib1.symbols libsharedlib.so.1 libsharedlib1 #MINVER# sharedlib@Base 2.1
因為上游原始碼已經具有正確的自動生成的 Makefile 檔案,所以沒有必要再去建立 debian/install 和 debian/manpages 文件。
在 debian/ 目錄下還有一些其它的模板文件。它們也需要進行更新。
debian/ 目錄下的模板檔案。(v=2.1):.
$ tree debhello-2.1/debian debhello-2.1/debian ├── README.Debian ├── changelog ├── control ├── copyright ├── debhello.install ├── libsharedlib-dev.install ├── libsharedlib1.install ├── libsharedlib1.symbols ├── patches │ ├── 000-cmake-multiarch.patch │ └── series ├── rules ├── source │ ├── control │ ├── format │ ├── local-options │ ├── options │ └── patch-header ├── tests │ └── control ├── upstream │ └── metadata └── watch 4 directories, 19 files
其餘的打包工作與 Section 8.8, “Makefile.in + configure(單個二進位制套件)” 中的近乎一致。
此處是生成的二進位制包的依賴項列表。
生成的二進位制包的依賴項列表(v=2.1):.
$ dpkg -f debhello-dbgsym_2.1-1_amd64.deb pre-depends depends recommends con... Depends: debhello (= 2.1-1) $ dpkg -f debhello_2.1-1_amd64.deb pre-depends depends recommends conflicts ... Depends: libsharedlib1 (= 2.1-1), libc6 (>= 2.2.5) $ dpkg -f libsharedlib-dev_2.1-1_amd64.deb pre-depends depends recommends co... Depends: libsharedlib1 (= 2.1-1) $ dpkg -f libsharedlib1-dbgsym_2.1-1_amd64.deb pre-depends depends recommend... Depends: libsharedlib1 (= 2.1-1) $ dpkg -f libsharedlib1_2.1-1_amd64.deb pre-depends depends recommends confl... Depends: libc6 (>= 2.2.5)
此處是更新 Section 8.11, “Autotools(多個二進位制套件)” 中提供的簡單上游 C 語言原始碼 debhello-2.0.tar.gz 以便進行國際化(i18n)並建立更新後的上游 C 語言原始碼 debhello-2.0.tar.gz 的範例。
在實際情況中,此套件應該已被國際化過。所以此範例用作幫助您瞭解國際化的具體實現方法。
![]() |
Tip |
---|---|
負責維護國際化的維護者的日常活動就是將通過缺陷追蹤系統(BTS)反饋給您的 po 翻譯檔案新增至 po/ 目錄,然後更新 po/LINGUAS 檔案的語言列表。 |
讓我們取得原始碼並製作 Debian 套件。
下載 debhello-2.0.tar.gz(國際化版).
$ wget http://www.example.org/download/debhello-2.0.tar.gz ... $ tar -xzmf debhello-2.0.tar.gz $ tree . ├── debhello-2.0 │ ├── LICENSE │ ├── Makefile.am │ ├── configure.ac │ ├── data │ │ ├── hello.desktop │ │ └── hello.png │ ├── lib │ │ ├── Makefile.am │ │ ├── sharedlib.c │ │ └── sharedlib.h │ ├── man │ │ ├── Makefile.am │ │ └── hello.1 │ └── src │ ├── Makefile.am │ └── hello.c └── debhello-2.0.tar.gz 5 directories, 13 files
使用 gettextize 命令將此原始碼樹國際化,並刪除由 Autotools 自動生成的檔案。
執行 gettextize(國際化版):.
$ cd debhello-2.0 $ gettextize Creating po/ subdirectory Creating build-aux/ subdirectory Copying file ABOUT-NLS Copying file build-aux/config.rpath Not copying intl/ directory. Copying file po/Makefile.in.in Copying file po/Makevars.template Copying file po/Rules-quot Copying file po/boldquot.sed Copying file po/en@boldquot.header Copying file po/en@quot.header Copying file po/insert-header.sin Copying file po/quot.sed Copying file po/remove-potcdate.sin Creating initial po/POTFILES.in Creating po/ChangeLog Creating directory m4 Copying file m4/gettext.m4 Copying file m4/iconv.m4 Copying file m4/lib-ld.m4 Copying file m4/lib-link.m4 Copying file m4/lib-prefix.m4 Copying file m4/nls.m4 Copying file m4/po.m4 Copying file m4/progtest.m4 Creating m4/ChangeLog Updating Makefile.am (backup is in Makefile.am~) Updating configure.ac (backup is in configure.ac~) Creating ChangeLog Please use AM_GNU_GETTEXT([external]) in order to cause autoconfiguration to look for an external libintl. Please create po/Makevars from the template in po/Makevars.template. You can then remove po/Makevars.template. Please fill po/POTFILES.in as described in the documentation. Please run 'aclocal' to regenerate the aclocal.m4 file. You need aclocal from GNU automake 1.9 (or newer) to do this. Then run 'autoconf' to regenerate the configure file. You will also need config.guess and config.sub, which you can get from the CV... of the 'config' project at http://savannah.gnu.org/. The commands to fetch th... are $ wget 'http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/conf... $ wget 'http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/config/config/conf... You might also want to copy the convenience header file gettext.h from the /usr/share/gettext directory into your package. It is a wrapper around <libintl.h> that implements the configure --disable-nl... option. Press Return to acknowledge the previous 6 paragraphs. $ rm -rf m4 build-aux *~
讓我們確認一下 po/ 目錄下生成的檔案。
po 目錄下的檔案(國際化版):.
$ ls -l po total 60 -rw-rw-r-- 1 osamu osamu 494 Jul 2 16:28 ChangeLog -rw-rw-r-- 1 osamu osamu 17577 Jul 2 16:28 Makefile.in.in -rw-rw-r-- 1 osamu osamu 3376 Jul 2 16:28 Makevars.template -rw-rw-r-- 1 osamu osamu 59 Jul 2 16:28 POTFILES.in -rw-rw-r-- 1 osamu osamu 2203 Jul 2 16:28 Rules-quot -rw-rw-r-- 1 osamu osamu 217 Jul 2 16:28 boldquot.sed -rw-rw-r-- 1 osamu osamu 1337 Jul 2 16:28 en@boldquot.header -rw-rw-r-- 1 osamu osamu 1203 Jul 2 16:28 en@quot.header -rw-rw-r-- 1 osamu osamu 672 Jul 2 16:28 insert-header.sin -rw-rw-r-- 1 osamu osamu 153 Jul 2 16:28 quot.sed -rw-rw-r-- 1 osamu osamu 432 Jul 2 16:28 remove-potcdate.sin
讓我們在 configure.ac 檔案中新增 “AM_GNU_GETTEXT([external])” 等條目。
configure.ac(國際化版):.
$ vim configure.ac ... hack, hack, hack, ... $ cat configure.ac # -*- Autoconf -*- # Process this file with autoconf to produce a configure script. AC_PREREQ([2.69]) AC_INIT([debhello],[2.2],[foo@example.org]) AC_CONFIG_SRCDIR([src/hello.c]) AC_CONFIG_HEADERS([config.h]) echo "Standard customization chores" AC_CONFIG_AUX_DIR([build-aux]) AM_INIT_AUTOMAKE([foreign]) # Set default to --enable-shared --disable-static LT_INIT([shared disable-static]) # find the libltdl sources in the libltdl sub-directory LT_CONFIG_LTDL_DIR([libltdl]) # choose one LTDL_INIT([recursive]) #LTDL_INIT([subproject]) #LTDL_INIT([nonrecursive]) # Add #define PACKAGE_AUTHOR ... in config.h with a comment AC_DEFINE(PACKAGE_AUTHOR, ["Osamu Aoki"], [Define PACKAGE_AUTHOR]) # Checks for programs. AC_PROG_CC # desktop file support required AM_GNU_GETTEXT_VERSION([0.19.3]) AM_GNU_GETTEXT([external]) # only for the recursive case AC_CONFIG_FILES([Makefile po/Makefile.in lib/Makefile man/Makefile src/Makefile]) AC_OUTPUT
讓我們從 po/Makevars.template 檔案中創建 po/Makevars 檔案。
po/Makevars(國際化版):.
... hack, hack, hack, ... $ diff -u po/Makevars.template po/Makevars --- po/Makevars.template 2021-07-02 16:28:02.711724581 +0900 +++ po/Makevars 2021-07-02 16:28:02.767725251 +0900 @@ -18,14 +18,14 @@ # or entity, or to disclaim their copyright. The empty string stands for # the public domain; in this case the translators are expected to disclaim # their copyright. -COPYRIGHT_HOLDER = Free Software Foundation, Inc. +COPYRIGHT_HOLDER = Osamu Aoki <osamu@debian.org> # This tells whether or not to prepend "GNU " prefix to the package # name that gets inserted into the header of the $(DOMAIN).pot file. # Possible values are "yes", "no", or empty. If it is empty, try to # detect it automatically by scanning the files in $(top_srcdir) for # "GNU packagename" string. -PACKAGE_GNU = +PACKAGE_GNU = no # This is the email address or URL to which the translators shall report # bugs in the untranslated strings: $ rm po/Makevars.template
讓我們通過用 _(…) 包裹字串的方式來更新國際化版本的 C 語言原始碼。
src/hello.c (國際化版):.
... hack, hack, hack, ... $ cat src/hello.c #include "config.h" #include <stdio.h> #include <sharedlib.h> #define _(string) gettext (string) int main() { printf(_("Hello, I am " PACKAGE_AUTHOR "!\n")); sharedlib(); return 0; }
lib/sharedlib.c(國際化版):.
... hack, hack, hack, ... $ cat lib/sharedlib.c #include <stdio.h> #define _(string) gettext (string) int sharedlib() { printf(_("This is a shared library!\n")); return 0; }
新版本的 gettext(v = 0.19)可以直接處理桌面檔案的國際化版本。
data/hello.desktop.in(國際化版):.
$ fgrep -v '[ja]=' data/hello.desktop > data/hello.desktop.in $ rm data/hello.desktop $ cat data/hello.desktop.in [Desktop Entry] Name=Hello Comment=Greetings Type=Application Keywords=hello Exec=hello Terminal=true Icon=hello.png Categories=Utility;
讓我們列出輸入檔案,以便在 po/POTFILES.in 中提取可翻譯的字串。
po/POTFILES.in(國際化版):.
... hack, hack, hack, ... $ cat po/POTFILES.in src/hello.c lib/sharedlib.c data/hello.desktop.in
此處是在 SUBDIRS 環境變數中新增 po 目錄後更新過的根 Makefile.am 檔案。
Makefile.am (國際化版):.
$ cat Makefile.am # recursively process `Makefile.am` in SUBDIRS SUBDIRS = po lib src man ACLOCAL_AMFLAGS = -I m4 EXTRA_DIST = build-aux/config.rpath m4/ChangeLog
讓我們建立一個翻譯模板檔案 debhello.pot。
po/debhello.pot(國際化版):.
$ xgettext -f po/POTFILES.in -d debhello -o po/debhello.pot -k_ $ cat po/debhello.pot # SOME DESCRIPTIVE TITLE. # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER # This file is distributed under the same license as the PACKAGE package. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # #, fuzzy msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "Report-Msgid-Bugs-To: \n" "POT-Creation-Date: 2021-07-02 16:28+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" "Language: \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=CHARSET\n" "Content-Transfer-Encoding: 8bit\n" #: src/hello.c:8 #, c-format msgid "Hello, I am " msgstr "" #: lib/sharedlib.c:6 #, c-format msgid "This is a shared library!\n" msgstr "" #: data/hello.desktop.in:3 msgid "Hello" msgstr "" #: data/hello.desktop.in:4 msgid "Greetings" msgstr "" #: data/hello.desktop.in:6 msgid "hello" msgstr ""
讓我們新增法語的翻譯。
po/LINGUAS 與 po/fr.po(國際化版):.
$ echo 'fr' > po/LINGUAS $ cp po/debhello.pot po/fr.po $ vim po/fr.po ... hack, hack, hack, ... $ cat po/fr.po # SOME DESCRIPTIVE TITLE. # This file is put in the public domain. # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. # msgid "" msgstr "" "Project-Id-Version: debhello 2.2\n" "Report-Msgid-Bugs-To: foo@example.org\n" "POT-Creation-Date: 2015-03-01 20:22+0900\n" "PO-Revision-Date: 2015-02-21 23:18+0900\n" "Last-Translator: Osamu Aoki <osamu@debian.org>\n" "Language-Team: French <LL@li.org>\n" "Language: ja\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: src/hello.c:34 #, c-format msgid "Hello, my name is %s!\n" msgstr "Bonjour, je m'appelle %s!\n" #: lib/sharedlib.c:29 #, c-format msgid "This is a shared library!\n" msgstr "Ceci est une bibliothèque partagée!\n" #: data/hello.desktop.in:3 msgid "Hello" msgstr "" #: data/hello.desktop.in:4 msgid "Greetings" msgstr "Salutations" #: data/hello.desktop.in:6 msgid "hello" msgstr "" #: data/hello.desktop.in:9 msgid "hello.png" msgstr ""
打包工作與 Section 8.11, “Autotools(多個二進位制套件)” 中的近乎一致。
You can find more i18n examples by following Section 8.14, “細節”.
所示範例的實際細節及其變體可通過以下方式獲得。
如何取得細節.
$ apt-get source debmake-doc $ cd debmake-doc* $ cd examples $ view examples/README.md
Follow the exact instruction in examples/README.md
.
$ cd examples $ sudo apt-get install devscripts build-essentials ... $ make
Now, each directory named as
examples/debhello-?.?_build-?
contains the Debian
packaging example.
Notable examples are:
[23] If the source package is lacks setup.py but still based on setuptools, you need to add a boiler plate setup.py. If the source package is based on other build systems such as flit, you need to use respective plugins.