Capítulo 5. Otros ficheros en el directorio debian.

Una de las cosas más molestas de los programas es cuando pasas mucho tiempo y esfuerzo adaptando un programa (como usuario) y una actualización destroza todos tus cambios. Debian resuelve este problema marcando los ficheros de configuración. ^[54] Así, cuando actualizas un paquete se te pregunta si deseas mantener la nueva configuración o no.

Desde la versión 3 de debhelper, dh_installdeb(1) considera automáticamente a todos los archivos ubicados en el directorio /etc como «conffiles» (archivos de configuración gestionados por el sistema de paquetes). Así, si todos los «conffiles» están en este directorio no es necesario que los incluyas en este archivo. Para la mayoría de paquetes, la única ubicación de los «conffiles» es /etc por lo que no es necesario generar este archivo.

En el caso de que tu programa utilice ficheros de configuración pero también los reescriba él mismo es mejor no marcarlos como «conffiles». Si lo haces, dpkg informará a los usuarios que verifiquen los cambios de estos ficheros cada vez que lo actualicen.

Si el programa que estás empaquetando requiere que cada usuario modifique los archivos de configuración del directorio /etc, hay dos formas para no marcarlos como archivos «conffiles» y que no sean manipulados por dpkg:

Para más información sobre los guiones del desarrollador véase Sección 5.18, “Archivos {pre,post}{inst,rm}” .

Los archivos listados en el archivo install no requieren la construcción previa de los directorios. Véase Sección 5.11, “Archivo install” .

Es recomendable ejecutar en primer lugar la instalación y solo hacer uso de este archivo si se produce algún problema. No debe ponerse la barra inicial en los nombres de los directorios listados en el archivo dirs.

