Chapter 5. Simple packaging

Table of Contents

5.1. Empacotar o tarball
5.2. O grande panorama
5.3. O que é debmake?
5.4. O que é debuild?
5.5. Passo 1: Obter a fonte do autor
5.6. Step 2: Generate template files with debmake
5.7. Passo 3: Modificação dos ficheiros modelo
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).

Aqui está um exemplo de criar um pacote Debian simples a partir duma fonte C simples usando o Makefile como seu sistema de compilação.

Vamos assumir que o tarball do autor seja debhello-0.0.tar.gz.

Este tipo de fonte destina-se a ser instalado como ficheiro não-sistema como:

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.

[Note]Note

Exemplos de criar um pacote Debian a partir de outros sistemas de compilação complicados estão descritos em Chapter 13, Mais Exemplos.

O grande panorama para compilar um pacote Debian não-nativo singular a partir do tarball de autor debhello-0.0.tar.gz pode ser resumido como:

  • O maintainer obtém o tarball do autor debhello-0.0.tar.gz e descompacta-o para o directório debhello-0.0.
  • O comando debmake debianiza a árvore fonte do autor ao adicionar ficheiros modelo apenas no directório debian.

    • O link simbólico debhello_0.0.orig.tar.gz é criado apontando para o ficheiro debhello-0.0.tar.gz.
    • O maintainer personaliza os ficheiros modelo.
  • O comando debuild compila o pacote binário a partir da árvore fonte debianizada.

    • É criado debhello-0.0-1.debian.tar.xz contendo o directório debian.

O grande panorama de compilação de pacote. 

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

[Tip]Tip

O comando debuild neste e nos exemplos seguintes pode ser substituído por comandos equivalentes tais como o comando sbuild.

[Tip]Tip

Se o tarball de autor estiver disponível em formato .tar.xzm use-o em vez dos que têm formatos em .tar.gz e .tar.bz2. O formato de compressão xz oferece melhor compressão que a compressão do gzip e bzip2.

[Note]Note

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. (Chapter 14, manual do debmake(1)”)

  • It creates good template files for the Debian packages.
  • Ele sempre define a maioria dos estados de opção e valores óbvios para predefinições razoáveis.
  • Ele gera o tarball do autor e o seu link simbólico necessário se estes estiverem em falta.
  • Ele não sobrescreve os ficheiros de configuração existentes no directório debian/.
  • Ele suporta o pacote multiarch.
  • It provides short extracted license texts as debian/copyright in decent accuracy to help license review.

Estas funcionalidades tornam o empacotamento Debian com debmake simples e moderno.

Em retrospetiva, Eu criei o debmake para simplificar esta documentação. Eu considero o debmake sendo mais ou menos um gerador de sessão de demonstração para objectivos de tutorial.

O comando debmake não é o único script ajudante para criar um pacote Debian. Se você está interessado em ferramentas de ajuda de empacotamento alternativas, por favor veja:

Aqui está um sumário de comandos semelhantes ao comando debuild.

[Note]Note

Veja dpkg-buildpackage(1) para detalhes exactos.

Vamos obter a fonte do autor.

Download 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

Aqui, a fonte C hello.c é uma muito simples.

hello.c

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

Aqui, o Makefile suporta GNU Coding Standards” e FHS. Notavelmente:

  • compila binários honrando $(CPPFLAGS), $(CFLAGS), $(LDFLAGS), etc.
  • instala ficheiros com $(DESTDIR) definida para a imagem de sistema alvo
  • instala ficheiros com $(prefix) definido, os quais podem ser sobrepostos para ser /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

[Note]Note

O echo da variável $(CFLAGS) é usado para verificar a definição apropriada da bandeira de compilação no exemplo seguinte:

