15.2. Creación de su primer paquete

15.2.1. Metapaquetes o paquetes falsos

Los paquetes falsos y los metapaquetes son similares en que son cascarones vacíos que sólo existen por los efectos que tienen sus metadatos en el sistema de gestión de paquetes.

El propósito de un paquete falso es engañar a dpkg y apt para que crean que un paquete está instalado. Esto permite satisfacer las dependencias de un paquete cuando se instaló el software correspondiente fuera del alcance del sistema de paquetes. Este método funciona, pero debería evitarlo siempre que sea posible ya que no hay garantías que el software instalado manualmente se comporta exactamente de la misma forma que el paquete correspondiente y que otros paquetes que dependan de él funcionarán correctamente.

Por el otro lado, un metapaquete existe principalmetne como una colección de dependencias, para que su instalación incluya un conjunto de otros paquetes en un solo paso.

Puede crear ambos tipos de paquetes con los programas equivs-control y equivs-build (en el paquete equivs). Si ejecuta equivs-control archivo creará un archivo de cabecera de un paquete Debian que debe editar para que contenga el nombre esperado del paquete, su número de versión, el nombre de su encargado, sus dependencias y su descripción. Puede eliminar todos los demás campos sin un valor predeterminado ya que son opcionales. Los campos Copyright, Changelog, Readme y Extra-Files no son campos estándar en los paquetes Debian, sólo tienen sentido dentro del alcance de equivs-build y no serán mantenidos en las cabeceras del paquete generado.

Ejemplo 15.2. Archivo de cabecera del paquete falso libxml-libxml-perl

Section: perl
Priority: optional
Standards-Version: 3.8.4

Package: libxml-libxml-perl
Version: 1.57-1
Maintainer: Raphael Hertzog <hertzog@debian.org>
Depends: libxml2 (>= 2.6.6)
Architecture: all
Description: Fake package - module manually installed in site_perl
 This is a fake package to let the packaging system
 believe that this Debian package is installed. 
 .
 In fact, the package is not installed since a newer version
 of the module has been manually compiled & installed in the
 site_perl directory.

EL siguiente paso es generar el paquete Debian ejecutando equivs-build archivo. Voilà: se creó el paquete en el directorio actual y lo puede utilizar como cualquier otro paquete Debian.

15.2.2. Simple compendio de archivos

Los administradores de Falcot Corp necesitaron crear un paquete Debian para facilitar el despliegue de un conjunto de documentos en una gran cantidad de equipos. El administrador a cargo de esta tarea primero leyó la «Guía del nuevo desarrollador de Debian» y luego comenzó a trabajar en su primer paquete.

→ http://www.debian.org/doc/maint-guide/index.es.html

El primer paso es crear un directorio falcot-data-1.0 que contendrá el paquete fuente objetivo. El paquete, lógicamente, se llamará falcot-data y tendrá el número de versión 1.0. El administrador luego ubicará los archivos de documentos en un subdirectorio data. Luego ejecutará dh_make (del paquete dh-make) para agregar los archivos necesarios para el proceso de generación del paquete, que serán almacenados en un subdirectorio debian:

$ cd falcot-data-1.0
$ dh_make --native

Type of package: single binary, indep binary, multiple binary, library, kernel module, kernel patch or cdbs?
 [s/i/m/l/k/n/b] i

Maintainer name : Raphael Hertzog
Email-Address   : hertzog@debian.org
Date            : Mon, 11 Apr 2011 15:11:36 +0200
Package Name    : falcot-data
Version         : 1.0
License         : blank
Usind dpatch    : no
Type of Package : Independent
Hit <enter> to confirm:
Currently there is no top level Makefile. This may require additional tuning.
Done. Please edit the files in the debian/ subdirectory now. You should also
check that the falcot-data Makefiles install into $DESTDIR and not in / .
$