Document: gentoo
Title: Gentoo Manual
Author: Emil Brink
Abstract: This manual describes what Gentoo is, and how it can be used.
Section: File Management
Format: HTML
Index: /usr/share/doc/gentoo/html/index.html
Files: /usr/share/doc/gentoo/html/*.html

Para más detalles sobre la instalación de documentación adicional, lee Sección 3.3, “Instalación de los archivos en su destino” .

If there are files that need to be installed into your package but your standard make install won't do it, put the filenames and destinations into this install file. They are installed by dh_install(1).^[55] You should first check that there is not a more specific tool to use. For example, documents should be in the docs file and not in this one.

El archivo install tendrá una línea para cada uno de los archivos a instalar, con el nombre del archivo (relativo al directorio superior de la compilación) seguido de un espacio y a continuación el directorio de instalación (relativo al directorio superior de instalación). Suponiendo que el archivo binario src/archivo_binario no se instalase, deberías utilizar el archivo install como sigue:

src/archivo_binario usr/bin

Al instalarse el paquete, se instalará el archivo binario /usr/bin/nombre_archivo_binario.

En el archivo install puedes escribir el nombre del archivo sin el directorio de instalación siempre que no cambie la ruta relativa de directorio. Este formato se usa en paquetes grandes que separan el resultado de la compilación en múltiples paquetes binarios haciendo uso de nombre_del_paquete-1.install, nombre_del_paquete-2.install, etc.

La orden dh_install retrocederá al directorio debian/tmp para buscar los archivos si no los encuentra en el directorio actual (o en la ubicación que hayas establecido para la búsqueda con --sourcedir).

Los archivos postinst, preinst, postrm y prerm ^[57] se denominan guiones del desarrollador. Son guiones que se colocan en el área de control del paquete y que dpkg ejecuta cuando tu paquete se instala, se actualiza o se elimina.

Por ahora, deberías intentar evitar editar manualmente estos guiones del desarrollador si puedes porque suelen hacerse muy complejos. Para más información lee «Debian Policy Manual, 6 "Package maintainer scripts and installation procedure"», y echa un vistazo a los ejemplos proporcionados por dh_make.

Si a pesar de mis advertencias, adaptas los guiones del desarrollador para el paquete, asegúrate de comprobar su funcionamiento no sólo para la instalación y actualización del paquete, sino también para su desinstalación y eliminación completa.

Las actualizaciones a una nueva versión deben ser «silenciosas» y no intrusivas. Los usuarios no deberían darse cuenta de la actualización, salvo quizás para descubrir que se han arreglado errores antiguos y porque hay alguna nueva funcionalidad.

Cuando la actualización es necesariamente intrusiva (p.e. archivos de configuración dispersos en varios directorios con una estructura totalmente modificada), se deberían establecer los valores predeterminados seguros (p.e. desactivar los servicios) y facilitar la documentación apropiada establecida por las normas (archivos README.Debian y NEWS.Debian) como último recurso. Hay que evitar molestar al usuario con notas debconf invocadas por los guiones del desarrollador en las actualizaciones.

El paquete ucf facilita el sistema conffile-like para preservar los cambios de configuración realizados por el usuario y por ello no deben nombrarse como conffiles los archivos manejados por los guiones del desarrollador. Así se minimizan las incidencias asociadas con ellos.

Estos guiones del desarrollador son un ejemplo de las características de Debian que explican por qué la gente elige Debian. Debes ser cuidadoso con no molestarles con ellos.

Packaging of a library is not easy for a novice maintainer and should be avoided. Having said it, if your package has libraries, you should have debian/package.symbols files. See Sección A.2, “Gestionando debian/package.symbols”.

The watch file format is documented in the uscan(1) manpage. The watch file configures the uscan program (in the devscripts package) to watch the site where you originally got the source. This is also used by the Debian Package Tracker service.

Este es su contenido:

# watch control file for uscan
version=3
http://sf.net/gentoo/gentoo-(.+)\.tar\.gz debian uupdate

Con el archivo watch, la URL http://sf.net/gentoo se descarga y se buscan los enlaces del tipo <a href=...>. El nombre base (justo la parte después del / final) de las direcciones URL enlazadas se comparan con la expresión regular de Perl (véase perlre(1)) con el patrón gentoo-(.+)\.tar\.gz. Se descarga el archivo de versión más reciente de entre todos los archivos encontrados cuyo nombre se ajuste al patrón, y se ejecutará el programa uupdate para construir el árbol de código fuente actualizado en base a este fichero.

Although this is true for other sites, the SourceForge download service at http://sf.net is an exception. When the watch file has a URL matching the Perl regexp ^http://sf\.net/, the uscan program replaces it with http://qa.debian.org/watch/sf.php/ and then applies this rule. The URL redirector service at http://qa.debian.org/ is designed to offer a stable redirect service to the desired file for any watch pattern of the form http://sf.net/project/tar-name-(.+)\.tar\.gz. This solves issues related to periodically changing SourceForge URLs.

Si el autor publica la firma criptográfica del fichero tarball, se recomienda comprobar su autenticidad utilizando la opción pgpsigurlmangle descrita en uscan(1).

El nuevo formato 3.0 (quilt) registra los cambios en series de archivos de parches quilt en el directorio debian/patches. Estos cambios se aplican automáticamente en la extracción de las fuentes del paquete ^[58]. Las modificaciones se guardan en el archivo debian.tar.gz que contiene todos los archivos del directorio debian utilizado en la construcción del paquete. El nuevo formato permite la inclusión de archivos como los iconos PNG sin necesidad de trucos ^[59].

Cuando dpkg-source extrae un paquete fuente con el formato 3.0 (quilt), automáticamente aplica todos los parches listados en el archivo debian/patches/series. Puedes evitar la ejecución de los parches al final de la extracción con la opción --skip-patches.

Los archivos generados automáticamente en el árbol del código fuente pueden ser bastante molestos en la construcción del paquete debido a que generan archivos de parche grandes. Hay módulos personalizados, tales como dh_autoreconf para aliviar este problema como se describe en Sección 4.4.3, “Personalización del archivo rules”.

Puedes proporcionar una expresión regular en Perl para la opción --extend-diff-ignore del argumento de dpkg-source(1) para hacer caso omiso de los cambios realizados en los archivos generados automáticamente al crear el paquete fuente.

Puedes conservar las opciones de la orden dpkg-source en el archivo source/options de las fuentes del paquete como solución genérica al problema de los archivos autogenerados. En el ejemplo siguiente, se evita la generación de archivos de parche para config.sub config.guess y Makefile.

extend-diff-ignore = "(^|/)(config\.sub|config\.guess|Makefile)$"

El nuevo formato 3.0 (quilt) de las fuentes, guarda las modificaciones (los parches) en archivos en el directorio debian/patches/* utilizando la orden quilt. Estos parches y otros datos del paquete que están en el directorio debian se conservan en el archivo debian.tar.gz. Desde que la orden dpkg-source puede aplicar los parches en las fuentes con el nuevo formato tipo quilt sin el paquete quilt, no es necesario añadir el paquete quilt en el campo Build-Depends del fichero control ^[60].

El funcionamiento de la orden quilt se explica en quilt(1). Conserva las modificaciones de las fuentes en una colección de archivos de parches -p1 en el directorio debian/patches y las fuentes originales permanecen sin modificar fuera del directorio debian. El orden de aplicación de las modificaciones se conserva en el archivo debian/patches/series. Puedes aplicar («push»), deshacer («pop») y actualizar las modificaciones fácilmente ^[61].

En Capítulo 3, Modificar las fuentes, se han construido tres archivos de parches en debian/patches.

Puesto que los parches se ubican en debian/patches, asegúrate que has configurado adecuadamente la orden dquilt como se describe en Sección 3.1, “Configurar quilt” .

Cuando alguien (incluido tú mismo), facilita un parche nombre_parche.patch para las fuentes, cuando ya está construido el paquete, la modificación de un paquete con formato 3.0 (quilt) es así de simple:

$ dpkg-source -x gentoo_0.9.12.dsc
$ cd gentoo-0.9.12
$ dquilt import ../nombre_parche.patch
$ dquilt push
$ dquilt refresh
$ dquilt header -e
.. descripción de la modificación

Los parches conservados con el nuevo formato de fuentes 3.0 (quilt) deben estar exentos de cosas innecesarias. Debes asegurarte ejecutando dquilt pop -a; while dquilt push; do dquilt refresh; done.