Difference between revisions of "Arch packaging standards (Español)"

From ArchWiki
Jump to: navigation, search
(Aumento y mejora de la traducción de estándares para paquetes)
m (Estándares para paquetes)
Line 11: Line 11:
 
[[zh-TW:Arch Packaging Standards]]
 
[[zh-TW:Arch Packaging Standards]]
 
{{Translateme}}
 
{{Translateme}}
 
==Estándares para paquetes==
 
  
 
'''Los PKGBUILDs no deben instalar aplicaciones que ya se encuentren en los repositorios oficiales bajo ninguna circunstancia. La única excepción a esta regla son paquetes que contengan añadidos extra habilitados y/o parches en comparación con los oficiales. En tal caso, la variable pkgname deberá ser diferente.'''
 
'''Los PKGBUILDs no deben instalar aplicaciones que ya se encuentren en los repositorios oficiales bajo ninguna circunstancia. La única excepción a esta regla son paquetes que contengan añadidos extra habilitados y/o parches en comparación con los oficiales. En tal caso, la variable pkgname deberá ser diferente.'''
  
 
Al crear paquetes para Arch Linux deberás <strong>seguir las directivas</strong> delineadas en este articulo, especialmente si deseas <strong>contribuir</strong> con tu paquete a la Distribución. También deberías leer los manuales de [https://www.archlinux.org/pacman/PKGBUILD.5.html PKGBUILD] y [https://www.archlinux.org/pacman/makepkg.8.html makepkg].
 
Al crear paquetes para Arch Linux deberás <strong>seguir las directivas</strong> delineadas en este articulo, especialmente si deseas <strong>contribuir</strong> con tu paquete a la Distribución. También deberías leer los manuales de [https://www.archlinux.org/pacman/PKGBUILD.5.html PKGBUILD] y [https://www.archlinux.org/pacman/makepkg.8.html makepkg].
 
  
 
== Prototipo de PKGBUILD ==
 
== Prototipo de PKGBUILD ==

Revision as of 10:36, 1 March 2013

Tango-preferences-desktop-locale.pngThis article or section needs to be translated.Tango-preferences-desktop-locale.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Talk:Arch packaging standards (Español)#)

Los PKGBUILDs no deben instalar aplicaciones que ya se encuentren en los repositorios oficiales bajo ninguna circunstancia. La única excepción a esta regla son paquetes que contengan añadidos extra habilitados y/o parches en comparación con los oficiales. En tal caso, la variable pkgname deberá ser diferente.

Al crear paquetes para Arch Linux deberás seguir las directivas delineadas en este articulo, especialmente si deseas contribuir con tu paquete a la Distribución. También deberías leer los manuales de PKGBUILD y makepkg.

Prototipo de PKGBUILD

# Contributor: Tu Nombre <tuemail@domain.com>
pkgname=NOMBREDELPAQUETE
pkgver=VERSIONDELPAQUETE
pkgrel=1
pkgdesc=""
arch=()
url=""
license=('GPL')
depends=()
makedepends=()
provides=()
conflicts=()
replaces=()
backup=()
groups=()
options=()
install=
source=($pkgname-$pkgver.tar.gz)
noextract=()
md5sums=(generate with makepkg -g)

build() {
  cd $startdir/src/$pkgname-$pkgver
  ./configure --prefix=/usr
  make || return 1
  make DESTDIR=$startdir/pkg install || return 1
}

Puedes encontrar otros prototipos en /usr/share/pacman de los paquetes de pacman y abs.

Reglas de etiquetado

  • Los paquetes nunca deben ser instalados en /usr/local
  • Siempre que sea posible utiliza || return 1 en funciones importantes para la construcción del paquete. Por ejemplo:
 patch -Np1 -i ../patchfile.patch || return 1
 make || return 1
 make DESTDIR=$startdir/pkg install || return 1
  • No introduzcas nuevas variables en tu script PKGBUILD, excepto cuando el paquete no puede ser construido sin ellas, debido a que pueden haber posibles confictos con las variables usadas por el propio makepkg. Si una nueva variable es absolutamente requerida, añade el prefijo "_" a su nombre, por ejemplo:
"_tuvariable"

El sistema AUR no puede detectar el uso de variables no estándar, por ende no puede usarlas en sustituciones. Esto puede ser visto frecuentemente en la variable source, por ejemplo:

http://downloads.sourceforge.net/directxwine/$patchname.$patchver.diff.bz2

Esto evita el buen funcionamiento de AUR.

  • Evita usar /usr/libexec. Usa el directorio /usr/lib/${pkgname}/ en su lugar.
  • El campo packager del meta-archivo del paquete puede ser personalizado por el creador del paquete modificando la opción apropiada en /etc/makepkg.conf, creando
    ~/.makepkg.conf,
    o alternativamente exportando la variable de entorno PACKAGER antes de compilar el paquete con makepkg, por ejemplo:
 # export PACKAGER="Juan Perez@tu.email"
  • Todos los mensajes importantes deben ser mostrados con el comando echo durante la instalación mediante el uso del archivo .install. Por ejemplo, si un paquete necesita trabajo adicional de configuración, las instrucciones deberían ser incluidas.
  • Cualquier dependencia opcional que no es necesaria para ejecutar el paquete o para su funcionamiento general no debe ser incluida, en su lugar, la información deberá añadirse en la variable optdepends:
optdepends=('cups: printing support'
            'sane: scanners support'
            'libgphoto2: digital cameras support'
            'alsa-lib: sound support'
            'giflib: GIF images support'
            'libjpeg: JPEG images support'
            'libpng: PNG images support')

Este ejemplo se toma del paquete wine en el repositorio extra. La información en optdepends se muestra automáticamente en la instalación/actualización, de manera que no se debe añadir este tipo de información en el archivo .install

  • Al escribir la descripción del paquete, no incluyas el nombre del paquete en un formato auto-referencial. Por ejemplo "Nedit es un editor de texto para X11" debería ser simplificado a "Editor de texto para X11". Intenta mantener las descripciones en aproximadamente 80 caracteres o menos.
  • Intenta mantener el ancho de linea de tu PKGBUILD debajo de los 100 caracteres.
  • Cuando sea posible elimina las líneas vacias de tu PKGBUILD (provides, replaces, etc.)
  • Es una practica común el preservar el orden de los campos en el PKGBUILD como se muestra más abajo. Aunque no es obligatorio debido a que el único requerimiento para esto es mantener la corrección de la sintaxis bash.


Nombramiento de paquetes

  • Los nombres de paquetes deben consistir solamente de caracteres alfanuméricos; todas las letras deberán ser minúsculas.
  • Las versiones de los paquetes deben ser las mismas que las usadas por el autor' original del software. Las versiones pueden incluir letras si es necesario (ejemplo, la versión de nmap es 2.54BETA32). Los nombres de versión ¡'no deben incluir guiones! solo letras, numeros y puntos.
  • Los números de liberación del paquete (ejemplo, el -1 en nmap-2.54BETA32-1) son especificos a Arch Linux. Estos permiten a los usuarios diferenciar entre un paquete viejo y uno nuevo. Cuando una nueva versión del paquete es liberada el contador se inicia en 1. Cuando correcciones y optimizaciones son realizadas, el paquete es redistribuido con un incremento de 1 en su numero de liberación. Cuando una nueva versión de la aplicación es distribuida el contador se reinicia a 1. Los números de liberación siguen las mismas directivas que los números de versión.


Directorios

  • Archivos de configuración deben almacenarse en el directorio /etc. Si existe mas de un archivo de configuración es costumbre utilizar un subdirectorio para mantener /etc lo mas limpio posible. Usa /etc/{pkgname}/ cuando sea posible, o una alternativa relacionada, por ejemplo, apache utiliza /etc/httpd.
  • Los archivos de cada paquete deben seguir las siguientes directivas:
/etc Archivos de configuración.
/usr/bin Binarios de la aplicación.
/usr/sbin Binarios del sistema.
/usr/lib Librerias
/usr/include Cabeceras (archivos .h)
/usr/lib/{pkgname} Módulos, agregados (plugins), etc.
/usr/man Paginas del manual.
/usr/share/{pkgname} Datos de la aplicación (temas, iconos, etc.).
/etc/{pkgname} Archivos de configuración adicionales de {pkgname}.
/opt Paquetes grandes y autocontenidos como KDE, Mozilla, Qt, etc.
  • Los paquetes no deben contener los siguientes directorios:
    • /dev
    • /home
    • /media
    • /mnt
    • /proc
    • /root
    • /selinux
    • /sys
    • /tmp
    • /var/tmp


Tareas de Makepkg

Cuando usas makepkg para crear un paquete, hace automaticamente lo siguiente:

  1. Verifica que las dependencias esten instaladas
  2. Descarga las fuentes del fichero desde el servidor
  3. Comprueba la integridad de las fuentes
  4. Desempaqueta las fuentes
  5. Parcha todo lo necesario
  6. Crea el software e instala en un directorio root falso
  7. Elimina /usr/doc, /usr/info, /usr/share/doc, y /usr/share/info desde el paquete
  8. Obtiene simbolos desde los binarios
  9. Obtiene debugging symbols desde las librerias
  10. Genera el package meta file que es incluido en cada paquete
  11. Comprime el directorio root falso
  12. Almacena el paquete en el directorio de destino configurado (cwd por defecto)


Arquitecturas

La variable arch debe contener 'i686' o 'x86_64' dependiendo de las arquitecturas en las que se pueda instalar. También puedes usar any para paquetes que no dependen de la arquitectura.

Licencias

La variable licence está implementandose en los repositorios oficiales, y también debes usarla en tus paquetes. Úsala de la siguiente manera:

  • Un paquete de licencias se ha creado en [core] y almacena licencias comunes en /usr/share/licenses/common, por ejemplo: /usr/share/licenses/common/GPL. Si un paquete está licenciado bajo una de esas licencias, la variable licenses se nombrará con el nombre del directorio. En el ejemplo anterior: license=('GPL')

  • Si la licencia apropiada no se incluye en el paquete oficial de licencias, se pueden hacer vairas cosas

  1. El archivo de la licencia debe ser incluido en /usr/share/licenses/$pkgname/, por ejemplo: /usr/share/licenses/dibfoo/LICENSE. Una buena forma de hacerlo es usando:
    install -D -m644 LICENSE "${pkgdir}/usr/share/licenses/${pkgname}/LICENSE"
  2. Si las fuentes NO contienen los detalles de la licencia, y la licencia solo se muestra por ejemplo en un sitio web, copia la licencia en un archivo e incluyelo. Recuerda también llamarla de forma apropiada.
  3. Pon 'custom' en la variable de las licencias. Opcionalmente, puedes sustituir 'custom' por 'custom:"Nombre de la licencia"'.
  • Una vez que las licencias se utilizan dos o más veces en un repositorio oficial, incluyendo [community], se convierte en común.
  • Las licencias MIT, BSD, zlib/libpng y Python son casos especiales y no se pueden incluir en el paquete de licencias 'comunes'. Por el bien de la variable license, se sigue tratando como una licencia común: (license=('BSD'), license=('MIT'), license=('ZLIB') or license=('Python')) pero por el bien del sistema, es una licencia personal (custom), porque cada una tiene su propia línea de copyright. Cada paquete con licencia MIT, BSD, zlib/libpng o Python debe tener su licencia individualmente almacenada en /usr/share/licenses/$pkgname/.
  • La (L)GPL tiene varias versiones y permutaciones de esas versiones. Para el software (L)GPL, la convención es:
    • (L)GPL - (L)GPLv2 o cualquier versión posterior.
    • (L)GPL2 - (L)GPLv2 solo.
    • (L)GPL3 - (L)GPLv3 o cualquier versión posterior.

--Jorge Barroso (talk) 00:55, 1 March 2013 (UTC)