Capítol 5. Altres fitxers del directori debian.

gentoo for Debian
-----------------
<possible notes regarding this package - if none, delete this file>
 -- Josip Rodin <[email protected]>, Wed, 11 Nov 1998 21:02:14 +0100

Atès que no tenim res per explicar, eliminarem el fitxer. Consulta dh_installdocs(1).

Una de les coses més molestes dels programes és quan després de dedicar molt de temps i esforç a configurar un programa (com a usuari), una actualització del programa fa inútils els canvis. Debian resol aquesta situació marcant els fitxers de configuració^[54] de manera que quan actualitzes un paquet, tens l'opció de mantenir la teva configuració.

Des de la versió 3 de debhelper, dh_installdeb(1) considera automàticament a tots els fitxers ubicats en el directori /etc com fitxers de configuració, de manera que si tots els fitxers de configuració del programa són en aquest directori, no es necessari que els incloguis en el fitxer «conffiles» (abreviatura d'arxiu de configuració). Per a la majoria de paquets, l'única ubicació dels arxius de configuració és /etc i en aquest cas pots eliminar aquest arxiu.

Si el teu programa fa servir fitxers de configuració però també els sobreescriu ell mateix (directament des del codi font) es millor no marcar-los com «conffiles». Si ho fas, dpkg informarà als usuaris que revisin els canvis realitzats en aquests fitxers en cada actualització.

Si el programa que empaquetes requereix que cada usuari modifiqui els fitxers de configuració del directori /etc, hi ha dues formes per a no marcar-los com fitxers «conffiles» i que no siguin manipulats per dpkg:

Si vols més informació sobre els guions del desenvolupador consulta Secció 5.18, «Fitxers {pre,post}{inst,rm}».

Els fitxers llistats en el fitxer install no requereixen la creació prèvia dels directoris. Consulta Secció 5.11, «Fitxer install.».

És recomanable executar en primer lloc la instal·lació i només fer ús d'aquest arxiu si es produeix algú problema. No s'ha de posar la barra inicial en els noms dels directoris llistats a l'arxiu 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

Per a més detalls sobre la instal·lació de documentació addicional, consulta Secció 3.3, «La instal lació dels arxius al seu destí».

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.

En el fitxer install hi haurà una línia per a cada un dels fitxers a instal·lar, amb el seu nom (sempre relatiu al directori superior de la compilació) i després d'un espai, el directori d'instal·lació (relatiu al directori d'instal·lació). En el cas que no s'instal·li el fitxer binari src/arxiu_binari del gentoo, hauries d'escriure el següent:

src/arxiu_binari usr/bin

Quan s'instal·li el paquet, hi haurà una ordre executable /usr/bin/arxiu_binari.

En el fitxer install pots escriure el nom del fitxer sense el directori d'instal·lació sempre que la ruta relativa de directori no canvii. Aquest format es fa servir amb paquets grans que separen el resultat de la compilació en més d'un paquet binari fent servir el conjunt de fitxers nom_del_paquet-1.install, nom_del_paquet-2.install, etc.

L'ordre dh_install revisarà el directori debian/tmp per cercar els fitxers si no els troba en el directori actual (o en la ubicació establerta per a la recerca amb l'opció --sourcedir).

Els arxius postinst, preinst, postrm, i prerm^[57] s'anomenen guions del desenvolupador («maintainer scripts»), i són guions que es col·loquen en l'àrea de control del paquet i són executats pel paquet dpkg quan el teu paquet s'instal·la, s'actualitza o és eliminat.

Hauries d'evitar editar manualment els guions del desenvolupador degut a la seva complexitat. Consulta «Debian Policy Manual, 6 "Package maintainer scripts and installation procedure"» i examina els exemples contruïts per dh_make.

Si malgrat les meves advertències, adaptes els guions del desenvolupador per al teu paquet, comprova el seu funcionament en la instal·lació, actualització, desinstal·lació i eliminació completa.

Les actualitzacions a una nova versió cal que siguin «silencioses» i no intrusives (els usuaris només haurien de veure que s'han arreglat els errors i afegit noves funcions).

Quan l'actualització és necessàriament intrusiva (p. ex. fitxers de configuració dispersos en diversos directoris amb una estructura totalment modificada), s'haurien d'establir els valors predeterminats segurs (p. ex. desactivar els serveis) i facilitar la documentació apropiada establerta en les normes (fitxers README.Debian i NEWS.Debian) com a darrer recurs. Cal evitar molestar a l'usuari amb notes debconf invocades pels guions del desenvolupador en les actualitzacions.

El paquet ucf facilita el sistema conffile-like per preservar els canvis de configuració realitzats per l'usuari i per això no han de anomenar-se com conffiles els fitxers gestionats pels guions del desenvolupador. Així es minimitzen les incidències associades amb ells.

Aquests guions del desenvolupador són un exemple de les característiques de Debian que expliquen perquè la gent elegeix Debian. Has de ser acurat amb no molestar amb ells.

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ó A.2, «Gestionant debian/nom_del_paquet.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.

Aquest és el seu contingut:

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

Amb aquest arxiu watch, l'URL http://sf.net/gentoo es descarrega i es busca els enllaços de tipus <a href=...>. El nom base (just la part després del / final) d'aquests enllaços URL es comparen amb la funció «regexp» de Perl (consulta perlre(1)) amb el patró gentoo-(.+)\.tar\.gz. Dels fitxers trobats que s'ajusten al patró, es descarrega el de la versió més recent i el programa uupdate s'executa per actualitzar el codi original.

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 l'autor original publica la signatura criptogràfica del fitxer tarball, es recomana verificar la seva autenticitat fent servir l'opció pgpsigurlmangle descrita a uscan(1).

El nou format 3.0 (quilt) registre els canvis realitzats en el paquet en fitxers de pegats quilt en el directori debian/patches. Aquests canvis s'aplique automàticament en l'extracció dels fitxers originals del paquet ^[58]. Les modificacions es desen en el fitxer debian.tar.gz que conté tots els fitxers del directori debian utilitzat en la construcció del paquet. El nou format permet la inclusió d'arxius com els icones PNG sense necessitat de trucs ^[59].

Quan dpkg-source extreu un paquet amb les fonts amb el format 3.0 (quilt), automàticament s'apliquen tots els pegats llistats en l'arxiu debian/patches/series. Això ho pots evitar amb l'opció --skip-patches.

Els arxius generats automàticament a l'arbre del codi font poden ser bastant molests en la construcció de paquets ja que generen arxius grans de pegats. Hi ha mòduls personalitzats, com ara dh_autoreconf per alleujar aquest problema com es descriu a Secció 4.4.3, «Personalització del fitxer rules.».

Pots proporcionar una expressió regular en Perl per a l'opció --extend-diff-ignore de dpkg-source(1) per fer cas omís dels canvis realitzats en els arxius generats automàticament en crear el paquet font.

Pots emmagatzemar aquestes opcions de l'ordre dpkg-source a l'arxiu source/options de les fonts del paquet com a solució genèrica per a fer front a aquest problema dels arxius generats automàticament. A l'exemple, s'evita la creació d'arxius de pegat pels arxius config.sub, config.guess i Makefile.

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

El nou format 3.0 (quilt) de les fonts, desa les modificacions (els pegats) a fer als fitxers en el directori debian/patches/* fent servir l'ordre quilt. Aquests pegats i altres dades del paquet ubicats en el directori debian es conserven en el fitxer debian.tar.gz. Des que l'ordre dpkg-source pot aplicar els pegats a les fonts amb el nou format 3.0 (quilt) sense el paquet quilt, no és necessari afegir el paquet quilt en el camp Build-Depends del fitxer control ^[60].

El funcionament de l'ordre quilt s'explica en quilt(1). Conserva les modificacions de les fonts en una col·lecció de fitxers de pegats -p1 en el directori debian/patches i les fonts originals romanen sense modificar fora del directori debian. L'ordre d'aplicació de les modificacions es conserva en el fitxer debian/patches/series. Pots executar («push»), desfer («pop») i actualitzar les modificacions fàcilment ^[61].

A Capítol 3, Modificar les fonts originals., s'han construït tres fitxers de pegats en el directori debian/patches.

Com que els pegats s'ubiquen en debian/patches, comprova que has configurat correctament l'ordre dquilt com es descriu a Secció 3.1, «Configuració de quilt.».

Quan algú (inclòs tu mateix), facilita un pegat nom_pegat.patch per a les fonts, una vegada construït el paquet, la modificació del paquet amb format 3.0 (quilt) és així de simple:

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

Els pegats conservats amb el nou format de fonts 3.0 (quilt) han d'estar exempts de coses innecessàries. Pots comprovar-ho executant dquilt pop -a; while dquilt push; do dquilt refresh; done.