Os resultados do comando debmake é muito detalhado e explica o que faz como se segue.

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.gz 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
I: $ wrap-and-sort complete.  Now, debian/* may have a blank line at the top....

O comando debmake gera todos estes ficheiros modelo baseado nas opções da linha de comandos. Como nenhuma opção é especificada, o comando debmake escolhe valores predefinidos razoáveis por si:

  • O nome do pacote fonte: debhello
  • A versão do autor: 0.0
  • O nome do pacote binário: debhello
  • A revisão Debian: 1
  • O tipo de pacote: bin (o pacote binário executável ELF)
  • The -x option: -x1 (without maintainer script supports for simplicity)
[Note]Note

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

Vamos inspecionar os ficheiros modelo gerados.

A árvore fonte após a execução básica do 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

O ficheiro debian/rules é o script de compilação fornecido pelo maintainer do pacote. Aqui está o seu ficheiro modelo gerado pelo comando debmake.

debian/rules (ficheiro modelo): 

 $ 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

Isto é essencialmente o ficheiro debian/rules standard com o comando dh. (Existem alguns conteúdos comentados para você personalizar.)

O ficheiro debian/control fornece os meta-dados principais para o pacote Debian. Aqui está o seu ficheiro modelo gerado pelo comando debmake.

debian/control (ficheiro modelo): 

 $ cat debian/control
Source: debhello
Section: unknown
Priority: optional
Maintainer: "Osamu Aoki" <osamu@debian.org>
Build-Depends: debhelper-compat (= 13)
Standards-Version: 4.6.2
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.

[Warning]Warning

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 Chapter 6, Basics for packaging”.

[Note]Note

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.

O ficheiro debian/copyright fornece os dados de sumário de copyright do pacote Debian. Aqui está o seu ficheiro modelo gerado pelo comando debmake.

debian/copyright (ficheiro modelo): 

 $ 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.

É requerida alguma modificação manual para fazer o pacote Debian apropriado como um maintainer.

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 (versão do maintainer): 

 $ 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

Exportar a variável de ambiente DH_VERBOSE no ficheiro debian/rules como em cima força a ferramenta debhelper a fazer um relatório de compilação afinado.

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

Exportar DEB_CFLAGS_MAINT_APPEND como em cima força o compilador C a emitir todos os avisos.

Exportar DEB_LDFLAGS_MAINT_APPEND como em cima força o vinculador a vincular apenas quando a biblioteca é mesmo necessária. [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.

Aqui estão as versões de maintainer dos ficheiros debian/control e debian/copyright.

debian/control (versão de maintainer): 

 $ 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 (versão de maintainer): 

 $ 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

Ficheiros modelo sob debian/. (v=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

[Tip]Tip

Os ficheiros de configuração usados pelos comandos dh_* do pacote debhelper geralmente tratam # como o inicio de uma linha comentário.

Você pode criar um pacote Debian não-nativo usando o comando debuild ou os seus equivalentes (veja Section 5.4, “O que é debuild?””) nesta árvore fonte. O texto resultante do comando é muito detalhado e explica o que ele faz como se segue.

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
 ...
Finished running lintian.

Você pode verificar que CFLAGS é atualizado apropriadamente com -Wall e -pedantic pela variável DEB_CFLAGS_MAINT_APPEND.

O manual deve ser adicionado ao pacote como reportado pelo pacote lintian, como mostrado em exemplos posteriores (veja Chapter 13, Mais Exemplos). Vamos seguir por agora.

Vamos inspecionar o resultado.

Os ficheiros gerados de debhello versão 0.0 pelo comando 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

Você vê todos os ficheiros gerados.

  • O debhello_0.0.orig.tar.gz é um link simbólico para o tarball do autor.
  • O debhello_0.0-1.debian.tar.xz contém os conteúdos gerados pelo maintainer.
  • O debhello_0.0-1.dsc é o ficheiro de meta-dados para o pacote fonte Debian.
  • O debhello_0.0-1_amd64.deb é o pacote binário Debian.
  • O debhello-dbgsym_0.0-1_amd64.deb é o pacote binário de símbolos de depuração Debian. Veja Section 9.21, “-dbgsym package”.
  • O ficheiro debhello_0.0-1_amd64.build é o ficheiro de relatório de compilação.
  • O ficheiro debhello_0.0-1_amd64.buildinfo é o ficheiro de meta-dados gerado pelo dpkg-genbuildinfo(1).
  • O debhello_0.0-1_amd64.changes é o ficheiro de meta-dados para o pacote binário Debian.

O debhello_0.0-1.debian.tar.xz contém as alterações Debian feitas à fonte do autor como se segue.

O conteúdo do arquivo comprimido de 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

O debhello_0.0-1_amd64.deb contém os ficheiros binário a serem instalados no sistema alvo.

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

O conteúdo de pacote binário de todos os pacotes binário: 

 $ 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/be/
-rw-r--r-- root/root ...  ./usr/lib/debug/.build-id/be/f1e0185834f3c3e2614cf8...
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

A lista de dependências gerada de todos os pacotes binário.

A lista de dependências gerada de todos os pacotes binários (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)

[Caution]Caution

Muitos mais detalhes precisam ser observados antes de se enviar o pacote para o arquivo Debian.

[Note]Note

Se forem saltados ajustes manuais nos ficheiros de configuração auto-gerados pelo comando debmake, o pacote binário gerado pode ficar com falta duma descrição de pacote significativa e alguns dos requerimentos de política podem ficar a faltar. Este pacote desleixado vai funcionar bem sob o comando dpkg, e pode ser suficiente bom para a sua implantação local.

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.

[Note]Note

The above Section 5.7, “Passo 3: Modificação dos ficheiros modelo” 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 Section 5.7, “Passo 3: Modificação dos ficheiros modelo”” 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 (versão alternativa de maintainer): 

 $ 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-07-24 10:12:40.382927188 +0900
+++ debhello-0.0/Makefile       2024-07-24 10:12:40.478928659 +0900
@@ -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

[Note]Note

When generating the Debian source package by dpkg-source via dpkg-buildpackage in the following step of Section 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
.
├── debian
│   ├── changelog
│   ├── clean
│   ├── control
│   ├── copyright
│   ├── dirs
│   ├── gbp.conf
│   ├── install
│   ├── links
│   ├── patches
│   │   ├── 000-prefix-usr.patch
│   │   └── series
│   ├── README.Debian
│   ├── README.source
│   ├── rules
│   ├── salsa-ci.yml
│   ├── source
│   │   ├── format
│   │   ├── local-options.ex
│   │   └── local-patch-header.ex
│   ├── tests
│   │   └── control
│   ├── upstream
│   │   └── metadata
│   └── watch
├── Makefile
├── .pc
│   ├── 000-prefix-usr.patch
│   │   ├── Makefile
│   │   └── .timestamp
│   ├── applied-patches
│   ├── .quilt_patches
│   ├── .quilt_series
│   └── .version
├── README.md
└── 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.

[Note]Note

When generating the Debian source package by dpkg-source via dpkg-buildpackage in the following step of Section 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 Section 5.8, “Step 4: Building package with debuild”.

Vamos editar a fonte do autor.

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.

[Note]Note

When generating the Debian source package by dpkg-source via dpkg-buildpackage in the following step of Section 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 Section 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] Isto é um cliché para prevenir a sobre-vinculação para casos de dependências complexas de biblioteca como os programas de Gnome. Isto não é realmente preciso para este exemplo simples mas deve ser inofensivo.