El tipo de paquete seleccionado (binario único: «single binary») indica que este paquete fuente generará sólo un paquete binario que depende de la arquitectura (Architecture: any. Binario independiente («indep binary») es lo contrario y generará sólo un paquete binario que no depende de la arquitectura objetivo (Architecture: all). En este caso, esta última opción es más relevante ya que el paquete sólo contendrá documentos y ningún programa binario, por lo que se lo puede utilizar de la misma forma en equipos de cualquier arquitectura.

El tipo binario múltiple («multiple binary») corresponde a un paquete fuente que generará varios paquetes binarios. Un caso particular, biblioteca («library»), es útil para bibliotecas compartidas ya que necesitan seguir reglas de empaquetado estrictas. De forma similar, debería restringir el uso de módulo de núcleo («kernel module») a paquetes que contengan módulos de núcleo. Finalmente, cdbs es un sistema de creación de paquetes específico; es bastante flexible pero necesita un poco de aprendizaje.

SUGERENCIA Nombre y dirección de correo del encargado

La mayoría de los programas involucrados al mantener paquetes buscarán su nombre y dirección de correo en las variables de entorno DEBFULLNAME y DEBEMAIL o EMAIL. Definirlas de una vez y para siempre le evitará tener que ingresarlas varias veces. Si su consola usual es bash, es simple cuestión de agregar las siguientes dos líneas a sus archivos ~/.bashrc y ~/.bash_profile (¡obviamente reemplazará los valores con unos más relevantes!):

export EMAIL="hertzog@debian.org"
export DEBFULLNAME="Raphael Hertzog"

El programa dh_make crea un subdirectorio debian con muchos archivos. Algunos son necesarios, en particular rules, control, changelog y copyright. Los archivos con extensión .ex son archivos de ejemplo que puede utilizar modificándolos (y eliminando la extensión) cuando necesite. Si no los necesita, le recomendamos eliminarlos. Debe mantener el archivo compat ya que es necesario para que funcione correctamente la suite de programas debhelper (todos los que comienzan con el prefijo dh_) que son utilizados en varias etapas del proceso de creación del paquete.

El archivo copyright debe contener la información sobre los autores de los documentos incluidos en el paquete y las licencias relacionadas. En nuestro caso, éstos son documentos internos y su uso está restringido al interior de la empresa Falcot Corp. El archivo changelog predeterminado generalmente es apropiado; reemplace «Initial release» con una explicación más detallada y basta con cambiar la distribución de unstable a internal. También actualizamos el archivo control: modificamos la sección a misc y eliminamos los campos Homepage, Vcs-Git y Vcs-Browser. Completamos los campos Depends con iceweasel | www-browser para asegurar que exista un navegador web disponible capaz de mostrar los documentos en el paquete.

Ejemplo 15.3. El archivo control

Source: falcot-data
Section: misc
Priority: optional
Maintainer: Raphael Hertzog <hertzog@debian.org>
Build-Depends: debhelper (>= 7.0.50~)
Standards-Version: 3.8.4

Package: falcot-data
Architecture: all
Depends: iceweasel | www-browser, ${misc:Depends}
Description: Internal Falcot Corp Documentation
 This package provides several documents describing the internal
 structure at Falcot Corp.  This includes:
  - organization diagram
  - contacts for each department.
 .
 These documents MUST NOT leave the company.
 Their use is INTERNAL ONLY.

Ejemplo 15.4. El archivo changelog

falcot-data (1.0) internal; urgency=low

  * Initial Release.
  * Let's start with few documents:
    - internal company structure;
    - contacts for each department.

 -- Raphael Hertzog <hertzog@debian.org>  Mon, 11 Apr 2011 20:46:33 +0200

Ejemplo 15.5. El archivo copyright

This work was packaged for Debian by Raphael Hertzog <hertzog@debian.org>
on Mon, 11 Apr 2011 20:46:33 +0200

Copyright:

    Copyright (C) 2004-2011 Falcot Corp

License:

    All rights reserved.

VOLVER A LOS CIMIENTOS El archivo Makefile

Un archivo Makefile es un script utilizado por el programa make; describe las reglas para crear un conjunto de archivos desde otros en un árbol de dependencias (por ejemplo, podemos compilar un programa desde un conjunto de archivos fuente). El archivo Makefile describe estas reglas en el siguiente formato:

objetivo: fuente1 fuente 2 ...
        orden1
        orden2

La interpretación de esta regla es como sigue: si uno de los archivos fuente* es más reciente que el archivo objetivo, entonces es necesario generar el objetivo utilizando orden1 y orden2.

Sepa que las líneas de órdenes deben comenzar con un carácter de tabulación; también debe saber que cuando una línea de órdenes comienza con un carácater de guión (-), si éste falla no interrumpirá todo el proceso.

El archivo rules generalmente contiene un conjunto de reglas utilizadas para configurar, compilar e instalar el software en un subdirectorio dedicado (cuyo nombre coincide con el del paquete binario generado). Luego se incluye el contenido de este subdirectorio en el compendio del paquete Debian como si fuera la raíz del sistema de archivos. En nuestro caso, se instalarán los archivos en el subdirectorio debian/falcot-data/usr/share/falcot-data/ para que el paquete generado despliegue los archivos en /usr/share/falcot-data/. Se utiliza el archivo rules como si fuera un archivo Makefile, con unos pocos objetivos estándar (incluyendo clean y binary, utilizados para limpiar el directorio fuente y generar el paquete binario respectivamente).

Si bien este archivo es el corazón del proceso, cada vez más contiene sólo el mínimo indispensable para ejecutar un conjunto estándar de programas que provee la herramienta debhelper. Tal es el caso de los archivos generados por dh_make. Para instalar nuestros archivos simplemente configuraríamos el comportamiento de dh_install creando el siguiente archivo debian/falcot-data.install:

data/* usr/share/falcot-data/

En este punto, podemos crear el paquete. Sin embargo, agregaremos una capa de pintura. Debido a que los administradores desean que se pueda acceder fácilmente a los documentos desde el menú de ayuda de los entornos gráficos de escritorio, crearemos un elemento en el sistema de menús Debian. Haremos esto simplemente cambiando el nombre de debian/menu.ex para eliminar su extensión y editándolo como sigue:

Ejemplo 15.6. El archivo menu

?package(falcot-data):needs=X11|wm section=Help\
  title="Internal Falcot Corp Documentation" \
  command="/usr/bin/x-www-browser /usr/share/falcot-data/index.html"
?package(falcot-data):needs=text section=Help\
  title="Internal Falcot Corp Documentation" \
  command="/usr/bin/www-browser /usr/share/falcot-data/index.html"

Cuando definimos al campo needs como X11|wm, indicamos que este elemento sólo tiene sentido en una interfaz gráfica. Por lo tanto, sólo será integrado en los menús de aplicaciones gráficas (X11) y gestores de ventanas (de allí wm). El campo section indica en qué parte del menú debería mostrar el elemento. En nuestro caso, nuestro elemento se encontrará en el menú «Help». El campo title contiene el texto que será mostrado en el menú. Finalmente, el campo command describe el programa a ejecutar cuando el usuario seleccione el elemento del menú.

El segundo elemento coincide con el primero, con ligeras adaptaciones parar el modo de texto de la consola Linux.

Simplemente crear el archivo debian/menu es suficiente para activar el menú en el paquete ya que dh ejecutará automáticamente el programa dh_installmenu durante el proceso de creación del paquete.

Ahora nuestro paquete fuente está listo. Todo lo que falta es generar el paquete binario con el mismo método que utilizamos para recompilar paquetes: ejecutaremos dpkg-buildpackage -us -uc desde el directorio falcot-data-1.0.