Suivant: Introduction, Monter: (dir) [Table des matières][Index]
Cette documentation décrit GNU Guix version f977cb2, un outil de gestion de paquets fonctionnel écrit pour le système GNU.
Ce manuel est aussi disponible en anglais (voir GNU Guix Reference Manual), en allemand (voir Referenzhandbuch zu GNU Guix), en chinois simplifié (voir GNU Guix参考手册), en espagnol (voir Manual de referencia de GNU Guix), en portugais brésilien (voir Manual de referência do GNU Guix), et en russe (voir Руководство GNU Guix). Si vous souhaitez nous aider à traduire ce manuel en français, vous pouvez nous rejoindre sur Weblate et sur la liste de diffusion traduc@traduc.org (voir Traduire Guix).
guix repl
guix build
guix edit
guix download
guix hash
guix import
guix refresh
guix style
guix lint
guix size
guix graph
guix publish
guix challenge
guix copy
guix container
guix weather
guix processes
operating-system
guix system
guix deploy
guix home
Suivant: Installation, Précédent: GNU Guix, Monter: GNU Guix [Table des matières][Index]
GNU Guix1 est un outil de gestion de paquets et une distribution pour le système GNU. Guix facilite pour les utilisateur·rice·s non privilégié·e·s l’installation, la mise à jour et la suppression de paquets, la restauration à un ensemble de paquets précédent, la construction de paquets depuis les sources et plus généralement aide à la création et à la maintenance d’environnements logiciels.
Vous pouvez installer GNU Guix sur un système GNU/Linux existant pour compléter les outils disponibles sans interférence (voir Installation) ou vous pouvez l’utiliser comme distribution système indépendante, Guix System2. Voir Distribution GNU.
Suivant: Distribution GNU, Monter: Introduction [Table des matières][Index]
Guix fournit une interface de gestion des paquets par la ligne de commande (voir Gestion de paquets), des outils pour aider au développement logiciel (voir Développement), des utilitaires en ligne de commande pour des utilisations plus avancées (voir Utilitaires) ainsi que des interfaces de programmation Scheme (voir Interface de programmation). Son démon de construction est responsable de la construction des paquets pour les utilisateur·rice·s (voir Paramétrer le démon) et du téléchargement des binaires pré-construits depuis les sources autorisées (voir Substituts).
Guix contient de nombreuses définitions de paquet GNU et non-GNU qui respectent tous les libertés de l’utilisateur ou utilisatrice. Il est extensible : chacun·e peut écrire ses propres définitions de paquets (voir Définition des paquets) et les rendre disponibles dans des modules de paquets indépendants (voir Modules de paquets). Il est aussi personnalisable : on peut dériver des définitions de paquets spécialisées à partir de définitions existantes, même depuis la ligne de commande (voir Options de transformation de paquets).
Sous le capot, Guix implémente la discipline de gestion de paquet fonctionnel inventé par Nix (voir Remerciements). Dans Guix le processus de construction et d’installation des paquets est vu comme une fonction dans le sens mathématique du terme. Cette fonction a des entrées (comme des scripts de construction, un compilateur et des bibliothèques) et renvoie un paquet installé. En tant que fonction pure, son résultat ne dépend que de ses entrées. Par exemple, il ne peut pas faire référence à des logiciels ou des scripts qui n’ont pas été explicitement passés en entrée. Une fonction de construction produit toujours le même résultat quand on lui donne le même ensemble d’entrée. Elle ne peut pas modifier l’environnement du système en cours d’exécution d’aucune manière ; par exemple elle ne peut pas créer, modifier ou supprimer des fichiers en dehors de ses répertoires de construction et d’installation. Ce résultat s’obtient en lançant les processus de construction dans des environnements isolés (ou des conteneurs) où seules les entrées explicites sont visibles.
Le résultat des fonctions de construction de paquets est mis en cache dans le système de fichier, dans répertoire spécial appelé le dépôt (voir Le dépôt). Chaque paquet est installé dans son répertoire propre dans le dépôt — par défaut dans /gnu/store. Le nom du répertoire contient un hash de toutes les entrées utilisées pour construire le paquet ; ainsi, changer une entrée donnera un nom de répertoire différent.
Cette approche est le fondement des fonctionnalités les plus importante de Guix : le support des mises à jour des paquets et des retours en arrière transactionnels, l’installation différenciée par utilisateur·rice et le ramassage de miettes pour les paquets (voir Fonctionnalités).
Précédent: Gérer ses logiciels avec Guix, Monter: Introduction [Table des matières][Index]
Guix fournit aussi une distribution du système GNU contenant uniquement des logiciels libres3. On peut installer la distribution elle-même (voir Installation du système), mais on peut aussi installer Guix comme gestionnaire de paquets par dessus un système GNU/Linux déjà installé (voir Installation). Pour distinguer ces deux cas, on appelle la distribution autonome le « système Guix » ou Guix System.
La distribution fournit les paquets cœur de GNU comme la GNU libc, GCC et
Binutils, ainsi que de nombreuses applications GNU et non-GNU. La liste
complète des paquets disponibles se trouve
en ligne ou en lançant
guix package
(voir Invoquer guix package
) :
guix package --list-available
Notre but est de fournir une distribution logicielle entièrement libre de GNU/Linux et d’autres variantes de GNU, en se concentrant sur la promotion et l’intégration étroite des composants GNU en insistant sur les programmes et les outils qui aident l’utilisateur·rice à exercer ses libertés.
Les paquets sont actuellement disponibles pour les plateformes suivantes :
x86_64-linux
Intel/AMD x86_64
avec le noyau Linux-libre.
i686-linux
Architecture Intel 32 bits (IA32) avec le noyau Linux-libre.
armhf-linux
L’architecture ARMv7-A avec gestion des flottants matérielle, Thumb-2 et NEON, avec l’interface binaire applicative (ABI) EABI hard-float et le noyau Linux-libre.
aarch64-linux
les processeurs 64 bits ARMv8-A en little-endian, avec le noyau Linux-libre.
i586-gnu
GNU/Hurd sur l’architecture Intel 32-bit (IA32).
Cette configuration en cours de développement est expérimentale. La manière
la plus facile pour vous de l’essayer est de créer une instance
hurd-vm-service-type
sur votre machine GNU/Linux
(voir hurd-vm-service-type
).
Voir Contribuer, sur la façon d’aider !
mips64el-linux (non pris en charge)
les processeurs MIPS 64 bits little-endian, en particulier la série Loongson, l’ABI n32 et le noyau Linux-Libre. Cette configuration n’est plus entièrement prise en charge ; en particulier, il n’y a pas de travaux en cours pour s’assurer que cette architecture fonctionne encore. Si quelqu’un décide de faire revivre cette architecture, le code est toujours disponible.
powerpc-linux (non pris en charge)
les processeurs PowerPC 32 bits big-endian, en particulier PowerPC G4 avec la prise en charge d’AltVec et le noyau Linux-Libre. Cette configuration n’est pas entièrement prise en charge et il n’y a pas de travaux en cours pour s’assurer que cette architecture fonctionne.
powerpc64le-linux
little-endian 64-bit Power ISA processors, Linux-Libre kernel. This includes POWER9 systems such as the RYF Talos II mainboard. This platform is available as a "technology preview": although it is supported, substitutes are not yet available from the build farm (voir Substituts), and some packages may fail to build (voir Suivi des bogues et des changements). That said, the Guix community is actively working on improving this support, and now is a great time to try it and get involved!
riscv64-linux
little-endian 64-bit RISC-V processors, specifically RV64GC, and Linux-Libre kernel. This platform is available as a "technology preview": although it is supported, substitutes are not yet available from the build farm (voir Substituts), and some packages may fail to build (voir Suivi des bogues et des changements). That said, the Guix community is actively working on improving this support, and now is a great time to try it and get involved!
Avec Guix System, vous déclarez tous les aspects de la configuration du système d’exploitation et guix s’occupe d’instancier la configuration de manière transactionnelle, reproductible et sans état (voir Configuration du système). Guix System utilise le noyau Linux-libre, le système d’initialisation Shepherd (voir Introduction dans The GNU Shepherd Manual), les outils GNU et la chaîne d’outils familière ainsi que l’environnement graphique et les services systèmes de votre choix.
Guix System est disponible sur toutes les plateformes ci-dessus à part
mips64el-linux
, powerpc-linux
, powerpc64le-linux
et
riscv64-linux
.
Pour des informations sur comment porter vers d’autres architectures et d’autres noyau, voir Porter vers une nouvelle plateforme.
La construction de cette distribution est un effort collaboratif et nous vous invitons à nous rejoindre ! Voir Contribuer, pour des informations sur la manière de nous aider.
Suivant: Installation du système, Précédent: Introduction, Monter: GNU Guix [Table des matières][Index]
You can install the package management tool Guix on top of an existing GNU/Linux or GNU/Hurd system4, referred to as a foreign distro. If, instead, you want to install the complete, standalone GNU system distribution, Guix System, voir Installation du système. This section is concerned only with the installation of Guix on a foreign distro.
Important : This section only applies to systems without Guix. Following it for existing Guix installations will overwrite important system files.
Lorsqu’il est installé sur une distro externe, GNU Guix complète les outils disponibles sans interférence. Ses données se trouvent exclusivement dans deux répertoires, typiquement /gnu/store et /var/guix ; les autres fichiers de votre système comme /etc sont laissés intacts.
Une fois installé, Guix peut être mis à jour en lançant guix pull
(voir Invoquer guix pull
).
guix-daemon
Suivant: Paramétrer le démon, Monter: Installation [Table des matières][Index]
This section describes how to install Guix from a self-contained tarball providing binaries for Guix and for all its dependencies. This is often quicker than installing from source, described later (voir Construire depuis Git).
Important : This section only applies to systems without Guix. Following it for existing Guix installations will overwrite important system files.
Some GNU/Linux distributions, such as Debian, Ubuntu, and openSUSE provide Guix through their own package managers. The version of Guix may be older than f977cb2 but you can update it afterwards by running ‘guix pull’.
We advise system administrators who install Guix, both from the installation
script or via the native package manager of their foreign distribution,
to also regularly read and follow security notices, as shown by
guix pull
.
For Debian or derivatives such as Ubuntu or Trisquel, call:
sudo apt install guix
Likewise, on openSUSE:
sudo zypper install guix
If you are running Parabola, after enabling the pcr (Parabola Community Repo) repository, you can install Guix with:
sudo pacman -S guix
The Guix project also provides a shell script, guix-install.sh, which automates the binary installation process without use of a foreign distro package manager5. Use of guix-install.sh requires Bash, GnuPG, GNU tar, wget, and Xz.
The script guides you through the following:
As root, run:
# cd /tmp # wget https://git.savannah.gnu.org/cgit/guix.git/plain/etc/guix-install.sh # chmod +x guix-install.sh # ./guix-install.sh
The script to install Guix is also packaged in Parabola (in the pcr repository). You can install and run it with:
sudo pacman -S guix-installer sudo guix-install.sh
Remarque : By default, guix-install.sh will configure Guix to download pre-built package binaries, called substitutes (voir Substituts), from the project’s build farms. If you choose not to permit this, Guix will build everything from source, making each installation and upgrade very expensive. Voir De la confiance en des binaires for a discussion of why you may want to build packages from source.
To use substitutes from
bordeaux.guix.gnu.org
,ci.guix.gnu.org
or a mirror, you must authorize them. For example,# guix archive --authorize < \ ~root/.config/guix/current/share/guix/bordeaux.guix.gnu.org.pub # guix archive --authorize < \ ~root/.config/guix/current/share/guix/ci.guix.gnu.org.pub
When you’re done installing Guix, voir Réglages applicatifs for extra configuration you might need, and Guide de démarrage for your first steps!
Remarque : L’archive d’installation binaire peut être (re)produite et vérifiée simplement en lançant la commande suivante dans l’arborescence des sources de Guix :
make guix-binary.system.tar.xz… ce qui à son tour lance :
guix pack -s system --localstatedir \ --profile-name=current-guix guixVoir Invoquer
guix pack
, pour plus d’info sur cet outil pratique.
Should you eventually want to uninstall Guix, run the same script with the --uninstall flag:
./guix-install.sh --uninstall
With --uninstall, the script irreversibly deletes all the Guix files, configuration, and services.
Suivant: Invoquer guix-daemon
, Précédent: Installation binaire, Monter: Installation [Table des matières][Index]
During installation, the build daemon that must be running to use Guix
has already been set up and you can run guix
commands in your
terminal program, voir Guide de démarrage:
guix build hello
If this runs through without error, feel free to skip this section. You should continue with the following section, Réglages applicatifs.
However, now would be a good time to replace outdated daemon versions, tweak
it, perform builds on other machines (voir Utiliser le dispositif de déchargement), or
start it manually in special environments like “chroots” (voir Chrooter dans un système existant) or WSL (not needed for WSL images created with
Guix, voir wsl2-image-type
). If you want to know
more or optimize your system, this section is worth reading.
Les opérations comme la construction d’un paquet ou le lancement du
ramasse-miettes sont toutes effectuées par un processus spécialisé, le démon
de construction, pour le compte des clients. Seul le démon peut accéder au
dépôt et à sa base de données associée. Ainsi, toute opération manipulant
le dépôt passe par le démon. Par exemple, les outils en ligne de commande
comme guix package
et guix build
communiquent avec le
démon (via des appels de procédures distantes) pour lui dire quoi faire.
Les sections suivantes expliquent comment préparer l’environnement du démon de construction. Voir Substituts pour apprendre comment permettre le téléchargement de binaires pré-construits.
Suivant: Utiliser le dispositif de déchargement, Monter: Paramétrer le démon [Table des matières][Index]
Dans une installation standard multi-utilisateur·rice·s, Guix et son démon —
le programme guix-daemon
— sont installés par la personne qui
administre le système ; /gnu/store appartient à root
et
guix-daemon
est lancé en root
. Les utilisateur·rice·s
non-privilégié·e·s peuvent utiliser les outils Guix pour construire des
paquets ou accéder au dépôt et le démon le fera pour leur compte en
s’assurant que le dépôt garde un état cohérent et permet le partage des
paquets déjà construits entre les utilisateur·rice·s.
Alors que guix-daemon
tourne en root
, vous n’avez pas
forcément envie que les processus de construction de paquets tournent aussi
en root
, pour des raisons de sécurité évidentes. Pour éviter cela,
vous devriez créer une réserve spéciale de comptes de construction que
les processus de construction démarrés par le démon utiliseront. Ces
comptes de construction n’ont pas besoin d’un shell ou d’un répertoire
personnel ; ils seront seulement utilisés quand le démon délaissera ses
privilèges root
dans les processus de construction. En ayant
plusieurs de ces comptes, vous permettez au démon de lancer des processus de
construction distincts sous des UID différent, ce qui garanti qu’aucune
interférence n’ait lieu entre les uns et les autres — une fonctionnalité
essentielle puisque les constructions sont supposées être des fonctions
pures (voir Introduction).
Sur un système GNU/Linux, on peut créer une réserve de comptes de
construction comme ceci (avec la syntaxe Bash et les commandes
shadow
) :
# groupadd --system guixbuild # for i in $(seq -w 1 10); do useradd -g guixbuild -G guixbuild \ -d /var/empty -s $(which nologin) \ -c "Compte de construction Guix $i" --system \ guixbuilder$i; done
Le nombre de comptes de construction détermine le nombre de tâches de
constructions qui peuvent tourner en parallèle, tel que spécifié par
l’option --max-jobs (voir --max-jobs). Pour utiliser guix system vm
et les
commandes liées, vous devrez ajouter les comptes de construction au groupe
kvm
pour qu’ils puissent accéder à /dev/kvm avec -G
guixbuild,kvm
plutôt que -G guixbuild
(voir Invoquer guix system
).
Le programme guix-daemon
peut ensuite être lancé en root
avec
la commande suivante6 :
# guix-daemon --build-users-group=guixbuild
De cette façon, le démon démarre les processus de construction dans un
chroot, sous un des comptes guixbuilder
. Sur GNU/Linux par défaut,
l’environnement chroot ne contient rien d’autre que :
/dev
minimal, créé presque indépendamment du
/dev
de l’hôte7 ;
/proc
; il ne montre que les processus du conteneur car
on utilise une espace de nom séparé pour les PID ;
localhost
à
127.0.0.1
;
Le chroot ne contient pas de dossier /home, et la variable
d’environnement HOME
est initialisée au répertoire
/homeless-shelter inexistant. Cela permet de mettre en valeur les
utilisations inappropriées de HOME
dans les scripts de construction
des paquets.
All this usually enough to ensure details of the environment do not influence build processes. In some exceptional cases where more control is needed—typically over the date, kernel, or CPU—you can resort to a virtual build machine (voir virtual build machines).
Vous pouvez influencer le répertoire où le démon stocke les arbres de
construction via la variable d’environnement TMPDIR
. Cependant,
l’arbre de construction dans le chroot sera toujours appelé
/tmp/guix-build-nom.drv-0, où nom est le nom de la
dérivation — p.ex., coreutils-8.24
. De cette façon, la valeur de
TMPDIR
ne fuite pas à l’intérieur des environnements de construction,
ce qui évite des différences lorsque le processus de construction retient le
nom de leur répertoire de construction.
Le démon prend aussi en compte la variable d’environnement
https_proxy
pour ses téléchargements HTTP et HTTPS, que ce soit pour
les dérivations à sortie fixes (voir Dérivations) ou pour les substituts
(voir Substituts).
Si vous installez Guix en tant qu’utilisateur·rice non privilégié·ée, il est
toujours possible d’exécuter guix-daemon
à condition de passer
--disable-chroot. Cependant, les processus de compilation ne
seront pas isolés les uns des autres, ni du reste du système. Ainsi, les
processus de compilation peuvent interférer les uns avec les autres, et
peuvent accéder à des programmes, des bibliothèques et d’autres fichiers
disponibles sur le système - ce qui rend beaucoup plus difficile de les
considérer comme des fonctions pures.
Suivant: Support de SELinux, Précédent: Réglages de l’environnement de construction, Monter: Paramétrer le démon [Table des matières][Index]
Si vous le souhaitez, le démon de construction peut décharger des
constructions de dérivation sur d’autres machines Guix avec le crochet
de construction offload
8. Lorsque cette fonctionnalité est activée, Guix
lit une liste de machines de constructions spécifiée par l’utilisateur·rice
dans /etc/guix/machines.scm ; à chaque fois qu’une construction est
demandée, par exemple par guix build
, le démon essaie de la décharger
sur une des machines qui satisfont les contraintes de la dérivation, en
particulier le type de système, p. ex. x86_64-linux. Une même
machine peut avoir plusieurs types de systèmes, soit parce que son
architecture le supporte nativement, soit par émulation
(voir Émulation transparente avec QEMU), soit
les deux. Les prérequis manquants pour la construction sont copiés par SSH
sur la machine de construction qui procède ensuite à la construction ; si
elle réussit, les sorties de la construction sont copiés vers la machine de
départ. Le dispsitif de déchargement est dotée d’un scheduler de base qui
tente de sélectionner la meilleure machine. La meilleure machine est
choisie parmi les machines disponibles sur la base de critères tels que :
parallel-builds
de son objet build-machine
.
speed
de son
objet build-machine
.
overload-threshold
de son
objet build-machine
.
Le fichier /etc/guix/machines.scm ressemble typiquement à cela :
(list (build-machine
(name "eightysix.example.org")
(system "x86_64-linux")
(host-key "ssh-ed25519 AAAAC3Nza…")
(user "bob")
(speed 2.)) ;incroyablement rapide !
(build-machine
(name "armeight.example.org")
(systems (list "aarch64-linux"))
(host-key "ssh-rsa AAAAB3Nza…")
(user "alice")
;; Rappelez-vous que « guix offload » est démarré par
;; « guix-daemon » en root.
(private-key "/root/.ssh/identité-pour-guix")))
Dans l’exemple ci-dessus nous spécifions une liste de deux machines de
construction, une pour l’architecture x86_64
et i686
et une
pour l’architecture aarch64
.
En fait, ce fichier est — et ça ne devrait pas vous surprendre ! — un
fichier Scheme qui est évalué au démarrage du crochet offload
. Sa
valeur de retour doit être une liste d’objets build-machine
. Même si
cet exemple montre une liste fixée de machines de construction, on pourrait
imaginer par exemple utiliser DNS-SD pour renvoyer une liste de machines de
constructions potentielles découvertes sur le réseau local
(voir Guile-Avahi dans Using Avahi in Guile Scheme
Programs). Le type de données build-machine
est détaillé plus bas.
Ce type de données représente les machines de construction sur lesquelles le démon peut décharger des constructions. Les champs importants sont :
name
Le nom d’hôte de la machine distante.
systèmes
Le type de système de la machine distante, p. ex., (list
"x86_64-linux" "i686-linux")
.
user
The user account on the remote machine to use when connecting over SSH. Note that the SSH key pair must not be passphrase-protected, to allow non-interactive logins.
host-key
Cela doit être la clef d’hôte SSH publique de la machine au format OpenSSH. Elle est utilisée pour authentifier la machine lors de la connexion. C’est une longue chaîne qui ressemble à cela :
ssh-ed25519 AAAAC3NzaC…mde+UhL hint@example.org
Si la machine utilise le démon OpenSSH, sshd
, la clef d’hôte se
trouve dans un fichier comme /etc/ssh/ssh_host_ed25519_key.pub.
Si la machine utilise le démon SSH de GNU lsh, la clef d’hôte est dans
/etc/lsh/host-key.pub ou un fichier similaire. Elle peut être
convertie au format OpenSSH avec lsh-export-key
(voir Converting keys dans LSH Manual) :
$ lsh-export-key --openssh < /etc/lsh/host-key.pub ssh-rsa AAAAB3NzaC1yc2EAAAAEOp8FoQAAAQEAs1eB46LV…
Il y a un certain nombre de champs facultatifs que vous pouvez remplir :
port
(par défaut : 22
)Numéro de port du serveur SSH sur la machine.
private-key
(par défaut : ~root/.ssh/id_rsa)Le fichier de clef privée SSH à utiliser lors de la connexion à la machine, au format OpenSSH. Cette clef ne doit pas être protégée par phrase de passe.
Remarquez que la valeur par défaut est la clef privée du compte root. Assurez-vous qu’elle existe si vous utilisez la valeur par défaut.
compression
(par défaut : "zlib@openssh.com,zlib"
)compression-level
(par défaut : 3
)Les méthodes de compression au niveau SSH et le niveau de compression demandé.
Remarquez que le déchargement utilise la compression SSH pour réduire la bande passante utilisée lors du transfert vers et depuis les machines de construction.
daemon-socket
(par défaut : "/var/guix/daemon-socket/socket"
)Le nom de fichier du socket Unix-domain sur lequel guix-daemon
écoute sur cette machine.
overload-threshold
(par défaut : 0.8
)Le seuil de charge au-dessus duquel une machine de déchargement potentielle
est ignorée par le programme de déchargement. Cette valeur se traduit
approximativement par l’utilisation totale du processeur de la machine de
construction, allant de 0,0 (0%) à 1,0 (100%). Elle peut également être
désactivée en réglant overload-threshold
sur #f
.
parallel-builds
(par défaut : 1
)Le nombre de constructions qui peuvent tourner simultanément sur la machine.
speed
(par défaut : 1.0
)Un « facteur de vitesse relatif ». L’ordonnanceur des constructions tendra à préférer les machines avec un plus grand facteur de vitesse.
features
(par défaut : '()
)Une liste de chaînes qui contient les fonctionnalités spécifiques supportées
par la machine. Un exemple est "kvm"
pour les machines qui ont le
module Linux KVM et le support matériel correspondant. Les dérivations
peuvent demander des fonctionnalités par leur nom et seront orchestrées sur
les machines de construction correspondantes.
Remarque : On Guix System, instead of managing /etc/guix/machines.scm independently, you can choose to specify build machines directly in the
operating-system
declaration, in thebuild-machines
field ofguix-configuration
. Voirbuild-machines
field ofguix-configuration
.
La commande guix
doit être dans le chemin de recherche des machines
de construction. Vous pouvez vérifier si c’est le cas en lançant :
ssh build-machine guix repl --version
Il reste une dernière chose à faire maintenant que machines.scm est
en place. Comme expliqué ci-dessus, lors du déchargement les fichiers sont
transférés entre les dépôts des machines. Pour que cela fonctionne, vous
devez d’abord générer une paire de clef sur chaque machine pour permettre au
démon d’exporter des archives signées des fichiers de son dépôt
(voir Invoquer guix archive
) :
# guix archive --generate-key
Remarque : This key pair is not related to the SSH key pair that was previously mentioned in the description of the
build-machine
data type.
Chaque machine de construction doit autoriser la clef de la machine maîtresse pour qu’ils acceptent les éléments de dépôt de celle-ci :
# guix archive --authorize < master-public-key.txt
De même, la machine maîtresse doit autoriser les clefs de chaque machine de construction.
Toute cette histoire de clefs permet d’exprimer la confiance mutuelle deux-à-deux entre le maître et les machines de construction. Concrètement, lorsque le maître reçoit des fichiers d’une machine de construction (et vice-versa), son démon de construction s’assure qu’ils sont authentiques, n’ont pas été modifiés par un tiers et qu’il sont signés par un clef autorisée.
Pour tester que votre paramétrage fonctionne, lancez cette commande sur le nœud maître :
# guix offload test
Cela essaiera de se connecter à toutes les machines de construction spécifiées dans /etc/guix/machines.scm, s’assurera que Guix est disponible sur toutes les machines et tentera d’exporter vers la machine et d’importer depuis elle, et rapportera toute erreur survenu pendant le processus.
Si vous souhaitez tester un fichier de machines différent, spécifiez-le sur la ligne de commande :
# guix offload test machines-qualif.scm
Enfin, vous pouvez tester un sous-ensemble de machines dont le nom correspond à une expression rationnelle comme ceci :
# guix offload test machines.scm '\.gnu\.org$'
Pour afficher la charge actuelle de tous les hôtes de construction, lancez cette commande sur le nœud principal :
# guix offload status
Précédent: Utiliser le dispositif de déchargement, Monter: Paramétrer le démon [Table des matières][Index]
Guix inclus un fichier de politique SELinux dans etc/guix-daemon.cil qui peut être installé sur un système où SELinux est activé pour que les fichiers Guix soient étiquetés et pour spécifier le comportement attendu du démon. Comme Guix System ne fournit pas de politique SELinux de base, la politique du démon ne peut pas être utilisée sur le système Guix.
Remarque : The
guix-install.sh
binary installation script offers to perform the steps below for you (voir Installation binaire).
Pour installer la politique, lancez cette commande en root :
semodule -i /var/guix/profiles/per-user/root/current-guix/share/selinux/guix-daemon.cil
Then, as root, relabel the file system, possibly after making it writable:
mount -o remount,rw /gnu/store restorecon -R /gnu /var/guix
At this point you can start or restart guix-daemon
; on a
distribution that uses systemd as its service manager, you can do that with:
systemctl restart guix-daemon
Une fois la politique installée, le système de fichier ré-étiqueté et le
démon redémarré, il devrait être lancé dans le contexte
guix_daemon_t
. Vous pouvez le confirmer avec la commande suivante :
ps -Zax | grep guix-daemon
Surveillez les fichiers journaux de SELinux pendant que vous lancez une
commande comme guix build hello
pour vous convaincre que SELniux
permet toutes les opérations nécessaires.
La politique n’est pas parfaite. Voici une liste de limitations et de bizarreries qui vous devriez prendre en compte avant de déployer la politique SELinux fournie pour le démon Guix.
guix_daemon_socket_t
n’est pas vraiment utilisé. Aucune des
opérations sur les sockets n’impliquent de contextes qui ont quoi que ce
soit à voir avec guix_daemon_socket_t
. Ça ne fait pas de mal d’avoir
une étiquette inutilisée, mais il serait préférable de définir des règles
sur les sockets uniquement pour cette étiquette.
guix gc
ne peut pas accéder à n’importe quel lien vers les profils.
Par conception, l’étiquette de fichier de la destination d’un lien
symbolique est indépendant de l’étiquette du lien lui-même. Bien que tous
les profils sous $localstatedir aient une étiquette, les liens vers
ces profils héritent de l’étiquette du répertoire dans lequel ils se
trouvent. Pour les liens dans le répertoire personnel cela sera
user_home_t
. Mais pour les liens du répertoire personnel de root, ou
/tmp, ou du répertoire de travail du serveur HTTP, etc, cela ne
fonctionnera pas. SELinux empêcherait guix gc
de lire et de suivre
ces liens.
/gnu/store/.+-(guix-.+|profile)/bin/guix-daemon
reçoivent l’étiquette
guix_daemon_exec_t
; cela signifie que tout fichier avec ce
nom dans n’importe quel profil serait autorisé à se lancer dans le domaine
guix_daemon_t
. Ce n’est pas idéal. Un attaquant pourrait construire
un paquet qui fournit cet exécutable et convaincre un·e utilisateur·rice de
l’installer et de le lancer, ce qui l’élève dans le domaine
guix_daemon_t
. À ce moment SELinux ne pourrait pas l’empêcher
d’accéder à des fichiers autorisés pour les processus de ce domaine.
Vous devrez renommer le répertoire du dépôt après chaque mise à jour de
guix-daemon, par exemple après avoir lancé guix pull
. En
supposant que le dépôt est dans /gnu, vous pouvez le faire avec
restorecon -vR /gnu
, ou par d’autres moyens fournis par votre système
d’exploitation.
Nous pourrions générer une politique bien plus restrictive à l’installation,
pour que seuls les noms de fichiers exacts de l’exécutable
guix-daemon
actuellement installé soit étiqueté avec
guix_daemon_exec_t
, plutôt que d’utiliser une expression rationnelle
plus large. L’inconvénient c’est que root devrait installer ou mettre à
jour la politique à l’installation à chaque fois que le paquet Guix qui
fournit l’exécutable guix-daemon
effectivement exécuté est mis à
jour.
Suivant: Réglages applicatifs, Précédent: Paramétrer le démon, Monter: Installation [Table des matières][Index]
guix-daemon
Le programme guix-daemon
implémente toutes les fonctionnalités
d’accès au dépôt. Cela inclus le lancement des processus de construction,
le lancement du ramasse-miettes, la demande de disponibilité des résultats
de construction, etc. Il tourne normalement en root
comme ceci :
# guix-daemon --build-users-group=guixbuild
Ce démon peut aussi être démarré avec le protocole d’« activation par socket
» de systemd (voir make-systemd-constructor
dans le manuel de GNU Shepherd).
Pour des détails sur son paramétrage, voir Paramétrer le démon.
Par défaut, guix-daemon
lance les processus de construction sous
différents UIDs récupérés depuis le groupe de construction spécifié avec
--build-users-group
. En plus, chaque processus de construction est
lancé dans un environnement chroot qui ne contient que le sous-ensemble du
dépôt dont le processus de construction dépend, tel que spécifié par sa
dérivation (voir dérivation), plus un
ensemble de répertoires systèmes spécifiques. Par défaut ce dernier
contient /dev et /dev/pts. De plus, sous GNU/Linux,
l’environnement de construction est un conteneur : en plus d’avoir sa
propre arborescence du système de fichier, il a un espace de nom de montage
séparé, son propre espace de nom PID, son espace de nom de réseau, etc.
Cela aide à obtenir des constructions reproductibles
(voir Fonctionnalités).
Lorsque le démon effectue une construction pour le compte de
l’utilisateur·rice, il crée un répertoire de construction sous /tmp
ou sous le répertoire spécifié par sa variable d’environnement
TMPDIR
. Ce répertoire est partagé avec le conteneur pendant toute la
durée de la construction, bien que dans le conteneur, l’arbre de compilation
soit toujours appelé /tmp/guix-build-name.drv-0.
Le répertoire de construction est automatiquement supprimé à la fin, à moins que la construction n’ait échoué et que le client ait spécifié --keep-failed (voir --keep-failed).
Le démon écoute les connexions et démarre un sous-processus pour chaque
session démarrée par un client (l’une des sous-commandes de
guix
). La commande guix processes
vous permet d’obtenir
un aperçu de l’activité sur votre système en affichant chaque session et
client actifs. Voir Invoquer guix processes
pour plus d’informations.
Les options en ligne de commande suivantes sont disponibles :
--build-users-group=groupe
Utiliser les comptes du groupe pour lancer les processus de construction (voir comptes de construction).
--no-substitutes
¶Ne pas utiliser de substitut pour les résultats de la construction. C’est-à-dire, toujours construire localement plutôt que de permettre le téléchargement de binaires pré-construits (voir Substituts).
Lorsque le démon est lancé avec --no-substitutes
, les clients peuvent
toujours activer explicitement la substitution via l’appel de procédure
distante set-build-options
(voir Le dépôt).
--substitute-urls=urls
Considérer urls comme la liste séparée par des espaces des URL des
sources de substituts par défaut. Lorsque cette option est omise,
‘https://bordeaux.guix.gnu.org https://ci.guix.gnu.org
’ est utilisé.
Cela signifie que les substituts sont téléchargés depuis les urls, tant qu’ils sont signés par une signature de confiance (voir Substituts).
Voir Récupérer des substituts d’autres serveurs, pour plus d’information sur la configuration du démon pour récupérer des substituts d’autres serveurs.
--no-offload
N’essaye pas de décharger les constructions vers d’autres machines (voir Utiliser le dispositif de déchargement). C’est-à-dire que tout sera construit localement au lieu de décharger les constructions à une machine distante.
--cache-failures
Mettre les échecs de construction en cache. Par défaut, seules les constructions réussies sont mises en cache.
Lorsque cette option est utilisée, guix gc --list-failures
peut
être utilisé pour demander l’ensemble des éléments du dépôt marqués comme
échoués ; guix gc --clear-failures
vide la liste des éléments
aillant échoué. Voir Invoquer guix gc
.
--cores=n
-c n
Utiliser n cœurs CPU pour construire chaque dérivation ; 0
signifie autant que possible.
La valeur par défaut est 0
, mais elle peut être annulée par les
clients, comme avec l’option --cores
de guix build
(voir Invoquer guix build
).
L’effet est de définir la variable d’environnement NIX_BUILD_CORES
dans le processus de construction, qui peut ensuite l’utiliser pour
exploiter le parallélisme en interne — par exemple en lançant make
-j$NIX_BUILD_CORES
.
--max-jobs=n
-M n
Permettre au plus n travaux de construction en parallèle. La valeur
par défaut est 1
. La mettre à 0
signifie qu’aucune
construction ne sera effectuée localement ; à la place, le démon déchargera
les constructions (voir Utiliser le dispositif de déchargement) ou échouera.
--max-silent-time=secondes
Lorsque le processus de construction ou de substitution restent silencieux pendant plus de secondes, le terminer et rapporter une erreur de construction.
The default value is 3600
(one hour).
La valeur spécifiée ici peut être annulée par les clients (voir --max-silent-time
).
--timeout=secondes
De même, lorsque le processus de construction ou de substitution dure plus de secondes, le terminer et rapporter une erreur de construction.
The default value is 24 hours.
La valeur spécifiée ici peut être annulée par les clients (voir --timeout
).
--rounds=N
Construire chaque dérivations N fois à la suite, et lever une erreur
si les résultats de construction consécutifs ne sont pas identiques
bit-à-bit. Remarquez que ce paramètre peut être modifié par les clients
comme guix build
(voir Invoquer guix build
).
Lorsqu’utilisé avec --keep-failed, la sortie différente est gardée dans le dépôt sous /gnu/store/…-check. Cela rend plus facile l’étude des différences entre les deux résultats.
--debug
Produire une sortie de débogage.
Cela est utile pour déboguer des problèmes de démarrage du démon, mais
ensuite elle peut être annulée par les clients, par exemple par l’option
--verbosity
de guix build
(voir Invoquer guix build
).
--chroot-directory=rép
Ajouter rép au chroot de construction.
Cela peut changer le résultat d’un processus de construction — par exemple s’il utilise une dépendance facultative trouvée dans rép lorsqu’elle est disponible ou pas sinon. Pour cette raison, il n’est pas recommandé d’utiliser cette option. À la place, assurez-vous que chaque dérivation déclare toutes les entrées dont elle a besoin.
--disable-chroot
Désactive les constructions dans un chroot.
Utiliser cette option n’est pas recommandé car, de nouveau, elle permet aux
processus de construction d’accéder à des dépendances non déclarées. Elle
est nécessaire cependant lorsque guix-daemon
tourne sans
privilèges.
--log-compression=type
Compresser les journaux de construction suivant le type, parmi
gzip
, bzip2
ou none
.
À moins que --lose-logs ne soit utilisé, tous les journaux de construction sont gardés dans localstatedir. Pour gagner de la place, le démon les compresse automatiquement avec gzip par défaut.
--discover[=yes|no]
Indique s’il faut découvrir les serveurs de substitut sur le réseau local avec mDNS et DNS-SD.
Cette fonction est encore expérimentale. Cependant, voici quelques réflexions sur le sujet.
guix publish
sur votre LAN ne peut
pas vous proposer de binaire malveillants, mais il ou elle pourrait
apprendre quels logiciels vous installez ;
Il est aussi possible d’activer ou de désactiver la découverte de serveurs de substituts à l’exécution en lançant :
herd discover guix-daemon on herd discover guix-daemon off
--disable-deduplication
¶Désactiver la « déduplication » automatique des fichiers dans le dépôt.
Par défaut, les fichiers ajoutés au dépôt sont automatiquement « dédupliqués » : si un nouveau fichier est identique à un autre fichier trouvé dans le dépôt, le démon en fait un lien en dur vers l’autre fichier. Cela réduit considérablement l’utilisation de l’espace disque au prix d’une charge en entrée/sortie plus grande à la fin d’un processus de construction. Cette option désactive cette optimisation.
--gc-keep-outputs[=yes|no]
Dire si le ramasse-miettes (GC) doit garder les sorties des dérivations utilisées.
Lorsqu’il est réglé sur yes
, le GC conservera les sorties de toute
dérivation active disponibles dans le dépôt—les fichiers .drv. La
valeur par défaut est no
, ce qui signifie que les sorties des
dérivations ne sont conservées que si elles sont accessibles à partir d’une
racine GC. Voir Invoquer guix gc
, pour en savoir plus sur les racines GC.
--gc-keep-derivations[=yes|no]
Dire si le ramasse-miettes (GC) doit garder les dérivations correspondant à des sorties utilisées.
Lorsqu’il est réglé à « yes », comme c’est le cas par défaut, le GC garde
les dérivations — c.-à-d. les fichiers .drv — tant qu’au moins une
de leurs sorties est utilisée. Cela permet de garder une trace de l’origine
des éléments du dépôt. Le mettre à no
préserve un peu d’espace
disque.
De cette manière, le réglage de l’option --gc-keep-derivations sur
yes
étend le résultat des sorties aux dérivations, et le réglage de
l’option --gc-keep-outputs sur yes
étend le résultat des
dérivations aux sorties. Lorsque les deux sont réglés sur yes
,
l’effet est de conserver tous les prérequis de construction (les sources, le
compilateur, les bibliothèques et autres outils de construction) des objets
actifs dans le dépôt, que ces prérequis soient accessibles ou non depuis une
racine GC. Cela est pratique pour les développeurs car cela permet d’éviter
les reconstructions ou les téléchargements.
--impersonate-linux-2.6
Sur les systèmes basés sur Linux, imiter Linux 2.6. Cela signifie que
l’appel système uname
du noyau indiquera 2.6 comme numéro de
version.
Cela peut être utile pour construire des programmes qui dépendent (généralement sans fondement) du numéro de version du noyau.
--lose-logs
Ne pas garder les journaux de construction. Par défaut ils sont gardés dans localstatedir/guix/log.
--system=système
Supposer que système est le type de système actuel. Par défaut c’est
la paire architecture-noyau trouvée à la configuration, comme
x86_64-linux
.
--listen=extrémité
Écouter les connexions sur extrémité. extrémité est interprété
comme un nom de fichier d’un socket Unix-domain s’il commence par /
(barre oblique). Sinon, extrémité est interprété comme un nom de
domaine ou d’hôte et un port sur lequel écouter. Voici quelques exemples :
--listen=/gnu/var/daemon
Écouter les connexions sur le socket Unix-domain /gnu/var/daemon en le créant si besoin.
--listen=localhost
¶Écouter les connexions TCP sur l’interface réseau correspondant à
localhost
sur le port 44146.
--listen=128.0.0.42:1234
Écouter les connexions TCP sur l’interface réseau correspondant à
128.0.0.42
sur le port 1234.
Cette option peut être répétée plusieurs fois, auquel cas
guix-daemon
accepte des connexions sur tous les paramètres
spécifiés. On peut indiquer aux commandes clientes à quoi se connecter en
paramétrant la variable d’environnement GUIX_DAEMON_SOCKET
(voir GUIX_DAEMON_SOCKET
).
Remarque : Le protocole du démon est non authentifié et non chiffré. Utiliser --listen=host est adapté sur des réseaux locaux, comme pour des grappes de serveurs, où seuls des nœuds de confiance peuvent se connecter au démon de construction. Dans les autres cas où l’accès à distance au démon est requis, nous conseillons d’utiliser un socket Unix-domain avec SSH.
Lorsque --listen est omis, guix-daemon
écoute les
connexions sur le socket Unix-domain situé à
localstatedir/guix/daemon-socket/socket.
Suivant: Mettre à niveau Guix, Précédent: Invoquer guix-daemon
, Monter: Installation [Table des matières][Index]
Lorsque vous utilisez Guix par dessus une distribution GNU/Linux qui n’est pas Guix System — ce qu’on appelle une distro externe — quelques étapes supplémentaires sont requises pour que tout soit en place. En voici certaines.
Les paquets installés via Guix n’utiliseront pas les données de
régionalisation du système hôte. À la place, vous devrez d’abord installer
l’un des paquets linguistiques disponibles dans Guix puis définir la
variable d’environnement GUIX_LOCPATH
:
$ guix install glibc-locales $ export GUIX_LOCPATH=$HOME/.guix-profile/lib/locale
Remarquez que le paquet glibc-locales
contient les données de tous
les paramètres linguistiques pris en charge par la GNU libc et pèse
environ 930 Mio9. Si vous n’avez besoin que de quelques paramètres, vous pouvez définir
un paquet personnalisé avec la procédure make-glibc-utf8-locales
du
module (gnu packages base)
. L’exemple suivant défini un paquet
contenant plusieurs paramètres linguistiques canadiens connus de
GNU libc, qui pèse environ 14 Mio :
(use-modules (gnu packages base)) (define my-glibc-locales (make-glibc-utf8-locales glibc #:locales (list "en_CA" "fr_CA" "ik_CA" "iu_CA" "shs_CA") #:name "glibc-canadian-utf8-locales"))
La variable GUIX_LOCPATH
joue un rôle similaire à LOCPATH
(voir LOCPATH
dans The GNU C Library Reference
Manual). Il y a deux différences importantes cependant :
GUIX_LOCPATH
n’est pris en compte que par la libc dans Guix et pas par
la libc fournie par les distros externes. Ainsi, utiliser
GUIX_LOCPATH
vous permet de vous assurer que les programmes de la
distro externe ne chargeront pas de données linguistiques incompatibles.
/X.Y
à chaque entrée de GUIX_LOCPATH
,
où X.Y
est la version de la libc — p. ex. 2.22
. Cela
signifie que, si votre profile Guix contient un mélange de programmes liés
avec des versions différentes de la libc, chaque version de la libc essaiera
de charger les environnements linguistiques dans le bon format.
Cela est important car le format des données linguistiques utilisés par différentes version de la libc peuvent être incompatibles.
Lorsque vous utilisez Guix sur une distro externe, nous recommandons
fortement que ce système fasse tourner le démon de cache de service de
noms de la bibliothèque C de GNU, nscd
, qui devrait écouter sur
le socket /var/run/nscd/socket. Sans cela, les applications
installées avec Guix peuvent échouer à résoudre des noms d’hôtes ou de
comptes, ou même planter. Les paragraphes suivants expliquent pourquoi.
La bibliothèque C de GNU implémente un name service switch (NSS), qui est un mécanisme d’extension pour les « résolutions de noms » en général : résolution de nom d’hôte, de compte utilisateur·rice et plus (voir Name Service Switch dans The GNU C Library Reference Manual).
Comme il est extensible, NSS supporte des greffons qui fournissent une
nouvelle implémentation de résolution de nom : par exemple le greffon
nss-mdns
permet la résolution de noms d’hôtes en .local
, le
greffon nis
permet la résolution de comptes avec le Network
Information Service (NIS), etc. Ces « services de recherches »
supplémentaires sont configurés au niveau du système dans
/etc/nsswitch.conf, et tous les programmes qui tournent sur ce
système prennent en compte ces paramètres (voir NSS Configuration File dans The GNU C Reference Manual).
Lorsqu’ils essayent d’effectuer une résolution de nom — par exemple en
appelant la fonction getaddrinfo
en C — les applications essayent
d’abord de se connecter au nscd ; en cas de réussite, nscd effectue la
résolution de nom pour eux. Si le nscd ne tourne pas, alors ils effectuent
la résolution eux-mêmes, en changeant les service de résolution dans leur
propre espace d’adressage et en le lançant. Ce services de résolution de
noms — les fichiers libnns_*.so — sont dlopen
és mais ils
peuvent provenir de la bibliothèque C du système, plutôt que de la
bibliothèque C à laquelle l’application est liée (la bibliothèque C de
Guix).
Et c’est là que se trouve le problème : si votre application est liée à la
bibliothèque C de Guix (disons, glibc-2.24) et essaye de charger les
greffons NSS d’une autre bibliothèque C (disons, libnss_mdns.so
pour
glibc-2.22), il est très probable qu’elle plante ou que sa résolution de nom
échoue de manière inattendue.
Lancer nscd
sur le système, entre autres avantages, élimine ce
problème d’incompatibilité binaire car ces fichiers libnss_*.so
sont
chargés par le processus nscd
, pas par l’application elle-même.
La majorité des applications graphiques utilisent fontconfig pour trouver et
charger les polices et effectuer le rendu côté client X11. Le paquet
fontconfig
dans Guix cherche les polices dans
$HOME/.guix-profile par défaut. Ainsi, pour permettre aux
applications graphiques installées avec Guix d’afficher des polices, vous
devez aussi installer des polices avec Guix. Les paquets de polices
essentiels sont font-ghostscript
, font-dejavu
et
font-gnu-freefont
.
Lorsque vous installez ou supprimez des polices, ou lorsque vous remarquez qu’une application ne trouve pas les polices, vous pouvez avoir besoin d’installer Fontconfig et de forcer un rafraîchissement de son cache de police avec :
guix install fontconfig fc-cache -rv
Pour afficher des textes écrits en chinois, en japonais ou en coréen dans
les applications graphiques, installez font-adobe-source-han-sans
ou
font-wqy-zenhei
. Le premier a plusieurs sorties, une par famille de
langue (voir Des paquets avec plusieurs résultats). Par exemple, la commande
suivante installe les polices pour le chinois :
guix install font-adobe-source-han-sans:cn
Les vieux programmes comme xterm
n’utilisent pas fontconfig et
s’appuient sur le rendu du côté du serveur. Ces programmes ont besoin de
spécifier le nom complet de la police en utilisant XLFD (X Logical Font
Description), comme ceci :
-*-dejavu sans-medium-r-normal-*-*-100-*-*-*-*-*-1
Pour pouvoir utiliser ces noms complets avec les polices TrueType installées dans votre profil Guix, vous devez étendre le chemin des polices du serveur X :
xset +fp $(dirname $(readlink -f ~/.guix-profile/share/fonts/truetype/fonts.dir))
Ensuite, vous pouvez lancer xlsfonts
(du paquet xlsfonts
) pour
vous assurer que vos polices TrueType y sont listées.
Le paquet nss-certs
fournit les certificats X.509 qui permettent aux
programmes d’authentifier les serveurs web par HTTPS.
Lorsque vous utilisez Guix sur une distribution externe, vous pouvez installer ce paquet et définir les variables d’environnement adéquates pour que les paquets sachent où trouver les certificats. Voir Certificats X.509, pour des informations détaillées.
Quand vous installez des paquets Emacs avec Guix, les fichiers Elips sont
placés dans le répertoire share/emacs/site-lisp/ du profil dans
lequel ils sont installés. Les bibliothèques Elisp sont rendues disponibles
dans Emacs avec la variable d’environnement EMACSLOADPATH
, qui est
initialisée à l’installation d’Emacs lui-même.
Additionally, autoload definitions are automatically evaluated at the
initialization of Emacs, by the Guix-specific
guix-emacs-autoload-packages
procedure. This procedure can be
interactively invoked to have newly installed Emacs packages discovered,
without having to restart Emacs. If, for some reason, you want to avoid
auto-loading the Emacs packages installed with Guix, you can do so by
running Emacs with the --no-site-file option (voir Init File dans The GNU Emacs Manual).
Remarque : Most Emacs variants are now capable of doing native compilation. The approach taken by Guix Emacs however differs greatly from the approach taken upstream.
Upstream Emacs compiles packages just-in-time and typically places shared object files in a special folder within your
user-emacs-directory
. These shared objects within said folder are organized in a flat hierarchy, and their file names contain two hashes to verify the original file name and contents of the source code.Guix Emacs on the other hand prefers to compile packages ahead-of-time. Shared objects retain much of the original file name and no hashes are added to verify the original file name or the contents of the file. Crucially, this allows Guix Emacs and packages built against it to be grafted (voir grafts), but at the same time, Guix Emacs lacks the hash-based verification of source code baked into upstream Emacs. As this naming schema is trivial to exploit, we disable just-in-time compilation.
Further note, that
emacs-minimal
—the default Emacs for building packages—has been configured without native compilation. To natively compile your emacs packages ahead of time, use a transformation like --with-input=emacs-minimal=emacs.
Précédent: Réglages applicatifs, Monter: Installation [Table des matières][Index]
Pour mettre Guix à niveau, lancez :
guix pull
Voir Invoquer guix pull
, pour plus d’informations.
Sur une distribution externe, vous pouvez mettre à jour le démon de construction en lançant :
sudo -i guix pull
suivi de (dans le cas où votre distribution utilise l’outil de gestion de services Systemd) :
systemctl restart guix-daemon.service
Sur Guix System, la mise à jour du démon est effectuée par la
reconfiguration du système (voir guix system
reconfigure
).
Suivant: Guide de démarrage, Précédent: Installation, Monter: GNU Guix [Table des matières][Index]
Cette section explique comment installer Guix System sur une machine. Guix, en tant que gestionnaire de paquets, peut aussi être installé sur un système GNU/Linux déjà installé, voir Installation.
Suivant: Considérations matérielles, Monter: Installation du système [Table des matières][Index]
Nous considérons Guix System comme prêt pour une grande variété de cas d’utilisation pour le « bureau » et le serveur. Les garanties de fiabilité qu’il fournit — les mises à jour transactionnelles, les retours en arrières et la reproductibilité — en font une solide fondation.
More and more system services are provided (voir Services).
Nevertheless, before you proceed with the installation, be aware that some services you rely on may still be missing from version f977cb2.
Plus qu’un avertissement, c’est une invitation à rapporter les problèmes (et vos succès !) et à nous rejoindre pour améliorer la distribution. Voir Contribuer, pour plus d’info.
Suivant: Installation depuis une clef USB ou un DVD, Précédent: Limitations, Monter: Installation du système [Table des matières][Index]
GNU Guix se concentre sur le respect des libertés de ses utilisateurs et utilisatrices. Il est construit autour du noyau Linux-libre, ce qui signifie que seuls les matériels pour lesquels des pilotes logiciels et des microgiciels libres sont disponibles sont pris en charge. De nos jours, une grande gamme de matériel qu’on peut acheter est prise en charge par GNU/Linux-libre — des claviers aux cartes graphiques en passant par les scanners et les contrôleurs Ethernet. Malheureusement, il reste des produits dont les fabricants refusent de laisser le contrôle aux utilisateur·rice·s sur leur propre utilisation de l’ordinateur, et ces matériels ne sont pas pris en charge par Guix System.
L’un des types de matériels où les pilotes ou les microgiciels sont le moins
disponibles sont les appareils WiFi. Les appareils WiFi connus pour
fonctionner sont ceux qui utilisent des puces Atheros (AR9271 et AR7010) qui
correspondent au pilote ath9k
de Linux-libre, et ceux qui utilisent
des puces Broadcom/AirForce (BCM43xx avec la révision Wireless-Core 5), qui
correspondent au pilote b43-open
de Linux-libre. Des microgiciels
libres existent pour les deux et sont disponibles directement sur Guix
System, dans %base-firmware (voir firmware
).
L’installateur vous averti rapidement s’il détecte des périphériques connus pour ne pas marcher à cause du manque de micrologiciel ou de pilote libre.
La Free Software Foundation a un programme de certification nommé Respects Your Freedom (RYF), pour les produits matériels qui respectent votre liberté et votre vie privée en s’assurant que vous avez le contrôle sur l’appareil. Nous vous encourageons à vérifier la liste des appareils certifiés par RYF.
Une autre ressource utile est le site web H-Node. Il contient un catalogue d’appareils avec des informations sur leur support dans GNU/Linux.
Suivant: Préparer l’installation, Précédent: Considérations matérielles, Monter: Installation du système [Table des matières][Index]
Une image d’installation ISO-9660 qui peut être écrite sur une clé USB ou
être gravée sur un DVD est téléchargeable à partir de
‘https://ftp.gnu.org/gnu/guix/guix-system-install-f977cb2.x86_64-linux.iso
’,
où vous pouvez remplacer x86_64-linux
par l’un des éléments suivants
:
x86_64-linux
pour un système GNU/Linux sur un CPU compatible Intel/AMD 64-bits ;
i686-linux
pour un système GNU/Linux sur un CPU compatible Intel 32-bits.
Assurez-vous de télécharger les fichiers .sig associés et de vérifier l’authenticité de l’image avec, de cette manière :
$ wget https://ftp.gnu.org/gnu/guix/guix-system-install-f977cb2.x86_64-linux.iso.sig $ gpg --verify guix-system-install-f977cb2.x86_64-linux.iso.sig
Si cette commande échoue parce que vous n’avez pas la clef publique requise, lancez cette commande pour l’importer :
$ wget https://sv.gnu.org/people/viewgpg.php?user_id=15145 \ -qO - | gpg --import -
et relancez la commande gpg --verify
.
Remarquez qu’un avertissement du type « Cette clef n’est pas certifiée par une signature de confiance ! » est normal.
Cette image contient les outils nécessaires à l’installation. Elle est faite pour être copiée telle quelle sur une clef USB assez grosse ou un DVD.
Insérez la clef USB de 1 Gio ou plus dans votre machine et déterminez son nom d’appareil. En supposant que la clef usb est connue sous le nom de /dev/sdX, copiez l’image avec :
dd if=guix-system-install-f977cb2.x86_64-linux.iso of=/dev/sdX status=progress sync
Accéder à /dev/sdX requiert généralement les privilèges d’administration.
Insérez un DVD vierge dans votre machine et déterminez son nom d’appareil. En supposant que le DVD soit connu sont le nom de /dev/srX, copiez l’image avec :
growisofs -dvd-compat -Z /dev/srX=guix-system-install-f977cb2.x86_64-linux.iso
Accéder à /dev/srX requiert généralement les privilèges root.
Une fois que c’est fait, vous devriez pouvoir redémarrer le système et
démarrer depuis la clé USB ou le DVD. Pour cela, vous devrez généralement
entrer dans le menu de démarrage BIOS ou UEFI, où vous pourrez choisir de
démarrer sur la clé USB. Pour démarrer depuis Libreboot, passez en mode de
commande en appuyant sur la touche c et en tapant search grub
usb
.
Sadly, on some machines, the installation medium cannot be properly booted and you only see a black screen after booting even after you waited for ten minutes. This may indicate that your machine cannot run Guix System; perhaps you instead want to install Guix on a foreign distro (voir Installation binaire). But don’t give up just yet; a possible workaround is pressing the e key in the GRUB boot menu and appending nomodeset to the Linux bootline. Sometimes the black screen issue can also be resolved by connecting a different display.
Voir Installer Guix sur une machine virtuelle, si, à la place, vous souhaitez installer Guix System dans une machine virtuelle (VM).
Suivant: Installation graphique guidée, Précédent: Installation depuis une clef USB ou un DVD, Monter: Installation du système [Table des matières][Index]
Une fois que vous avez démarré, vous pouvez utiliser l’installateur graphique, qui rend facile la prise en main (voir Installation graphique guidée). Sinon, si vous êtes déjà familier avec GNU/Linux et que vous voulez plus de contrôle que ce que l’installateur graphique propose, vous pouvez choisir le processus d’installation « manuel » (voir Installation manuelle).
L’installateur graphique est disponible sur le TTY1. Vous pouvez obtenir des shells root sur les TTY 3 à 6 en tapant ctrl-alt-f3, ctrl-alt-f4 etc. Le TTY2 affiche cette documentation que vous pouvez atteindre avec ctrl-alt-f2. On peut naviguer dans la documentation avec les commandes du lecteur Info (voir Stand-alone GNU Info). Le démon de souris GPM tourne sur le système d’installation, ce qui vous permet de sélectionner du texte avec le bouton gauche de la souris et de le coller en appuyant sur la molette.
Remarque : L’installation nécessite un accès au réseau pour que les dépendances manquantes de votre configuration système puissent être téléchargées. Voyez la section « réseau » plus bas.
Suivant: Installation manuelle, Précédent: Préparer l’installation, Monter: Installation du système [Table des matières][Index]
L’installateur graphique est une interface utilisateur en mode texte. Il vous guidera, avec des boîtes de dialogue, le long des étapes requises pour installer GNU Guix System.
La première boîte de dialogue vous permet de paramétrer le système comme vous le souhaitez pendant l’installation : vous pouvez choisir la langue, la disposition du clavier et paramétrer le réseau, qui sera utilisé pendant l’installation. L’image ci-dessous montre le dialogue pour le réseau.
Les étapes suivantes vous permettent de partitionner votre disque dur, comme le montre l’image ci-dessous, de choisir si vous voulez ou non utiliser des systèmes de fichiers chiffrés, de saisir le nom d’hôte et le mot de passe root et de créer un compte supplémentaire, entre autres choses.
Remarquez que, à tout moment, l’installateur vous permet de sortir de l’étape d’installation actuelle et de recommencer une étape précédente, comme le montre l’image ci-dessous.
Une fois que vous avez fini, l’installateur produit une configuration de système d’exploitation et vous la montre (voir Utiliser le système de configuration). À ce moment, vous pouvez appuyer sur « OK » et l’installation continuera. Lorsqu’elle aura réussi, vous pourrez redémarrer sur le nouveau système et vous amuser. Voir Après l’installation du système, pour la suite des festivités !
Suivant: Après l’installation du système, Précédent: Installation graphique guidée, Monter: Installation du système [Table des matières][Index]
Cette section décrit comme vous pourriez installe « manuellement » GNU Guix System sur votre machine. Cette option nécessite que vous soyez familier avec GNU/Linux, le shell et avec les outils d’administration usuels. Si vous pensez que ce n’est pas pour vous, pensez à utiliser l’installateur graphique (voir Installation graphique guidée).
Le système d’installation fournit des shells root sur les TTY 3 à 6 ;
appuyez sur ctrl-alt-f3, ctrl-alt-f4 etc pour y accéder. Il
inclus plusieurs outils usuels pour requis pour cette tâche. Mais c’est
aussi un système Guix complet. Cela signifie que vous pouvez installer des
paquets supplémentaires si vous en avez besoin, avec guix package
(voir Invoquer guix package
).
Suivant: Effectuer l’installation, Monter: Installation manuelle [Table des matières][Index]
Avant que vous ne puissiez installer le système, vous voudrez sans doute ajuster la disposition du clavier, paramétrer le réseau et partitionner le disque dur cible. Cette section vous guidera à travers tout cela.
L’image d’installation utilise la disposition clavier qwerty (US). Si vous
voulez la changer, vous pouvez utiliser la commande loadkeys
. Par
exemple, la commande suivante sélectionne la disposition Dvorak :
loadkeys dvorak
Consultez les fichiers dans /run/current-system/profile/share/keymaps
pour trouver une liste des dispositions disponibles. Lancez man
loadkey
pour plus d’informations.
Lancez la commande suivante pour voir comment vos interfaces réseau sont appelées :
ifconfig -a
… ou, avec la commande spécifique à GNU/Linux ip
:
ip address
Les interfaces filaires ont un nom qui commence par ‘e’ ; par exemple, l’interface qui correspond au premier contrôleur Ethernet sur la carte mère est appelé ‘eno1’. Les interfaces sans-fil ont un nom qui commence par ‘w’, comme ‘w1p2s0’.
Pour configure une connexion filaire, lancez la commande suivante, en remplaçant interface par le nom de l’interface filaire que vous voulez utiliser.
ifconfig interface up
… ou, avec la commande spécifique à GNU/Linux ip
:
ip link set interface up
Pour configurer le réseau sans-fil, vous pouvez créer un fichier de
configuration pour l’outil de configuration wpa_supplicant
(son
emplacement importe peu) avec l’un des éditeurs de texte disponibles comme
nano
:
nano wpa_supplicant.conf
Par exemple, la déclaration qui suit peut aller dans ce fichier et fonctionnera pour plusieurs réseaux sans-fil, si vous donnez le vrai SSID et la phrase de passe pour le réseau auquel vous vous connectez :
network={ ssid="mon-ssid" key_mgmt=WPA-PSK psk="la phrase de passe secrète du réseau" }
Démarrez le service sans-fil et lancez-le en tâche de fond avec la commande suivante (en remplaçant interface par le nom de l’interface réseau que vous voulez utiliser) :
wpa_supplicant -c wpa_supplicant.conf -i interface -B
Lancez man wpa_supplicant
pour plus d’informations.
À partir de ce moment, vous avez besoin d’une adresse IP. Sur les réseaux où les IP sont automatiquement attribuée par DHCP, vous pouvez lancer :
dhclient -v interface
Essayez de pinger un serveur pour voir si le réseau fonctionne :
ping -c 3 gnu.org
Mettre en place un accès réseau est presque toujours une nécessité parce que l’image ne contient pas tous les logiciels et les outils dont vous pourriez avoir besoin.
Si vous avez besoin d’un accès HTTP et HTTPS pour passer à travers un proxy, lancez la commande suivante :
herd set-http-proxy guix-daemon URL
où URL est l’URL du proxy, par exemple http://example.org:8118
.
Si vous le souhaitez, vous pouvez continuer l’installation à distance en démarrant un serveur SSH :
herd start ssh-daemon
Assurez-vous soit de définir un mot de passe avec passwd
, soit de
configurer l’authentification par clef OpenSSH avant de vous connecter.
À moins que vous ne l’ayez déjà fait, l’étape suivante consiste à partitionner le disque puis à formater les partitions cibles.
L’image d’installation inclus plusieurs outils de partitionnement, dont
Parted (voir Overview dans GNU Parted User Manual),
fdisk
, et cfdisk
. Lancez-en un et paramétrez votre
disque avec le partitionnement qui vous convient :
cfdisk
Si votre disque utilise le format des tables de partitions GUID (GPT) et que vous souhaitez installer un GRUB pour système BIOS (c’est le cas par défaut), assurez-vous de créer qu’une partition de démarrage BIOS soit bien disponible (voir BIOS installation dans GNU GRUB manual).
Si vous souhaitez à la place utilise GRUB pour système EFI, vous devrez
avoir une partition système EFI (ESP) en FAT32. Cette partition peut
être montée dans /boot/efi par exemple et doit avoir le drapeau
esp
. P. ex. pour parted
:
parted /dev/sda set 1 esp on
Remarque : Vous n’êtes pas sûr de savoir si vous devez utiliser un GRUB EFI ou BIOS ? Si le répertoire /sys/firmware/efi existe sur l’image d’installation, vous devriez probablement effectuer une installation EFI, avec
grub-efi-bootloader
. Sinon, vous devriez utiliser le GRUB en BIOS,grub-bootloader
. Voir Configuration du chargeur d’amorçage pour plus d’information sur le chargeur d’amorçage.
Une fois que vous avez fini le partitionnement du disque dur cible, vous devez créer un système de fichier sur les partitions10. Pour l’ESP, si vous en avez une et en supposant que ce soit /dev/sda1, lancez :
mkfs.fat -F32 /dev/sda1
Concernant le système de fichier root, ext4 est le format le plus largement utilisé. D’autres systèmes de fichiers, comme Btrfs, supportent la compression, laquelle est reportée pour compléter agréablement la dédupplication que le démon réalise indépendamment du système de fichier (voir deduplication).
Préférez assigner une étiquette au système de fichier pour que vous puissiez
vous y référer de manière fiable dans la déclaration file-system
(voir Systèmes de fichiers). On le fait habituellement avec l’option -L
de mkfs.ext4
et des commandes liées. Donc, en supposant que la
partition racine soit sur /dev/sda2, on peut créer un système de
fichier avec pour étiquette my-root
avec :
mkfs.ext4 -L my-root /dev/sda2
Si vous voulez plutôt chiffrer la partition root, vous pouvez utiliser les
utilitaires Cryptsetup et LUKS pour cela (voir man cryptsetup
pour plus d’informations).
Assuming you want to store the root partition on /dev/sda2, the command sequence to format it as a LUKS partition would be along these lines:
cryptsetup luksFormat /dev/sda2 cryptsetup open /dev/sda2 my-partition mkfs.ext4 -L my-root /dev/mapper/my-partition
Une fois cela effectué, montez le système de fichier cible dans /mnt
avec une commande comme (de nouveau, en supposant que my-root
est
l’étiquette du système de fichiers racine) :
mount LABEL=my-root /mnt
Montez aussi tous les systèmes de fichiers que vous voudriez utiliser sur le
système cible relativement à ce chemin. Si vous avez choisi d’avoir un
/boot/efi comme point de montage EFI par exemple, montez-la sur
/mnt/boot/efi maintenant pour qu’elle puisse être trouvée par
guix system init
ensuite.
Enfin, si vous souhaitez utiliser une ou plusieurs partitions de swap
(voir Espace d’échange), assurez-vous de les initialiser avec
mkswap
. En supposant que vous avez une partition de swap sur
/dev/sda3, vous pouvez lancer :
mkswap /dev/sda3 swapon /dev/sda3
Autrement, vous pouvez utiliser un fichier de swap. Par exemple, en supposant que dans le nouveau système vous voulez utiliser le fichier /swapfile comme fichier de swap, vous lanceriez11 :
# Cela représente 10 Gio d'espace d'échange. Ajustez « count » pour changer la taille. dd if=/dev/zero of=/mnt/swapfile bs=1MiB count=10240 # Par sécurité, laissez le fichier en lecture et en écriture uniquement pour root. chmod 600 /mnt/swapfile mkswap /mnt/swapfile swapon /mnt/swapfile
Remarquez que si vous avez chiffré la partition racine et créé un fichier d’échange dans son système de fichier comme décrit ci-dessus, alors le chiffrement protégera aussi le fichier d’échange, comme n’importe quel fichier de ce système de fichiers.
Précédent: Disposition du clavier réseau et partitionnement, Monter: Installation manuelle [Table des matières][Index]
Lorsque la partition cible est prête et que les autres partitions sont montées, on est prêt à commencer l’installation. Commencez par :
herd start cow-store /mnt
Cela rend /gnu/store capable de faire de la copie sur écriture, de
sorte que les paquets ajoutés pendant l’installation sont écrits sur le
disque cible sur /mnt plutôt que gardés en mémoire. Cela est
nécessaire parce que la première phase de la commande guix system
init
(voir plus bas) implique de télécharger ou de construire des éléments
de /gnu/store qui est initialement un système de fichiers en mémoire.
Ensuite, vous devrez modifier un fichier et fournir la déclaration du
système à installer. Pour cela, le système d’installation propose trois
éditeurs de texte. Nous recommandons GNU nano (voir GNU nano
Manual), qui supporte la coloration syntaxique la correspondance de
parenthèses ; les autres éditeurs sont mg (un clone d’Emacs) et nvi (un
clone de l’éditeur vi
original de BSD). Nous recommandons
vivement de stocker ce fichier sur le système de fichier racine cible,
disons en tant que /mnt/etc/config.scm. Sinon, vous perdrez votre
fichier de configuration une fois que vous aurez redémarré sur votre nouveau
système.
Voir Utiliser le système de configuration, pour un aperçu de comment créer votre fichier de configuration. Les exemples de configuration dont on parle dans cette section sont disponibles dans /etc/configuration sur l’image d’installation. Ainsi, pour commencer avec une configuration du système qui fournit un serveur d’affichage graphique (un système de « bureau »), vous pouvez lancer ce qui suit :
# mkdir /mnt/etc # cp /etc/configuration/desktop.scm /mnt/etc/config.scm # nano /mnt/etc/config.scm
Vous devriez faire attention à ce que contient votre fichier de configuration, en particulier :
bootloader-configuration
se réfère aux
cibles où vous voulez installer GRUB. Elle devrait aussi mentionner
grub-bootloader
si vous installer GRUB en mode BIOS (ou « legacy »)
ou grub-efi-bootloader
pour les système UEFI plus récents. Pour les
anciens systèmes, le champs targets
contient le nom des périphériques
comme (list "/dev/sda")
; pour les systèmes UEFI il contient les
chemins vers les partitions EFI montées, comme (list "/boot/efi")
;
assurez-vous bien que ces chemins sont montés et qu’il y a une entrée
file-system
dans votre configuration.
device
dans votre configuration
file-system
, en supposant que la configuration file-system
utilise la procédure file-system-label
dans son champ device
.
mapped-device
pour les décrire (voir Périphériques mappés).
Une fois que vous avez fini les préparatifs sur le fichier de configuration, le nouveau système peut être initialisé (rappelez-vous que le système de fichiers racine cible est dans /mnt) :
guix system init /mnt/etc/config.scm /mnt
Cela copie tous les fichiers nécessaires et installe GRUB sur
/dev/sdX à moins que vous ne passiez l’option
--no-bootloader. Pour plus d’informations, voir Invoquer guix system
. Cette commande peut engendrer des téléchargements ou des
constructions pour les paquets manquants, ce qui peut prendre du temps.
Une fois que cette commande a terminé — et on l’espère réussi ! — vous
pouvez lancer reboot
et démarrer sur votre nouveau système. Le
mot de passe root
est d’abord vide ; les mots de passe des autres
comptes doivent être initialisés avec la commande passwd
en tant
que root
, à mois que votre configuration ne spécifie autre chose
(voir mot de passe des comptes). Voir Après l’installation du système, pour la suite !
Suivant: Installer Guix sur une machine virtuelle, Précédent: Installation manuelle, Monter: Installation du système [Table des matières][Index]
Success, you’ve now booted into Guix System! You can upgrade the system whenever you want by running:
guix pull sudo guix system reconfigure /etc/config.scm
This builds a new system generation with the latest packages and services.
Maintenant, voir Guide de démarrage, et rejoignez-nous sur
#guix
sur le réseau IRC Libera.Chat ou sur
guix-devel@gnu.org pour partager votre expérience !
Suivant: Construire l’image d’installation, Précédent: Après l’installation du système, Monter: Installation du système [Table des matières][Index]
Si vous souhaitez installer Guix System sur une machine virtuelle (VM) ou un serveur privé virtuel (VPS) plutôt que sur votre machine chérie, cette section est faite pour vous.
Pour démarrer une VM QEMU pour installer Guix System sur une image disque, suivez ces étapes :
qemu-img
:
qemu-img create -f qcow2 guix-system.img 50G
Le fichier qui en résulte sera bien plus petit que les 50 Go (habituellement moins de 1 Mo) mais il grossira au fur et à mesure que le stockage virtuel grossira.
qemu-system-x86_64 -m 1024 -smp 1 -enable-kvm \ -nic user,model=virtio-net-pci -boot menu=on,order=d \ -drive file=guix-system.img \ -drive media=cdrom,readonly=on,file=guix-system-install-f977cb2.system.iso
-enable-kvm
est facultatif, mais améliore nettement les performances,
voir Exécuter Guix sur une machine virtuelle.
Une fois l’installation terminée, vous pouvez démarrer le système dans votre image guix-system.img. Voir Exécuter Guix sur une machine virtuelle, pour une manière de faire.
Précédent: Installer Guix sur une machine virtuelle, Monter: Installation du système [Table des matières][Index]
L’image d’installation décrite plus haut a été construite avec la commande
guix system
, plus précisément :
guix system image -t iso9660 gnu/system/install.scm
Regardez le fichier gnu/system/install.scm dans l’arborescence des
sources et regardez aussi Invoquer guix system
pour plus
d’informations sur l’image d’installation.
De nombreuses cartes ARM requièrent une variante spécifique du chargeur d’amorçage U-Boot.
Si vous construisez une image disque et que le chargeur d’amorçage n’est pas disponible autrement (sur un autre périphérique d’amorçage etc), il est recommandé de construire une image qui inclus le chargeur d’amorçage, plus précisément :
guix system image --system=armhf-linux -e '((@ (gnu system install) os-with-u-boot) (@ (gnu system install) installation-os) "A20-OLinuXino-Lime2")'
A20-OLinuXino-Lime2
est le nom de la carte. Si vous spécifiez une
carte invalide, une liste de cartes possibles sera affichée.
Suivant: Gestion de paquets, Précédent: Installation du système, Monter: GNU Guix [Table des matières][Index]
Vous êtes certainement arrivé·e à cette section parce que vous avez installé Guix sur une autre distribution (voir Installation), ou bien vous avez installé Guix System (voir Installation du système). Il est temps pour vous de commencer à utiliser Guix et cette section est là pour vous aider à le faire et vous donner une idée de ce que c’est.
Guix est, entre autres, un programme d’installation de logiciels, donc la première chose que vous voudrez probablement faire est de chercher un logiciel. Disons que vous cherchez un éditeur de texte, vous pouvez lancer :
guix search text editor
Cette commande vous montre un certain nombre de paquets correspondants, en indiquant à chaque fois le nom du paquet, sa version, une description et des informations supplémentaires. Une fois que vous avez trouvé celui que vous voulez utiliser, disons Emacs (ah ha !), vous pouvez l’installer (lancez cette commande en tant qu’ utilisateur·rice, pas besoin des privilèges d’administration !) :
guix install emacs
Vous avez installé votre premier paquet, félicitations ! Le paquet est maintenant visible dans votre profil par défaut, $HOME/.guix-profile — un profil est un répertoire contenant les paquets installés. Vous avez probablement remarqué que Guix a téléchargé des binaires pré-compilés ; ou bien, si vous vous êtes dit : non, pas de binaires pré-compilés, alors Guix est probablement encore en train de construire un logiciel (voir Substituts, pour plus d’informations).
À moins que vous utilisiez Guix System, la commande guix install
doit avoir affiché cet indice :
conseil : pensez à définir les variables d'environnement nécessaires en exécutant : GUIX_PROFILE="$HOME/.guix-profile" . "$GUIX_PROFILE/etc/profile" Vous pouvez également consulter `guix package --search-paths -p "$HOME/.guix-profile"'.
En effet, vous devez maintenant indiquer à votre shell où se trouvent
emacs
et les autres programmes installés avec Guix. En collant
les deux lignes ci-dessus, c’est exactement ce que vous ferez : vous
ajouterez $HOME/.guix-profile/bin
— qui est l’endroit où se trouve
le paquet installé — à la variable d’environnement PATH
. Vous
pouvez coller ces deux lignes dans votre shell pour qu’elles prennent effet
immédiatement, mais surtout vous devez les ajouter à ~/.bash_profile
(ou un fichier équivalent si vous n’utilisez pas Bash) afin que les
variables d’environnement soient définies la prochaine fois que vous
lancerez un shell. Vous n’avez besoin de le faire qu’une seule fois et les
autres variables d’environnement des chemins de recherche seront traitées de
la même manière — par exemple, si vous installez les bibliothèques
python
et Python, GUIX_PYTHONPATH
sera définie.
Vous pouvez continuer à installer des paquets à votre guise. Pour lister les paquets installés, lancez :
guix package --list-installed
Pour supprimer un paquet, sans surprise, lancez guix remove
. Une
caractéristique distinctive est la possibilité de faire revenir en
arrière toute opération que vous avez effectuée — installation,
suppression, mise à niveau — en tapant simplement :
guix package --roll-back
C’est parce que chaque opération est en fait une transaction qui crée une nouvelle génération. Les générations et leurs différences entre elles peuvent être affichées en lançant :
guix package --list-generations
Vous connaissez maintenant les bases de la gestion des paquets !
Pour aller plus loin : Voir Gestion de paquets, pour en savoir plus sur la gestion des paquets. Vous pouvez aimer la gestion declarative des paquets avec
guix package --manifest
, la gestion de profils séparés avec --profil, la suppression des anciennes générations, le ramasse-miettes et d’autres fonctionnalités astucieuses qui vous seront utiles à mesure que vous vous familiariserez avec Guix. Si vous développez du code, voir Développement pour des outils supplémentaires. Et si vous êtes curieux·euse, voir Fonctionnalités, pour jeter un coup d’œil sous le capot.You can also manage the configuration of your entire home environment—your user “dot files”, services, and packages—using Guix Home. Voir Configuration du dossier personnel, to learn more about it!
Une fois que vous avez installé un ensemble de paquets, vous voudrez périodiquement faire une mise à jour à la dernière version flambant neuve. Pour cela, vous devez d’abord récupérer la dernière révision de Guix et de sa collection de paquets :
guix pull
Le résultat final est une nouvelle commande guix
, sous
~/.config/guix/current/bin. A moins que vous ne soyez sous Guix
System, la première fois que vous lancez guix pull
, assurez-vous
de suivre le conseil que la commande affiche et, comme nous l’avons vu
ci-dessus, collez ces deux lignes dans votre terminal et dans
.bash_profile :
GUIX_PROFILE="$HOME/.config/guix/current" . "$GUIX_PROFILE/etc/profile"
Vous devez aussi informer votre shell de pointer sur ce nouveau
guix
:
hash guix
A ce stade, vous pilotez un Guix tout neuf. Vous pouvez donc aller de l’avant et mettre effectivement à jour tous les paquets que vous avez installés précédemment :
guix upgrade
En exécutant cette commande, vous verrez que des binaires sont téléchargés (ou peut-être que certains paquets sont construits), et vous finirez par obtenir les paquets mis à jour. Si l’un de ces paquets n’est pas à votre goût, n’oubliez pas que vous pouvez toujours revenir en arrière !
Vous pouvez afficher la révision exacte de Guix actuellement en cours d’exécution en lançant :
guix describe
L’information affichée est tout ce qu’il faut pour reproduire exactement le même Guix, que ce soit à un moment différent ou sur une machine différente.
Pour aller plus loin : Voir Invoquer
guix pull
, pour plus d’informations. Voir Canaux, sur la façon de spécifier des canaux supplémentaires pour extraire des paquets, sur la façon de répliquer Guix, et plus encore. Vous pouvez également trouvertime-machine
pratique (voir Invoquerguix time-machine
).
Si vous avez installé Guix System, une des premières choses que vous voudrez
faire est de le mettre à jour. Une fois que vous avez lancé guix
pull
pour obtenir le dernier Guix, vous pouvez mettre à jour le système
comme ceci :
sudo guix system reconfigure /etc/config.scm
Upon completion, the system runs the latest versions of its software packages. Just like for packages, you can always roll back to a previous generation of the whole system. Voir Guide de démarrage, to learn how to manage your system.
Maintenant, vous en savez assez pour commencer !
Ressources : Le reste de ce manuel constitue une référence pour tout ce qui concerne Guix. Voici quelques ressources supplémentaires que vous pourriez trouver utiles :
- Voir The GNU Guix Cookbook, pour une liste de recettes de style "how-to" pour une variété d’applications.
- La GNU Guix Reference Card énumère en deux pages la plupart des commandes et options dont vous aurez besoin.
- Le site web contient des vidéos instructives couvrant des sujets tels que l’utilisation quotidienne de Guix, comment obtenir de l’aide et comment devenir un·e contributeur·rice.
- Voir Documentation, pour savoir comment accéder à la documentation sur votre ordinateur.
Nous espérons que vous apprécierez Guix autant que la communauté a de plaisir à le construire !
Suivant: Canaux, Précédent: Guide de démarrage, Monter: GNU Guix [Table des matières][Index]
Le but de GNU Guix est de permettre à ses utilisatrices et utilisateurs d’installer, mettre à jour et supprimer facilement des paquets logiciels sans devoir connaître leur procédure de construction ou leurs dépendances. Guix va aussi plus loin que ces fonctionnalités évidentes.
Ce chapitre décrit les principales fonctionnalités de Guix, ainsi que des
outils de gestion des paquets qu’il fournit. En plus de l’interface en
ligne de commande décrite en dessous de (voir guix package
), vous pouvez aussi utiliser l’interface Emacs-Guix
(voir Le manuel de référence de emacs-guix), après
avoir installé le paquet emacs-guix
(lancez la commande M-x
guix-help pour le démarrer) :
guix install emacs-guix
guix package
guix locate
guix gc
guix pull
guix time-machine
guix describe
guix archive
Suivant: Invoquer guix package
, Monter: Gestion de paquets [Table des matières][Index]
Ici, nous supposons que vous avez déjà fait vos premiers pas avec Guix voir Guide de démarrage) et que vous voulez avoir un aperçu de ce qui se passe sous le capot.
Lorsque vous utilisez Guix, chaque paquet arrive dans dépôt des
paquets, dans son propre répertoire — quelque chose comme
/gnu/store/xxx-paquet-1.2, où xxx
est une chaîne en base32.
Plutôt que de se rapporter à ces répertoires, les utilisateur·rice·s ont
leur propre profil qui pointe vers les paquets qu’ils ou elles veulent
vraiment utiliser. Ces profils sont stockés dans le répertoire personnel de
chacun·e dans $HOME/.guix-profile
.
Par exemple, alice
installe GCC 4.7.2. Il en résulte que
/home/alice/.guix-profile/bin/gcc pointe vers
/gnu/store/…-gcc-4.7.2/bin/gcc. Maintenant, sur la même
machine, bob
a déjà installé GCC 4.8.0. Le profil de bob
continue simplement de pointer vers
/gnu/store/…-gcc-4.8.0/bin/gcc — c.-à-d. les deux versions de
GCC coexistent surs le même système sans aucune interférence.
La commande guix package
est l’outil central pour gérer les
paquets (voir Invoquer guix package
). Il opère sur les profils de chaque
utilisateur·rice et peut être utilisé avec les privilèges normaux.
La commande fournit les opérations évidentes d’installation, de suppression
et de mise à jour. Chaque invocation est en fait une transaction :
soit l’opération demandée réussit, soit rien ne se passe. Ainsi, si le
processus guix package
est terminé pendant la transaction ou si
une panne de courant arrive pendant la transaction, le profil reste dans son
état précédent et reste utilisable.
In addition, any package transaction may be rolled back. So, if, for example, an upgrade installs a new version of a package that turns out to have a serious bug, users may roll back to the previous instance of their profile, which was known to work well. Similarly, the global system configuration on Guix is subject to transactional upgrades and roll-back (voir Guide de démarrage).
Tout paquet du dépôt des paquets peut être glané. Guix peut
déterminer quels paquets sont toujours référencés par les profils des
utilisateur·rice·s et supprimer ceux qui ne sont de tout évidence plus
référencés (voir Invoquer guix gc
). Les utilisateur·rice·s peuvent
toujours explicitement supprimer les anciennes générations de leur profil
pour que les paquets auxquels elles faisaient référence puissent être
glanés.
Guix prend une approche purement fonctionnelle de la gestion de paquets, telle que décrite dans l’introduction (voir Introduction). Chaque nom de répertoire de paquet dans /gnu/store contient un hash de toutes les entrées qui ont été utilisées pendant la construction de ce paquet — le compilateur, les bibliothèques, les scripts de construction, etc. Cette correspondance directe permet aux utilisateur·rice·s de s’assurer que l’installation d’un paquet donné correspond à l’état actuel de leur distribution. Elle aide aussi à maximiser la reproductibilité : grâce aux environnements de construction utilisés, une construction donnée a de forte chances de donner des fichiers identiques bit-à-bit lorsqu’elle est effectuée sur des machines différentes (voir container).
Ce fondement permet à Guix de supporter le déploiement transparent de
binaire ou source. Lorsqu’une binaire pré-construit pour une entrée de
/gnu/store est disponible depuis une source externe (un
substitut), Guix le télécharge simplement et le décompresse ; sinon,
il construit le paquet depuis les sources localement (voir Substituts).
Comme les résultats des constructions sont généralement reproductibles au
bit près, si vous n’avez pas besoin de faire confiance aux serveurs qui
fournissent les substituts : vous pouvez forcer une construction locale et
défier les fournisseurs (voir Invoquer guix challenge
).
Le contrôle de l’environnement de construction est aussi une fonctionnalité
utile pour les développeurs. La commande guix shell
permet aux
développeurs d’un paquet de mettre en place rapidement le bon environnement
de développement pour leur paquet, sans avoir à installer manuellement les
dépendances du paquet dans leur profil (voir Invoquer guix shell
).
La totalité de Guix et des définitions de paquets sont placés sous contrôle
de version, et guix pull
vous permet de « voyager dans le temps »
de l’historique de Guix lui-même (voir Invoquer guix pull
). Cela est
rend possible la réplication d’une instance Guix sur une machine différente
ou plus tard, ce qui vous permet de répliquer des environnements
logiciels complets, tout en garantissant un suivi de provenance
précis des logiciels.
Suivant: Substituts, Précédent: Fonctionnalités, Monter: Gestion de paquets [Table des matières][Index]
guix package
La commande guix package
est l’outil qui permet d’installer,
mettre à jour et supprimer les paquets ainsi que de revenir à une
configuration précédente. Ces opérations fonctionnent sur un profil
utilisateur—un répertoire avec les paquets installés. Chaque utilisateur
a un profile par défaut dans $HOME/.guix-profile. La commande
n’opère que dans le profil de l’utilisateur·rice et fonctionne avec les
privilèges normaux (voir Fonctionnalités). Sa syntaxe est :
guix package options
options spécifie d’abord les opérations à effectuer pendant la transaction. À la fin, une nouvelle génération du profil est créée mais les générations précédentes du profil restent disponibles si l’utilisateur·rice souhaite y revenir.
Par exemple, pour supprimer lua
et installer guile
et
guile-cairo
en une seule transaction :
guix package -r lua -i guile guile-cairo
Parce que c’est pratique, nous fournissons aussi les alias suivants :
guix search
est un alias de guix package -s
,
guix install
est un alias de guix package -i
,
guix remove
est un alias de guix package -r
,
guix upgrade
est un alias de guix package -u
,
guix search
est un alias de guix package -s
.
Ces alias sont moins expressifs que guix package
et fournissent
moins d’options, donc dans certains cas vous devrez probablement utiliser
guix package
directement.
guix package
supporte aussi une approche déclarative où on
spécifie l’ensemble exact des paquets qui doivent être disponibles que l’on
passe via l’option --manifest (voir --manifest).
Pour chaque utilisateur·rice, un lien symbolique vers son profil par défaut
est automatiquement créé dans $HOME/.guix-profile. Ce lien
symbolique pointe toujours vers la génération actuelle du profil par défaut
du compte. Ainsi, on peut ajouter $HOME/.guix-profile/bin à sa
variable d’environnement PATH
etc.
Si vous n’utilisez pas la distribution système Guix, vous devriez ajouter
les lignes suivantes à votre ~/.bash_profile (voir Bash Startup
Files dans The GNU Bash Reference Manual) pour que les shells créés
ensuite aient tous les bonnes définitions des variables d’environnement :
GUIX_PROFILE="$HOME/.guix-profile" ; \ source "$GUIX_PROFILE/etc/profile"
Dans un environnement multi-utilisateur·rice, les profils des
utilisateur·rice·s sont stockés dans un emplacement enregistré comme
garbage-collector root, vers lequel $HOME/.guix-profile pointe
(voir Invoquer guix gc
). Ce répertoire est normalement
localstatedir/guix/profiles/per-user/user
, où
localstatedir est la valeur passée à configure
comme
--localstatedir, et user est le nom d’utilisateur·rice. Le
répertoire per-user est créé au démarrage de guix-daemon
,
et le sous-répertoire user est créé par guix package
.
Les options peuvent être les suivante :
--install=paquet …
-i paquet …
Installer les paquets spécifiés.
Chaque paquet peut spécifier un simple nom de paquet, tel que
guile
, éventuellement suivi d’un arobase et d’un numéro de version,
tel que guile@3.0.7
ou simplement guile@3.0
. (dans ce
dernier cas, la version la plus récente préfixée par 3.0
est
sélectionnée).
Si aucun numéro de version n’est spécifié, la version la plus récente
disponible est choisie. En plus, une telle spécification de paquet
peut contenir un deux-points, suivi du nom d’une des sorties du paquet,
comme dans gcc:doc
ou binutils@2.22:lib
(voir Des paquets avec plusieurs résultats).
Des paquets avec un nom correspondant (et éventuellement une version) sont recherchés dans les modules de la distribution GNU (voir Modules de paquets).
Autrement, un paquet peut directement spécifier un fichier du dépôt
comme /gnu/store/...-guile-3.0.7, produit par exemple par guix
build
.
Parfois les paquets ont des entrées propagées : ce sont des
dépendances qui sont installées automatiquement avec le paquet demandé
(voir propagated-inputs
in
package
objects pour plus d’informations sur les entrées propagées
dans les définitions des paquets).
Un exemple est la bibliothèque MPC de GNU : ses fichiers d’en-tête C se réfèrent à ceux de la bibliothèque MPFR de GNU, qui se réfèrent en retour à ceux de la bibliothèque GMP. Ainsi, lorsqu’on installe MPC, les bibliothèques MPFR et GMP sont aussi installées dans le profil ; supprimer MPC supprimera aussi MPFR et GMP — à moins qu’ils n’aient été aussi installés explicitement par l’utilisateur·rice.
En outre, les paquets s’appuient parfois sur la définition de variables d’environnement pour leurs chemins de recherche (voir l’explication de l’--chemins de recherche ci-dessous). Toute définition de variable d’environnement manquante ou éventuellement incorrecte est reportée ici.
--install-from-expression=exp
-e exp
Installer le paquet évalué par exp.
exp must be a Scheme expression that evaluates to a <package>
object. This option is notably useful to disambiguate between same-named
variants of a package, with expressions such as (@ (gnu packages
commencement) guile-final)
.
Remarquez que cette option installe la première sortie du paquet, ce qui peut être insuffisant lorsque vous avez besoin d’une sortie spécifique d’un paquet à plusieurs sorties.
--install-from-file=fichier
-f fichier
Installer le paquet évalué par le code dans le fichier.
Par exemple, fichier peut contenir une définition comme celle-ci (voir Définition des paquets) :
(use-modules (guix) (guix build-system gnu) (guix licenses)) (package (name "hello") (version "2.10") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) (build-system gnu-build-system) (synopsis "Hello, GNU world: An example GNU package") (description "Guess what GNU Hello prints!") (home-page "http://www.gnu.org/software/hello/") (license gpl3+))
Lorsqu’on développe, on peut trouver utile d’inclure un tel fichier
guix.scm à la racine de l’arborescence des sources de son projet qui
pourrait être utilisé pour tester des versions de développement et créer des
environnements de développement reproductibles (voir Invoquer guix shell
).
Le fichier peut aussi contenir une représentation JSON d’une ou de
plusieurs définitions de paquets. L’exécution de guix package -f
sur
hello.json avec le contenu suivant entraînerait l’installation du
paquet greeter
après la construction de myhello
:
[ { "name": "myhello", "version": "2.10", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "tests?": false }, "home-page": "https://www.gnu.org/software/hello/", "synopsis": "Hello, GNU world: An example GNU package", "description": "GNU Hello prints a greeting.", "license": "GPL-3.0+", "native-inputs": ["gettext"] }, { "name": "greeter", "version": "1.0", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "test-target": "foo", "parallel-build?": false }, "home-page": "https://example.com/", "synopsis": "Greeter using GNU Hello", "description": "This is a wrapper around GNU Hello.", "license": "GPL-3.0+", "inputs": ["myhello", "hello"] } ]
--remove=paquet …
-r paquet …
Supprimer les paquets spécifiés.
Comme pour --install, chaque paquet peut spécifier un numéro
de version ou un nom de sortie en plus du nom du paquet. Par exemple,
‘-r glibc:debug’ supprimerait la sortie debug
de glibc
.
--upgrade[=regexp …]
¶-u [regexp …]
Mettre à jour tous les paquets installés. Si un ou plusieurs regexp sont spécifiés, la mise à jour n’installera que les paquets dont le nom correspond à regexp. Voir aussi l’option --do-not-upgrade ci-dessous.
Remarquez que cela met à jour vers la dernière version des paquets trouvée
dans la distribution actuellement installée. Pour mettre à jour votre
distribution, vous devriez lancer régulièrement guix pull
(voir Invoquer guix pull
).
Quand une mise à jour est en cours d’exécution, les transformations de paquets initialement appliquées lors de la création du profil sont automatiquement réappliquées (voir Options de transformation de paquets). Par exemple, supposons que vous ayez d’abord installé Emacs depuis l’extrémité de sa branche de développement avec :
guix install emacs-next --with-branch=emacs-next=master
La prochaine fois que vous lancerez guix upgrade
, Guix va à
nouveau extraire l’extrémité de la branche de développement Emacs et
construira emacs-next
à partir de ce checkout.
Notez que les options de transformation comme --with-branch et --with-source dépendent de l’état exterieur ; c’est à vous de vous assurer qu’elles fonctionnent comme souhaité. Vous pouvez également écarter une transformation qui s’applique à un paquet en lançant :
$ guix install paquet
--do-not-upgrade[=regexp …]
Lors d’une utilisation conjointe avec l’option --upgrade, ne pas mettre à jour les paquets dont le nom correspond à regexp. Par exemple, pour mettre à jour tous les paquets du profil actuel à l’exception de ceux qui contiennent la chaîne « emacs » :
$ guix package --upgrade . --do-not-upgrade emacs
--manifest=fichier
¶-m fichier
Créer une nouvelle génération du profil depuis l’objet manifeste renvoyé par le code Scheme dans fichier. Cette option peut être répétée plusieurs fois, auquel cas les manifestes sont concaténés.
Cela vous permet de déclarer le contenu du profil plutôt que de le construire avec une série de --install et de commandes similaires. L’avantage étant que le fichier peut être placé sous contrôle de version, copié vers d’autres machines pour reproduire le même profil, etc.
fichier doit renvoyer un objet manifest qui est en gros une liste de paquets :
(use-package-modules guile emacs) (packages->manifest (list emacs guile-2.0 ;; Utiliser une sortie spécifique d'un paquet. (list guile-2.0 "debug")))
Voir Écrire un manifeste, pour des informations sur la manière d’écrire un manifeste. Voir --export-manifest, pour apprendre à obtenir un fichier manifeste depuis un profil existant.
--roll-back
¶Revenir à la génération précédente du profil c.-à-d. défaire la dernière transaction.
Lorsqu’elle est combinée avec des options comme --install, Le retour en arrière se produit avant toute autre action.
Lorsque vous revenez de la première génération qui contient des fichiers, le profil pointera vers la zéroième génération qui ne contient aucun fichier en dehors de ses propres métadonnées.
Après être revenu en arrière, l’installation, la suppression et la mise à jour de paquets réécrit les futures générations précédentes. Ainsi, l’historique des générations dans un profil est toujours linéaire.
--switch-generation=motif
¶-S motif
Basculer vers une génération particulière définie par le motif.
Le motif peut être soit un numéro de génération soit un nombre précédé de « + » ou « - ». Ce dernier signifie : se déplacer en avant ou en arrière d’un nombre donné de générations. Par exemple, si vous voulez retourner à la dernière génération après --roll-back, utilisez --switch-generation=+1.
La différence entre --roll-back et --switch-generation=-1 est que --switch-generation ne vous amènera pas à la génération initiale, donc si la génération demandée n’existe pas la génération actuelle ne changera pas.
--search-paths[=genre]
¶Rapporter les définitions des variables d’environnement dans la syntaxe Bash qui peuvent être requises pour utiliser l’ensemble des paquets installés. Ces variables d’environnement sont utilisées pour spécifier les chemins de recherche de fichiers utilisés par les paquets installés.
Par exemple, GCC a besoin des variables d’environnement CPATH
et
LIBRARY_PATH
pour trouver les en-têtes et les bibliothèques dans le
profil de l’utilisateur·rice (voir Environment Variables dans Using the
GNU Compiler Collection (GCC)). Si GCC et, disons, la bibliothèque C sont
installés dans le profil, alors --search-paths suggérera
d’initialiser ces variables à profil/include et
profil/lib, respectivement (voir Chemins de recherche, pour des
infos sur les spécifications de chemins de recherche associées aux paquets).
Le cas d’utilisation typique est de définir ces variables d’environnement dans le shell :
$ eval $(guix package --search-paths)
genre peut être l’une des valeurs exact
, prefix
ou
suffix
, ce qui signifie que les définitions des variables
d’environnement renvoyées seront soit les paramètres exacts, soit placés
avant ou après la valeur actuelle de ces paramètres. Lorsqu’il est omis,
genre a pour valeur par défaut exact
.
Cette option peut aussi être utilisé pour calculer les chemins de recherche combinés de plusieurs profils. Regardez cet exemple :
$ guix package -p toto -i guile $ guix package -p titi -i guile-json $ guix package -p toto -p titi --search-paths
La dernière commande ci-dessus montre la variable GUILE_LOAD_PATH
bien
que, pris individuellement, ni toto ni titi n’auraient donné
cette recommandation.
--profile=profil
-p profil
Utiliser le profil à la place du profil par défaut du compte.
profil doit être le nom d’un fichier qui sera créé une fois terminé. Concrètement, profil sera un simple lien symbolique (« symlink ») pointant vers le profil réel où les paquets sont installés :
$ guix install hello -p ~/code/my-profile … $ ~/code/my-profile/bin/hello Hello, world!
Tout ce qu’il faut pour se débarrasser du profil est de supprimer ce lien symbolique et ses frères et sœurs qui pointent vers des générations spécifiques :
$ rm ~/code/my-profile ~/code/my-profile-*-link
--list-profiles
Liste tous les profils utilisateur·rice :
$ guix package --list-profiles /home/charlie/.guix-profile /home/charlie/code/my-profile /home/charlie/code/devel-profile /home/charlie/tmp/test
En cours d’exécution sous root, liste tous les profils de tou·te·s les utilisateur·rice·s.
--allow-collisions
Permettre des collisions de paquets dans le nouveau profil. À utiliser à vos risques et périls !
Par défaut, guix package
rapporte les collisions dans le
profil comme des erreurs. Les collisions ont lieu quand deux version ou
variantes d’un paquet donné se retrouvent dans le profil.
--bootstrap
Utiliser le programme d’amorçage Guile pour compiler le profil. Cette option n’est utile qu’aux personnes qui développent la distribution.
En plus de ces actions, guix package
supporte les options
suivantes pour demander l’état actuel d’un profil ou la disponibilité des
paquets :
Lister les paquets disponibles dont le nom, le synopsis ou la description
correspondent à la regexp (en étant insensible à la casse), triés par
pertinence. Afficher toutes les métadonnées des paquets correspondants au
format recutils
(voir GNU recutils databases dans GNU
recutils manual).
Cela permet à des champs spécifiques d’être extraits avec la commande
recsel
, par exemple :
$ guix package -s malloc | recsel -p name,version,relevance name: jemalloc version: 4.5.0 relevance: 6 name: glibc version: 2.25 relevance: 1 name: libgc version: 7.6.0 relevance: 1
De manière similaire, pour montrer le nom de tous les paquets disponibles sous license GNU LGPL version 3 :
$ guix package -s "" | recsel -p name -e 'license ~ "LGPL 3"' name: elfutils name: gmp …
Il est aussi possible de raffiner les résultats de la recherche en donnant
plusieurs options -s
à guix package
, ou plusieurs arguments
à guix search
. Par exemple, la commande suivante renvoie la liste
des jeux de plateau (cette fois-ci avec l’alias guix search
) :
$ guix search '\<board\>' game | recsel -p name name: gnubg …
Si on avait oublié -s game
, on aurait aussi eu les paquets logiciels
qui s’occupent de circuits imprimés (en anglais : circuit board) ; supprimer
les chevrons autour de board
aurait aussi ajouté les paquets qui
parlent de clavier (en anglais : keyboard).
Et maintenant un exemple plus élaboré. La commande suivante recherche les bibliothèques cryptographiques, retire les bibliothèques Haskell, Perl, Python et Ruby et affiche le nom et le synopsis des paquets correspondants :
$ guix search crypto library | \ recsel -e '! (name ~ "^(ghc|perl|python|ruby)")' -p name,synopsis
Voir Selection Expressions dans GNU recutils manual pour plus
d’information sur les expressions de sélection pour recsel -e
.
Afficher les détails du paquet dans la liste des paquets disponibles,
au format recutils
(voir GNU recutils databases dans GNU recutils manual).
$ guix package --show=guile | recsel -p name,version name: guile version: 3.0.5 name: guile version: 3.0.2 name: guile version: 2.2.7 …
Vous pouvez aussi spécifier le nom complet d’un paquet pour n’avoir que les
détails concernant une version spécifique (cette fois-ci avec l’alias
guix show
) :
$ guix show guile@3.0.5 | recsel -p name,version name: guile version: 3.0.5
Liste les paquets actuellement installés dans le profil spécifié, avec les paquets les plus récemment installés en dernier. Lorsque regexp est spécifié, liste uniquement les paquets installés dont le nom correspond à regexp.
Pour chaque paquet installé, affiche les éléments suivants, séparés par des
tabulations : le nom du paquet, sa version, la partie du paquet qui est
installé (par exemple, out
pour la sortie par défaut, include
pour ses en-têtes, etc) et le chemin du paquet dans le dépôt.
Lister les paquets actuellement disponibles dans la distribution pour ce système (voir Distribution GNU). Lorsque regexp est spécifié, lister uniquement les paquets dont le nom correspond à regexp.
Pour chaque paquet, affiche les éléments suivants séparés par des tabulations : son nom, sa version, les parties du paquet (voir Des paquets avec plusieurs résultats), et l’emplacement de sa définition.
Renvoyer la liste des générations avec leur date de création ; pour chaque génération, montre les paquets installés avec les paquets installés les plus récemment en dernier. Remarquez que la zéroième génération n’est jamais montrée.
Pour chaque paquet installé, afficher les éléments suivants, séparés par des tabulations : le nom du paquet, sa version, la partie du paquet qui a été installée (voir Des paquets avec plusieurs résultats), et l’emplacement du paquet dans le dépôt.
Lorsque motif est utilisé, la commande ne renvoie que les générations correspondantes. Les motifs valides sont :
Et --list-generations=1,8,2 renvoie les trois générations dans l’ordre spécifié. Aucun espace ni virgule surnuméraire ne sont permis.
Il est aussi possible d’omettre le numéro final. Par exemple, --list-generations=2.. renvoie toutes les générations à partir de la deuxième.
Lorsque motif est omis, supprimer toutes les générations en dehors de l’actuelle.
Cette commande accepte les même motifs que --list-generations. Lorsque motif est spécifié, supprime les générations correspondantes. Lorsque motif spécifie une durée, les générations plus anciennes que la durée spécifiée correspondent. Par exemple --delete-generations=1m supprime les générations vieilles de plus d’un mois.
Si la génération actuelle correspond, elle n’est pas supprimée. La zéroième génération n’est elle non plus jamais supprimée.
Remarquez que supprimer des générations empêche de revenir en arrière vers elles. Ainsi, cette commande doit être utilisée avec précaution.
Écrire un manifeste vers la sortie standard utilisable avec --manifest et qui correspond à un ou plusieurs profils choisis.
Cette option est conçue pour vous aider à migre du mode de fonctionnement «
impératif » — lancer guix install
, guix upgrade
, etc
— au mode déclaratif offert par --manifest.
Soyez conscient que le manifeste qui est résulte est une approximation de ce que votre profil contient vraiment ; par exemple, en fonction de la manière dont votre profil a été créé, il peut se référer à des paquets ou des versions de paquets qui ne sont pas exactement ce que vous avez spécifié.
Gardez en tête qu’un manifeste est purement symbolique : il ne contient que des noms de paquets et éventuellement des versions, et leur signification varie avec le temps. Si vous voulez « épingler » des canaux aux révisions qui ont été utilisées pour construire les profils, voir --export-channels plus bas.
Écrit sur la sortie standard la liste des canaux utilisés par les profils
choisi, dans un format convenable pour guix pull --channels
ou
guix time-machine --channels
(voir Canaux).
Avec --export-manifest, cette option fournit les informations qui vous permettent de répliquer le profil actuel (voir Répliquer Guix).
Cependant, remarquez que la sortie de cette commande est une approximation de ce qui a vraiment été utilisé pour construire le profil. En particulier, a profil unique peut avoir été construit à partir de plusieurs révisions du même canal. Dans ce cas, --export-manifest choisi la dernière et écrit la liste des autres révisions dans un commentaire. Si vous avez vraiment besoin de choisir des paquets à partir d’autres révisions des canaux, vous pouvez utiliser des inférieurs dans votre manifeste pour cela (voir Inférieurs).
Avec --export-manifest, c’est un bon point de départ si vous voulez migrer du modèle « impératif » au modèle complètement déclaratif qui consiste en un fichier manifeste et un fichier de canaux qui épingle les révisions exactes des canaux que vous voulez.
Enfin, comme guix package
peut démarrer des processus de
construction, il supporte les options de construction communes
(voir Options de construction communes). Il prend aussi en charge les options de
transformation de paquets comme --with-source, et les préserve à
travers les mises à jour (voir Options de transformation de paquets).
Suivant: Des paquets avec plusieurs résultats, Précédent: Invoquer guix package
, Monter: Gestion de paquets [Table des matières][Index]
Guix gère le déploiement depuis des binaires ou des sources de manière transparente ce qui signifie qu’il peut aussi bien construire localement que télécharger des éléments pré-construits depuis un serveur ou les deux. Nous appelons ces éléments pré-construits des substituts — ils se substituent aux résultats des constructions locales. Dans la plupart des cas, télécharger un substitut est bien plus rapide que de construire les choses localement.
Les substituts peuvent être tout ce qui résulte d’une construction de dérivation (voir Dérivations). Bien sûr dans le cas général, il s’agit de paquets binaires pré-construits, mais les archives des sources par exemple résultent aussi de la construction d’une dérivation qui peut aussi être disponible en tant que substitut.
Suivant: Autoriser un serveur de substituts, Monter: Substituts [Table des matières][Index]
bordeaux.guix.gnu.org
et ci.guix.gnu.org
sont tous deux des interfaces aux fermes de construction officielles qui
construisent des paquets pour Guix continuellement pour certaines
architectures et les rend disponibles en tant que substituts. Ce sont les
sources par défaut des substituts qui peuvent être modifiées en passant
l’option --substitute-urls soit à guix-daemon
(voir guix-daemon --substitute-urls
) soit
aux outils clients comme guix package
(voir client --substitute-urls option).
Les URL des substituts peuvent être soit en HTTP soit en HTTPS. Le HTTPS est recommandé parce que les communications sont chiffrées ; à l’inverse HTTP rend les communications visibles pour un espion qui peut utiliser les informations accumulées sur vous pour déterminer par exemple si votre système a des vulnérabilités de sécurités non corrigées.
Les substituts des fermes de construction officielles sont activés par défaut dans la distribution système Guix (voir Distribution GNU). Cependant, ils sont désactivés par défaut lorsque vous utilisez Guix sur une distribution externe, à moins que vous ne les ayez explicitement activés via l’une des étapes d’installation recommandées (voir Installation). Les paragraphes suivants décrivent comment activer ou désactiver les substituts pour la ferme de construction officielle ; la même procédure peut être utilisée pour activer les substituts de n’importe quel autre serveur de substituts.
Suivant: Récupérer des substituts d’autres serveurs, Précédent: Serveur de substituts officiel, Monter: Substituts [Table des matières][Index]
Pour permettre à Guix de télécharger les substituts depuis
bordeaux.guix.gnu.org
, ci.guix.gnu.org
ou un
miroir, vous devez ajouter la clé publique correspondante à la liste de
contrôle d’accès (ACL) des imports d’archives, avec la commande
guix archive
(voir Invoquer guix archive
). Cela implique que
vous faîtes confiance au serveur de substituts pour ne pas être compromis et
vous servir des substituts authentiques.
Remarque : Si vous utilisez le système Guix, vous pouvez sauter cette section : le système Guix autorise les substituts de
bordeaux.guix.gnu.org
etci.guix.gnu.org
par défaut.
Les clés publiques de chaque serveur de substituts maintenu par le projet
sont installées avec Guix, dans préfixe/share/guix/
, où
préfixe est le préfixe d’installation de Guix. Si vous avez installé
Guix depuis les sources, assurez-vous d’avoir vérifié la signature GPG de
guix-f977cb2.tar.gz qui contient ce fichier de clef
publique. Ensuite vous pouvez lancer quelque chose comme ceci :
# guix archive --authorize < prefix/share/guix/bordeaux.guix.gnu.org.pub # guix archive --authorize < prefix/share/guix/ci.guix.gnu.org.pub
Une fois que cela est en place, la sortie d’une commande comme guix
build
devrait changer de quelque chose comme :
$ guix build emacs --dry-run Les dérivations suivantes seraient construites : /gnu/store/yr7bnx8xwcayd6j95r2clmkdl1qh688w-emacs-24.3.drv /gnu/store/x8qsh1hlhgjx6cwsjyvybnfv2i37z23w-dbus-1.6.4.tar.gz.drv /gnu/store/1ixwp12fl950d15h2cj11c73733jay0z-alsa-lib-1.0.27.1.tar.bz2.drv /gnu/store/nlma1pw0p603fpfiqy7kn4zm105r5dmw-util-linux-2.21.drv …
à quelque chose comme :
$ guix build emacs --dry-run 112.3 Mo seraient téléchargés : /gnu/store/pk3n22lbq6ydamyymqkkz7i69wiwjiwi-emacs-24.3 /gnu/store/2ygn4ncnhrpr61rssa6z0d9x22si0va3-libjpeg-8d /gnu/store/71yz6lgx4dazma9dwn2mcjxaah9w77jq-cairo-1.12.16 /gnu/store/7zdhgp0n1518lvfn8mb96sxqfmvqrl7v-libxrender-0.9.7 …
Le texte a changé de « Les dérivations suivantes seront construites » à « 112,3 Mio seront téléchargés ». Cela indique que les substituts des serveurs configurés sont utilisables et seront téléchargés, si possible, pour les futures constructions.
Le mécanisme de substitution peut être désactivé globalement en lançant
guix-daemon
avec --no-substitutes (voir Invoquer guix-daemon
). Il peut aussi être désactivé temporairement en passant
l’option --no-substitutes à guix package
, guix
build
et aux autres outils en ligne de commande.
Suivant: Authentification des substituts, Précédent: Autoriser un serveur de substituts, Monter: Substituts [Table des matières][Index]
Guix peut chercher et récupérer des substituts à partir de plusieurs serveurs. C’est utile si vous utilisez des paquets de canaux supplémentaires pour lesquels le serveur officiel n’a pas de substituts mais que d’autres serveurs les fournissent. Une autre situation où cela est utile est si vous souhaitez télécharger depuis les serveurs de substituts de votre organisation, en utilisant le serveur officiel en dernier recours, ou en ne l’utilisant pas du tout.
Vous pouvez donner à Guix une liste d’URL de serveurs de substituts et il les vérifiera dans l’ordre indiqué. Vous devez aussi explicitement autoriser les clés publiques des serveurs de substituts pour dire à Guix d’accepter les substituts qu’ils signent.
Sur le système Guix, cela se fait en modifiant la configuration du service
guix
. Comme le service guix
fait partie des services par
défaut, %base-services
et %desktop-services
, vous pouvez
utiliser modify-services
pour changer sa configuration et ajouter les
URL et les clés des serveurs de substituts que vous voulez (voir modify-services
).
Par exemple, supposons que vous vouliez récupérer les substituts de
guix.example.org
et autoriser la clé de signature de ce serveur, en
plus des serveurs bordeaux.guix.gnu.org
et
ci.guix.gnu.org
par défaut. La configuration du système
d’exploitation qui en résulte ressemblera à :
(operating-system
;; …
(services
;; Supposons qu'on commence à partir de '%desktop-services'. Remplaçons-le
;; par la liste des services qu'on utilise vraiment.
(modify-services %desktop-services
(guix-service-type config =>
(guix-configuration
(inherit config)
(substitute-urls
(append (list "https://guix.example.org")
%default-substitute-urls))
(authorized-keys
(append (list (local-file "./key.pub"))
%default-authorized-guix-keys)))))))
Cela suppose que le fichier key.pub contient la clé de signature de
guix.example.org
. Avec ce changement dans le fichier de
configuration de votre système d’exploitation (disons
/etc/config.scm), vous pouvez reconfigurer et redémarrer le service
guix-daemon
ou redémarrer pour que les changements prennent effet :
$ sudo guix system reconfigure /etc/config.scm $ sudo herd restart guix-daemon
Si vous utilisez Guix sur une « distro externe », vous suivrez plutôt les étapes suivantes pour avoir des substituts de serveurs supplémentaires :
guix-daemon
; pour
systemd, c’est normalement /etc/systemd/system/guix-daemon.service.
Ajouter l’option --substitute-urls à la ligne de command
guix-daemon
et listez les URL qui vous intéressent
(voir guix-daemon --substitute-urls
) :
… --substitute-urls='https://guix.example.org https://bordeaux.guix.gnu.org https://ci.guix.gnu.org'
systemctl daemon-reload systemctl restart guix-daemon.service
guix archive
) :
guix archive --authorize < key.pub
De nouveau, cela suppose que key.pub contient la clé publique que
guix.example.org
utilise pour signer les substituts.
Maintenant vous êtes paré ! Les substituts seront téléchargés de préférence
à partir de https://guix.example.org
, avec
bordeaux.guix.gnu.org
puis ci.guix.gnu.org
en réserve. Évidemment vous pouvez lister autant de serveurs de substituts
que vous voulez, avec l’inconvénient que la recherche de substituts sera
ralentie si vous devez contacter trop de serveurs.
Troubleshooting : To diagnose problems, you can run
guix weather
. For example, running:guix weather coreutilsnot only tells you which of the currently-configured servers has substitutes for the
coreutils
package, it also reports whether one of these servers is unauthorized. Voir Invoquerguix weather
, for more information.
Remarquez qu’il à des situations où vous pourriez vouloir ajouter l’URL d’un serveur de substitut sans autoriser sa clé. Voir Authentification des substituts, pour comprendre ce point délicat.
Suivant: Paramètres de serveur mandataire, Précédent: Récupérer des substituts d’autres serveurs, Monter: Substituts [Table des matières][Index]
Guix détecte et lève une erreur lorsqu’il essaye d’utiliser un substitut qui a été modifié. De même, il ignore les substituts qui ne sont pas signés ou qui ne sont pas signés par l’une des clefs listées dans l’ACL.
Il y a une exception cependant : si un serveur non autorisé fournit des substituts qui sont identiques bit-à-bit à ceux fournis par un serveur autorisé, alors le serveur non autorisé devient disponible pour les téléchargements. Par exemple en supposant qu’on a choisi deux serveurs de substituts avec cette option :
--substitute-urls="https://a.example.org https://b.example.org"
Si l’ACL contient uniquement la clef de ‘b.example.org’, et si ‘a.example.org’ sert exactement les mêmes substituts, alors Guix téléchargera les substituts de ‘a.example.org’ parce qu’il vient en premier dans la liste et peut être considéré comme un miroir de ‘b.example.org’. En pratique, les machines de construction indépendantes produisent généralement les mêmes binaires, grâce à des constructions reproductibles au bit près (voir ci-dessous).
Lorsque vous utilisez HTTPS, le certificat X.509 du serveur n’est pas validé (en d’autre termes, le serveur n’est pas authentifié), contrairement à ce que des clients HTTPS comme des navigateurs web font habituellement. Cela est dû au fait que Guix authentifie les informations sur les substituts eux-mêmes, comme expliqué plus haut, ce dont on se soucie réellement (alors que les certificats X.509 authentifient la relation entre nom de domaine et clef publique).
Suivant: Échec de substitution, Précédent: Authentification des substituts, Monter: Substituts [Table des matières][Index]
Les substituts sont téléchargés par HTTP ou HTTPS. Les variables
d’environnement http_proxy
et https_proxy
peuvent être
initialisées dans l’environnement de guix-daemon
et sont prises en
compte pour le téléchargement des substituts. Remarquez que la valeur de
ces variables d’environnement dans l’environnement où sont exécutés
guix build
, guix package
, et d’autres commandes client
n’a absolument aucun effet.
Suivant: De la confiance en des binaires, Précédent: Paramètres de serveur mandataire, Monter: Substituts [Table des matières][Index]
Même lorsqu’un substitut pour une dérivation est disponible, la substitution échoue parfois. Cela peut arriver pour plusieurs raisons : le serveur de substitut peut être hors ligne, le substitut a récemment été supprimé du serveur, la connexion peut avoir été interrompue, etc.
Lorsque les substituts sont activés et qu’un substitut pour une dérivation
est disponible, mais que la tentative de substitution échoue, Guix essaiera
de construire la dérivation localement si --fallback a été passé en
argument (voir common build option --fallback
).
Plus spécifiquement, si cet option n’a pas été passée en argument, alors
aucune construction locale n’est effectuée et la dérivation est considérée
comme étant en échec. Cependant, si --fallback est passé en
argument, alors Guix essaiera de construire la dérivation localement et
l’échec ou le succès de la dérivation dépend de l’échec ou du succès de la
construction locale. Remarquez que lorsque les substituts sont désactivés
ou qu’aucun substitut n’est disponible pour la dérivation en question, une
construction locale sera toujours effectuée, indépendamment du fait
que l’argument --fallback ait été ou non passé.
Pour se donner une idée du nombre de substituts disponibles maintenant, vous
pouvez essayer de lancer la commande guix weather
(voir Invoquer guix weather
). Cette command fournit des statistiques sur les substituts
fournis par un serveur.
Précédent: Échec de substitution, Monter: Substituts [Table des matières][Index]
De nos jours, le contrôle individuel sur son utilisation propre de
l’informatique est à la merci d’institutions, de sociétés et de groupes avec
assez de pouvoir et de détermination pour contourner les infrastructures
informatiques et exploiter leurs faiblesses. Bien qu’utiliser les
substituts soit pratique, nous encourageons chacun·e à construire aussi par
soi-même, voire à faire tourner sa propre ferme de construction, pour que
les serveurs de substituts du projet deviennent une cible moins
intéressante. Une façon d’aider est de publier les logiciels que vous
construisez avec guix publish
pour que les autres aient plus de
choix de serveurs où télécharger les substituts (voir Invoquer guix publish
).
Guix possède les fondations pour maximiser la reproductibilité logicielle
(voir Fonctionnalités). Dans la plupart des cas, des constructions
indépendantes d’un paquet donnée ou d’une dérivation devrait donner des
résultats identiques au bit près. Ainsi, à travers un ensemble de
constructions de paquets indépendantes il est possible de renforcer
l’intégrité du système. La commande guix challenge
a pour but
d’aider les utilisateur·rices à tester les serveurs de substituts et à aider
les développeur·euses à trouver les constructions de paquets
non-déterministes (voir Invoquer guix challenge
). De même, l’option
--check de guix build
permet à chaque personne de
vérifier si les substituts précédemment installés sont authentiques en les
reconstruisant localement (voir guix build
--check
).
À l’avenir, nous aimerions que Guix puisse publier et recevoir des binaires d’autres personnes, de manière pair-à-pair. Si vous voulez discuter de ce projet, rejoignez-nous sur guix-devel@gnu.org.
Suivant: Invoking guix locate
, Précédent: Substituts, Monter: Gestion de paquets [Table des matières][Index]
Souvent, les paquets définis dans Guix ont une seule sortie —
c.-à-d. que le paquet source conduit à exactement un répertoire dans le
dépôt. Lorsque vous lancez guix install glibc
, vous installez la
sortie par défaut du paquet GNU libc ; la sortie par défaut est appelée
out
mais son nom peut être omis comme le montre cette commande. Dans
ce cas particulier, la sortie par défaut de glibc
contient tous les
fichiers d’en-tête C, les bibliothèques partagées, les bibliothèques
statiques, la documentation Info et les autres fichiers de support.
Parfois il est plus approprié de séparer les divers types de fichiers
produits par un même paquet source en plusieurs sorties. Par exemple, la
bibliothèque C GLib (utilisée par GTK+ et des paquets associés) installe
plus de 20 Mo de documentation de référence dans des pages HTML. Pour
préserver l’espace disque des utilisateurs qui n’en ont pas besoin, la
documentation va dans une sortie séparée nommée doc
. Pour installer
la sortie principale de GLib, qui contient tout sauf la documentation, on
devrait lancer :
guix install glib
La commande pour installer la documentation est :
guix install glib:doc
Bien que la syntaxe avec des deux-points fonctionne pour la spécification
des sorties des paquets sur la ligne de commande, cela ne fonctionnera pas
si vous utilisez une variable de paquet dans le code Scheme. Par
exemple, pour ajouter la documentation de glib
aux paquets installés
dans un operating-system
(voir Référence de operating-system
),
vous devez utiliser à la place une liste de deux éléments. Le premier
élément est la variable de paquet. Le second est le nom de la sortie
à sélectionner (une chaine) :
(use-modules (gnu packages glib)) ;; glib-with-documentation est le symbole Guile pour le paquet glib (operating-system ... (packages (append (list (list glib-with-documentation "doc")) %base-packages)))
Certains paquets installent des programmes avec des « empreintes dépendances
» différentes. Par exemple le paquet WordNet installe à la fois les outils
en ligne de commande et les interfaces graphiques (GUI). La première ne
dépend que de la bibliothèque C, alors que cette dernière dépend de Tcl/Tk
et des bibliothèques X sous-jacentes. Dans ce cas, nous laissons les outils
en ligne de commande dans la sortie par défaut et l’interface graphique dans
une sortie séparée. Cela permet aux utilisateurs qui n’ont pas besoin
d’interface graphique de gagner de la place. La commande guix
size
peut aider à trouver ces situations (voir Invoquer guix size
). guix graph
peut aussi être utile (voir Invoque guix graph
).
Il y a plusieurs paquets à sorties multiples dans la distribution GNU.
D’autres noms de sorties conventionnels sont lib
pour les
bibliothèques et éventuellement les fichiers d’en-tête, bin
pour les
programmes indépendants et debug
pour les informations de débogage
(voir Installer les fichiers de débogage). Les sorties d’un paquet sont listés
dans la troisième colonne de la sortie de guix package
--list-available
(voir Invoquer guix package
).
Suivant: Invoquer guix gc
, Précédent: Des paquets avec plusieurs résultats, Monter: Gestion de paquets [Table des matières][Index]
guix locate
There’s so much free software out there that sooner or later, you will need
to search for packages. The guix search
command that we’ve seen
before (voir Invoquer guix package
) lets you search by keywords:
guix search video editor
Sometimes, you instead want to find which package provides a given file, and
this is where guix locate
comes in. Here is how you can find
which package provides the ls
command:
$ guix locate ls coreutils@9.1 /gnu/store/…-coreutils-9.1/bin/ls
Of course the command works for any file, not just commands:
$ guix locate unistr.h icu4c@71.1 /gnu/store/…/include/unicode/unistr.h libunistring@1.0 /gnu/store/…/include/unistr.h
You may also specify glob patterns with wildcards. For example, here is how you would search for packages providing .service files:
$ guix locate -g '*.service' man-db@2.11.1 …/lib/systemd/system/man-db.service wpa-supplicant@2.10 …/system-services/fi.w1.wpa_supplicant1.service
The guix locate
command relies on a database that maps file names
to package names. By default, it automatically creates that database if it
does not exist yet by traversing packages available locally, which
can take a few minutes (depending on the size of your store and the speed of
your storage device).
Remarque : For now,
guix locate
builds its database based on purely local knowledge—meaning that you will not find packages that never reached your store. Eventually it will support downloading a pre-built database so you can potentially find more packages.
By default, guix locate
first tries to look for a system-wide
database, usually under /var/cache/guix/locate; if it does not exist
or is too old, it falls back to the per-user database, by default under
~/.cache/guix/locate. On a multi-user system, administrators may
want to periodically update the system-wide database so that all users can
benefit from it, for instance by setting up
package-database-service-type
(voir package-database-service-type
).
La syntaxe générale est :
guix locate [options…] file…
... where file is the name of a file to search for (specifically, the “base name” of the file: files whose parent directories are called file are not matched).
Les options disponibles sont les suivantes :
--glob
-g
Interpret file… as glob patterns—patterns that may include wildcards, such as ‘*.scm’ to denote all files ending in ‘.scm’.
--stats
Display database statistics.
--update
-u
Update the file database.
By default, the database is automatically updated when it is too old.
--clear
Clear the database and re-populate it.
This option lets you start anew, ensuring old data is removed from the
database, which also avoids having an endlessly growing database. By
default guix locate
automatically does that periodically, though
infrequently.
--database=file
Use file as the database, creating it if necessary.
By default, guix locate
picks the database under
~/.cache/guix or /var/cache/guix, whichever is the most recent
one.
--method=method
-m method
Use method to select the set of packages to index. Possible values are:
manifests
This is the default method: it works by traversing profiles on the machine and recording packages it encounters—packages you or other users of the machine installed, directly or indirectly. It is fast but it can miss other packages available in the store but not referred to by any profile.
dépôt
This is a slower but more exhaustive method: it checks among all the existing packages those that are available in the store and records them.
Suivant: Invoquer guix pull
, Précédent: Invoking guix locate
, Monter: Gestion de paquets [Table des matières][Index]
guix gc
Les paquets qui sont installés mais pas utilisés peuvent être glanés.
La commande guix gc
permet aux utilisateurs de lancer
explicitement le ramasse-miettes pour récupérer de l’espace dans le
répertoire /gnu/store. C’est la seule manière de supprimer
des fichiers de /gnu/store — supprimer des fichiers ou des
répertoires à la main peut le casser de manière impossible à réparer !
Le ramasse-miettes a un ensemble de racines connues : tout fichier
dans /gnu/store atteignable depuis une racine est considéré comme
utilisé et ne peut pas être supprimé ; tous les autres fichiers sont
considérés comme inutilisés et peuvent être supprimés. L’ensemble des
racines du ramasse-miettes (ou « racines du GC » pour faire court) inclue
les profils par défaut des utilisateurs ; par défaut les liens symboliques
sous /var/guix/gcroots représentent ces racines du GC. De nouvelles
racines du GC peuvent être ajoutées avec la guix build -- root
par
exemple (voir Invoquer guix build
). La commande guix gc
--list-roots
permet de les lister.
Avant de lancer guix gc --collect-garbage
pour faire de la place,
c’est souvent utile de supprimer les anciennes génération des profils
utilisateurs ; de cette façon les anciennes constructions de paquets
référencées par ces générations peuvent être glanées. Cela se fait en
lançant guix package --delete-generations
(voir Invoquer guix package
).
Nous recommandons de lancer le ramasse-miettes régulièrement ou lorsque vous avez besoin d’espace disque. Par exemple pour garantir qu’au moins 5 Go d’espace reste libre sur votre disque, lancez simplement :
guix gc -F 5G
Il est parfaitement possible de le lancer comme une tâche périodique
non-interactive (voir Exécution de tâches planifiées pour apprendre comment
paramétrer une telle tâche). Lancer guix gc
sans argument
ramassera autant de miettes que possible mais ça n’est pas le plus pratique
: vous pourriez vous retrouver à reconstruire ou re-télécharger des
logiciels « inutilisés » du point de vu du GC mais qui sont nécessaires pour
construire d’autres logiciels — p. ex. la chaîne de compilation.
La commande guix gc
a trois modes d’opération : elle peut être
utilisée pour glaner des fichiers inutilisés (par défaut), pour supprimer
des fichiers spécifiques (l’option --delete), pour afficher des
informations sur le ramasse-miettes ou pour des requêtes plus avancées. Les
options du ramasse-miettes sont :
--collect-garbage[=min]
-C [min]
Ramasse les miettes — c.-à-d. les fichiers inaccessibles de /gnu/store et ses sous-répertoires. C’est l’opération par défaut lorsqu’aucune option n’est spécifiée.
Lorsque min est donné, s’arrêter une fois que min octets ont été
collectés. min peut être un nombre d’octets ou inclure un suffixe
d’unité, comme MiB
pour mébioctet et GB
pour gigaoctet
(voir size specifications dans GNU Coreutils).
Lorsque min est omis, tout glaner.
--free-space=libre
-F libre
Glaner jusqu’à ce que libre espace soit disponible dans
/gnu/store si possible ; libre est une quantité de stockage
comme 500MiB
comme décrit ci-dessus.
Lorsque libre ou plus est disponible dans /gnu/store ne rien faire et s’arrêter immédiatement.
--delete-generations[=durée]
-d [durée]
Avant de commencer le glanage, supprimer toutes les générations plus vielles que durée, pour tous les profils utilisateurs et générations de l’environnement personnel ; lorsque cela est lancé en root, cela s’applique à tous les profils de tous les utilisateurs.
Par exemple, cette commande supprime toutes les générations de tous vos profils plus vieilles que 2 mois (sauf s’il s’agit de la génération actuelle) puis libère de l’espace jusqu’à atteindre au moins 10 Go d’espace libre :
guix gc -d 2m -F 10G
--delete
-D
Essayer de supprimer tous les fichiers et les répertoires du dépôt spécifiés en argument. Cela échoue si certains des fichiers ne sont pas dans le dépôt ou s’ils sont toujours utilisés.
--list-failures
Lister les éléments du dépôt qui correspondent à des échecs de construction.
Cela n’affiche rien à moins que le démon n’ait été démarré avec --cache-failures (voir --cache-failures).
--list-roots
Lister les racines du GC appartenant à l’utilisateur ; lorsque la commande est lancée en root, lister toutes les racines du GC.
--list-busy
Liste des éléments de stockage utilisés par les processus en cours d’exécution. Ces éléments de stockage sont effectivement considérés comme des racines GC : ils ne peuvent pas être supprimés.
--clear-failures
Supprimer les éléments du dépôt spécifiés du cache des constructions échouées.
De nouveau, cette option ne fait de sens que lorsque le démon est démarré avec --cache-failures. Autrement elle ne fait rien.
--list-dead
Montrer la liste des fichiers et des répertoires inutilisés encore présents dans le dépôt — c.-à-d. les fichiers et les répertoires qui ne sont plus atteignables par aucune racine.
--list-live
Montrer la liste des fichiers et des répertoires du dépôt utilisés.
En plus, les références entre les fichiers existants du dépôt peuvent être demandés :
--references
¶--referrers
Lister les références (respectivement les référents) des fichiers du dépôt en argument.
--requisites
¶-R
Lister les prérequis des fichiers du dépôt passés en argument. Les prérequis sont le fichier du dépôt lui-même, leur références et les références de ces références, récursivement. En d’autre termes, la liste retournée est la closure transitive des fichiers du dépôt.
Voir Invoquer guix size
pour un outil pour surveiller la taille de la
closure d’un élément. Voir Invoque guix graph
pour un outil pour
visualiser le graphe des références.
--derivers
¶Renvoie les dérivations menant aux éléments du dépôt donnés (voir Dérivations).
Par exemple cette commande :
guix gc --derivers $(uix package -I ^emacs$ | cut -f4)
renvoie les fichiers .drv menant au paquet emacs
installé dans
votre profil.
Remarquez qu’il peut n’y avoir aucun fichier .drv par exemple quand ces fichiers ont été glanés. Il peut aussi y avoir plus d’un fichier .drv correspondant à cause de dérivations à sortie fixées.
Enfin, les options suivantes vous permettent de vérifier l’intégrité du dépôt et de contrôler l’utilisation du disque.
Vérifier l’intégrité du dépôt.
Par défaut, s’assurer que tous les éléments du dépôt marqués comme valides dans la base de données du démon existent bien dans /gnu/store.
Lorsqu’elle est fournie, l’option doit être une liste séparée par des
virgule de l’un ou plus parmi contents
et repair
.
Lorsque vous passez --verify=contents, le démon calcul le hash du contenu de chaque élément du dépôt et le compare au hash de sa base de données. Les différences de hash sont rapportées comme des corruptions de données. Comme elle traverse tous les fichiers du dépôt, cette commande peut prendre très longtemps pour terminer, surtout sur un système avec un disque lent.
Utiliser --verify=repair ou --verify=contents,repair fait
que le démon essaie de réparer les objets du dépôt corrompus en récupérant
leurs substituts (voir Substituts). Comme la réparation n’est pas
atomique et donc potentiellement dangereuse, elle n’est disponible que pour
l’administrateur système. Une alternative plus légère lorsque vous
connaissez exactement quelle entrée est corrompue consiste à lancer
guix build --repair
(voir Invoquer guix build
).
Optimiser le dépôt en liant en dur les fichiers identiques — c’est la déduplication.
Le démon effectue une déduplication après chaque import d’archive ou construction réussie, à moins qu’il n’ait été lancé avec --disable-deduplication (voir --disable-deduplication). Ainsi, cette option est surtout utile lorsque le démon tourne avec --disable-deduplication.
Guix utilise une base de données sqlite pour garder la trace des éléments du
dépôt (voir Le dépôt). Avec le temps il est possible que la base de
données grossisse et soit fragmentée. En conséquence, vous pourriez vouloir
effacer l’espace libéré et recoller les pages partiellement utilisées dans
la base de données laissées par la suppression des paquets ou après le
lancement du ramasse-miettes. Lancer sudo guix gc
--vacuum-database
verrouillera la base de données et lancera un
VACUUM
du dépôt, pour défragmenter la base de données et libérer les
pages vides, et déverrouillera la base une fois l’opération terminée.
Suivant: Invoquer guix time-machine
, Précédent: Invoquer guix gc
, Monter: Gestion de paquets [Table des matières][Index]
guix pull
Les paquets sont installés ou mis à jour vers la dernière version disponible
dans la distribution active sur votre machine locale. Pour mettre à jour
cette distribution, en même temps que les outils Guix, vous devez lancer
guix pull
; la commande télécharge le dernier code source de Guix
ainsi que des descriptions de paquets, et le déploie. Le code source est
téléchargé depuis un dépôt Git, par
défaut le dépôt officiel de GNU Guix, bien que cela puisse être
personnalisé. guix pull
garantit que le code téléchargé est
authentique en vérifiant que les commits sont signés par les
développeur·euses de Guix.
Specifically, guix pull
downloads code from the channels
(voir Canaux) specified by one of the following, in this order:
channels
field of
guix-configuration
);
%default-channels
.
À la fin, guix package
utilisera les paquets et les versions des
paquets de la copie de Guix tout juste récupérée. Non seulement ça, mais
toutes les commandes Guix et les modules Scheme seront aussi récupérés
depuis la dernière version. Les nouvelles sous-commandes de guix
ajoutés par la mise à jour sont aussi maintenant disponibles.
Chaque utilisateur peut mettre à jour sa copie de Guix avec guix
pull
et l’effet est limité à l’utilisateur qui a lancé guix
pull
. Par exemple, lorsque l’utilisateur root
lance guix
pull
, cela n’a pas d’effet sur la version de Guix que voit alice
et
vice-versa.
Le résultat après avoir lancé guix pull
est un profil
disponible sous ~/.config/guix/current contenant la dernière version
de Guix.
L’option --list-generations ou -l liste les anciennes
générations produites par guix pull
, avec des détails sur leur
origine :
$ guix pull -l Génération 1 10 juin 2018 00:18:18 guix 65956ad URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : origin/master commit : 65956ad3526ba09e1f7a40722c96c6ef7c0936fe Génération 2 11 juin 2018 11:02:49 guix e0cc7f6 URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : origin/master commit : e0cc7f669bec22c37481dd03a7941c7d11a64f1d Génération 3 13 juin 2018 23:31:07 (actuelle) guix 844cc1c URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : origin/master commit : 844cc1c8f394f03b404c5bb3aee086922373490c
Voir guix describe
, pour d’autres
manières de décrire le statut actuel de Guix.
Ce profil ~/.config/guix/current
fonctionne comme les profils créés
par guix package
(voir Invoquer guix package
). C’est-à-dire
que vous pouvez lister les générations, revenir en arrière à une génération
précédente — c.-à-d. la version de Guix précédente — etc. :
$ guix pull --roll-back passé de la génération 3 à 2 $ guix pull --delete-generations=1 supperssion de /var/guix/profiles/per-user/charlie/current-guix-1-link
Vous pouvez aussi utiliser guix package
(voir Invoquer guix package
) pour contrôler le profil en le nommant explicitement :
$ guix package -p ~/.config/guix/current --roll-back passé de la génération 3 à 2 $ guix package -p ~/.config/guix/current --delete-generations=1 suppression de /var/guix/profiles/per-user/charlie/current-guix-1-link
La commande guix pull
est typiquement invoquée sans arguments mais
elle prend en charge les options suivantes :
--url=url
--commit=commit
--branch=branche
Télécharger le code pour le canal guix
depuis l’url spécifié,
au commit donné (un commit Git valide représenté par une chaîne
hexadécimale ou le nom d’une étiquette) ou à la branche branch.
Ces options sont fournies pour votre confort, mais vous pouvez aussi spécifier votre configuration dans le fichier ~/.config/guix/channels.scm ou en utilisant l’option --channels (voir plus bas).
--channels=file
-C file
Lit la liste des canaux dans file plutôt que dans ~/.config/guix/channels.scm ou /etc/guix/channels.scm. file doit contenir un code Scheme qui s’évalue en une liste d’objets de canaux. Voir Canaux pour plus d’informations.
--no-channel-files
-q
Inhibit loading of the user and system channel files, ~/.config/guix/channels.scm and /etc/guix/channels.scm.
--news
-N
Affiche les nouvelles écrites par les auteurs des canaux pour leurs utilisateurs et utilisatrices depuis la génération précédente (voir Writing Channel News). Lorsque vous passez --details, affiche aussi les nouveaux paquets et les paquets mis à jour.
Vous pouvez consulter ces informations pour les générations précédentes avec
guix pull -l
.
--list-generations[=motif]
-l [motif]
Liste toutes les générations de ~/.config/guix/current ou, si
motif est fournit, le sous-ensemble des générations qui correspondent
à motif. La syntaxe de motif est la même qu’avec guix
package --list-generations
(voir Invoquer guix package
).
Par défaut, cela affiche les informations sur les canaux utilisés à chaque révision et les nouvelles associées. Si vous passez l’option --details, cela affichera la liste des paquets ajoutés et mis à jour à chaque génération par rapport à la précédente.
--details
Demande à --list-generations ou --news d’afficher plus d’informations sur la différence entre les générations successives, voir plus haut.
--roll-back
¶Revenir à la génération précédente de ~/.config/guix/current c.-à-d. défaire la dernière transaction.
--switch-generation=motif
¶-S motif
Basculer vers une génération particulière définie par le motif.
Le motif peut être soit un numéro de génération soit un nombre précédé de « + » ou « - ». Ce dernier signifie : se déplacer en avant ou en arrière d’un nombre donné de générations. Par exemple, si vous voulez retourner à la dernière génération après --roll-back, utilisez --switch-generation=+1.
--delete-generations[=motif]
-d [motif]
Lorsque motif est omis, supprimer toutes les générations en dehors de l’actuelle.
Cette commande accepte les même motifs que --list-generations. Lorsque motif est spécifié, supprime les générations correspondantes. Lorsque motif spécifie une durée, les générations plus anciennes que la durée spécifiée correspondent. Par exemple --delete-generations=1m supprime les générations vieilles de plus d’un mois.
Si la génération actuelle correspond, elle n’est pas supprimée.
Remarquez que supprimer des générations empêche de revenir en arrière vers elles. Ainsi, cette commande doit être utilisée avec précaution.
Voir Invoquer guix describe
, pour une manière d’afficher des informations
sur la génération actuelle uniquement.
--profile=profil
-p profil
Utiliser le profil à la place de ~/.config/guix/current.
--dry-run
-n
Montrer quels commits des canaux seraient utilisés et ce qui serait construit ou substitué mais ne pas le faire vraiment.
--allow-downgrades
Permet d’extraire des révisions de canaux plus anciennes ou sans rapport avec celles qui sont actuellement utilisées.
Par défaut, guix pull
protège contre les attaques dites de
"downgrade", par lesquelles le dépôt Git d’un canal serait réinitialisé à
une révision antérieure ou sans rapport avec lui-même, ce qui pourrait vous
conduire à installer des versions plus anciennes de paquets logiciels, ou
connues pour être vulnérables.
Remarque : Assurez-vous de comprendre les implications de sa sécurité avant d’utiliser --allow-downgrades.
--disable-authentication
Permet de "tirer" le code du canal sans l’authentifier.
Par défaut, guix pull
authentifie le code téléchargé depuis les
canaux en vérifiant que ses commits sont signés par les développeur·euses,
et renvoie une erreur si ce n’est pas le cas. Cette option lui enjoint de ne
pas effectuer une telle vérification.
Remarque : Assurez-vous de comprendre les implications de sa sécurité avant d’utiliser --disable-authentication.
--system=système
-s système
Tenter de construire pour le système — p. ex. i686-linux
—
plutôt que pour le type de système de l’hôte de construction.
--bootstrap
Utiliser le programme d’amorçage Guile pour construire la dernière version de Guix. Cette option n’est utile qu’aux personnes qui développent Guix.
Le mécanisme de canaux vous permet de dire à guix pull
quels
répertoires et branches récupérer, ainsi que les dépôts
supplémentaires contenant des modules de paquets qui devraient être
déployés. Voir Canaux pour plus d’information.
En plus, guix pull
supporte toutes les options de construction
communes (voir Options de construction communes).
Suivant: Inférieurs, Précédent: Invoquer guix pull
, Monter: Gestion de paquets [Table des matières][Index]
guix time-machine
La commande guix time-machine
donne accès à d’autres révisions de
Guix, par exemple pour installer d’anciennes versions de paquets, ou pour
reproduire un calcul dans un environnement identique. La révision de Guix à
utiliser est définie par un commit ou par un fichier de description de canal
créé par guix describe
(voir Invoquer guix describe
).
Supposons que vous vouliez voyager en ces jours de novembre 2020 où la
version 1.2.0 de Guix a été publiée et que, une fois que vous y êtes, vous
lanciez le guile
de cette époque :
guix time-machine --commit=v1.2.0 -- \ environment -C --ad-hoc guile -- guile
La commande ci-dessus récupère Guix 1.2.0 et lance sa commande
guix environment
pour démarrer un environnement dans un conteneur
qui lance guile
(guix environment
a depuis été remplacé
par guix shell
; voir Invoquer guix shell
). C’est comme
conduire une DeLorean12 ! La première invocation de guix time-machine
peut être
coûteuse. Elle doit télécharger voire construire un grand nombre de
paquets. Heureusement le résultat est mis en cache et les commandes
suivantes qui ciblent le même commit sont presque instantanées.
As for guix pull
, in the absence of any options,
time-machine
fetches the latest commits of the channels specified
in ~/.config/guix/channels.scm, /etc/guix/channels.scm, or the
default channels; the -q option lets you ignore these configuration
files. The command:
guix time-machine -q -- build hello
will thus build the package hello
as defined in the main branch of
Guix, without any additional channel, which is in general a newer revision
of Guix than you have installed. Time travel works in both directions!
Remarque : L’histoire de Guix est immuable et
guix time-machine
fournit exactement les mêmes logiciels que ceux de la révision de Guix spécifique. Naturellement, aucun correctif de sécurité n’est fournit pour les anciennes versions de Guix ou ses canaux. Utiliserguix time-machine
sans précaution ouvre la porte à des vulnérabilités de sécurité. Voir --allow-downgrades.
guix time-machine
raises an error when attempting to travel to
commits older than “v0.16.0” (commit ‘4a0b87f0’), dated Dec. 2018.
This is one of the oldest commits supporting the channel mechanism that
makes “time travel” possible.
Remarque : Although it should technically be possible to travel to such an old commit, the ease to do so will largely depend on the availability of binary substitutes. When traveling to a distant past, some packages may not easily build from source anymore. One such example are old versions of OpenSSL whose tests would fail after a certain date. This particular problem can be worked around by running a virtual build machine with its clock set to the right time (voir Virtual Build Machines).
La syntaxe générale est :
guix time-machine options… -- commande arg…
où command et arg… sont passés sans modification à la
commande guix
de la révision spécifiée. Les options qui
définissent cette révision sont les mêmes que pour la commande guix
pull
(voir Invoquer guix pull
) :
--url=url
--commit=commit
--branch=branche
Utiliser le canal guix
depuis l’url spécifiée, au commit
donné (un commit Git valide représenté par une chaîne hexadécimale ou le nom
d’une étiquette) ou à la branche branch.
--channels=file
-C file
Lit la liste des canaux dans file. file doit contenir un code Scheme qui s’évalue en une liste d’objets de canaux. Voir Canaux pour plus d’informations.
--no-channel-files
-q
Inhibit loading of the user and system channel files, ~/.config/guix/channels.scm and /etc/guix/channels.scm.
Thus, guix time-machine -q
is equivalent to the following Bash
command, using the “process substitution” syntax (voir Process
Substitution dans The GNU Bash Reference Manual):
guix time-machine -C <(echo %default-channels) …
Remarquez que guix time-machine
peut lancer des constructions de
canaux et de leurs dépendances, et qu’elles peuvent être contrôlées avec les
options de construction communes (voir Options de construction communes).
Suivant: Invoquer guix describe
, Précédent: Invoquer guix time-machine
, Monter: Gestion de paquets [Table des matières][Index]
Remarque : La fonctionnalité décrite ici est un « démonstrateur technique » à la version f977cb2. Ainsi, l’interface est sujette à changements.
Parfois vous pourriez avoir à mélanger des paquets de votre révision de Guix avec des paquets disponibles dans une révision différente de Guix. Les inférieurs de Guix vous permettent d’accomplir cette tâche en composant différentes versions de Guix de manière arbitraire.
Techniquement, un « inférieur » est surtout un processus Guix séparé
connecté à votre processus Guix principal à travers un REPL (voir Invoquer guix repl
). Le module (guix inferior)
vous permet de créer des
inférieurs et de communiquer avec eux. Il fournit aussi une interface de
haut-niveau pour naviguer dans les paquets d’un inférieur — des paquets
inférieurs — et les manipuler.
Lorsqu’on les combine avec des canaux (voir Canaux), les inférieurs
fournissent une manière simple d’interagir avec un révision de Guix
séparée. Par exemple, disons que vous souhaitiez installer dans votre
profil le paquet guile actuel, avec le guile-json
d’une ancienne
révision de Guix — peut-être parce que la nouvelle version de
guile-json
a une API incompatible et que vous voulez lancer du code
avec l’ancienne API. Pour cela, vous pourriez écrire un manifeste à
utiliser avec guix package --manifest
(voir Écrire un manifeste) ;
dans ce manifeste, vous créeriez un inférieur pour l’ancienne révision de
Guix qui vous intéresse et vous chercheriez le paquet guile-json
dans
l’inférieur :
(use-modules (guix inferior) (guix channels) (srfi srfi-1)) ;pour « first » (define channels ;; L'ancienne révision depuis laquelle on veut ;; extraire guile-json. (list (channel (name 'guix) (url "https://git.savannah.gnu.org/git/guix.git") (commit "65956ad3526ba09e1f7a40722c96c6ef7c0936fe")))) (define inferior ;; Un inférieur représentant la révision ci-dessus. (inferior-for-channels channels)) ;; Maintenant on crée un manifeste avec le paquet « guile » actuel ;; et l'ancien paquet « guile-json ». (packages->manifest (list (first (lookup-inferior-packages inferior "guile-json")) (specification->package "guile")))
Durant la première exécution, guix package --manifest
pourrait
avoir besoin de construire le canal que vous avez spécifié avant de créer
l’inférieur ; les exécutions suivantes seront bien plus rapides parce que la
révision de Guix sera déjà en cache.
Le module (guix inferior)
fournit les procédures suivantes pour
ouvrir un inférieur :
Renvoie un inférieur pour channels, une liste de canaux. Elle utilise le cache dans cache-directory, où les entrées peuvent être glanées après ttl secondes. Cette procédure ouvre une nouvelle connexion au démon de construction.
Elle a pour effet de bord de construire ou de substituer des binaires pour channels, ce qui peut prendre du temps.
Ouvre le Guix inférieur dans directory et lance
directory/command repl
ou équivalent. Renvoie #f
si l’inférieur n’a pas pu être lancé.
Les procédures listées plus bas vous permettent d’obtenir et de manipuler des paquets inférieurs.
Renvoie la liste des paquets connus de l’inférieur inferior.
Renvoie la liste triée des paquets inférieurs qui correspondent à name dans inferior, avec le plus haut numéro de version en premier. Si version est vrai, renvoie seulement les paquets avec un numéro de version préfixé par version.
Renvoie vrai si obj est un paquet inférieur.
Ces procédures sont la contrepartie des accesseurs des enregistrements de
paquets (voir Référence de package
). La plupart fonctionne en effectuant
des requêtes à l’inférieur dont provient package, donc l’inférieur
doit toujours être disponible lorsque vous appelez ces procédures.
Les paquets inférieurs peuvent être utilisés de manière transparente comme
tout autre paquet ou objet simili-fichier dans des G-expressions
(voir G-Expressions). Ils sont aussi gérés de manière transparente par
la procédure packages->manifest
, qui est typiquement utilisée dans
des manifestes (voir l’option --manifest
de guix package
). Ainsi, vous pouvez insérer un paquet inférieur
à peu près n’importe où vous utiliseriez un paquet normal : dans des
manifestes, dans le champ packages
de votre déclaration
operating-system
, etc.
Suivant: Invoquer guix archive
, Précédent: Inférieurs, Monter: Gestion de paquets [Table des matières][Index]
guix describe
Souvent vous voudrez répondre à des questions comme « quelle révision de
Guix j’utilise ? » ou « quels canaux est-ce que j’utilise ? ». C’est une
information utile dans de nombreuses situations : si vous voulez
répliquer un environnement sur une machine différente ou un compte
utilisateur, si vous voulez rapporter un bogue ou pour déterminer quel
changement dans les canaux que vous utilisez l’a causé ou si vous voulez
enregistrer l’état de votre système pour le reproduire. La commande
guix describe
répond à ces questions.
Lorsqu’elle est lancée depuis un guix
mis à jour avec
guix pull
, guix describe
affiche les canaux qui ont été
construits, avec l’URL de leur dépôt et l’ID de leur commit
(voir Canaux) :
$ guix describe Generation 10 03 sep. 2018 17:32:44 (actuelle) guix e0fa68c URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : master commit : e0fa68c7718fffd33d81af415279d6ddb518f727
Si vous connaissez bien le système de contrôle de version Git, cela
ressemble en essence à git describe
; la sortie est aussi
similaire à celle de guix pull --list-generations
, mais limitée à
la génération actuelle (voir l’option
--list-generations). Comme l’ID de commit de Git ci-dessus se
réfère sans aucune ambiguïté à un instantané de Guix, cette information est
tout ce dont vous avez besoin pour décrire la révision de Guix que vous
utilisez et pour la répliquer.
Pour rendre plus facile la réplication de Guix, guix describe
peut
aussi renvoyer une liste de canaux plutôt que la description lisible par un
humain au-dessus :
$ guix describe -f channels (list (channel (name 'guix) (url "https://git.savannah.gnu.org/git/guix.git") (commit "e0fa68c7718fffd33d81af415279d6ddb518f727"))) (introduction (make-channel-introduction "9edb3f66fd807b096b48283debdcddccfea34bad" (openpgp-fingerprint "BBB0 2DDF 2CEA F6A8 0D1D E643 A2A0 6DF2 A33A 54FA")))))
Vous pouvez sauvegarder ceci dans un fichier et le donner à guix
pull -C
sur une autre machine ou plus tard, ce qui instantiera
exactement la même révision de Guix (voir l’option -C). À partir de là, comme vous pouvez déployer la même
révision de Guix, vous pouvez aussi bien répliquer un environnement
logiciel complet. Nous pensons humblement que c’est génial, et nous
espérons que vous aimerez ça aussi !
Voici les détails des options supportées par guix describe
:
--format=format
-f format
Produire la sortie dans le format donné, parmi :
human
produire une sortie lisible par un humain ;
canaux
produire une liste de spécifications de canaux qui peut être passée à
guix pull -C
ou installée dans ~/.config/guix/channels.scm
(voir Invoquer guix pull
) ;
channels-sans-intro
comme canaux
, mais oubliez le champ introduction
; utilisez-le
pour produire une spécification de canal adaptée à la version 1.1.0 ou
antérieure de Guix–le champ introduction
concerne l’authentification
des canaux (voir Channel Authentication) et n’est pas pris en
charge par ces versions antérieures ;
json
¶produire une liste de spécifications de canaux dans le format JSON ;
recutils
produire une liste de spécifications de canaux dans le format Recutils.
--list-formats
Affiche les formats disponibles pour l’option --format.
--profile=profil
-p profil
Afficher les informations sur le profil.
Précédent: Invoquer guix describe
, Monter: Gestion de paquets [Table des matières][Index]
guix archive
La commande guix archive
permet aux utilisateurs d’exporter
des fichiers du dépôt dans une simple archive puis ensuite de les
importer sur une machine qui fait tourner Guix. En particulier, elle
permet de transférer des fichiers du dépôt d’une machine vers le dépôt d’une
autre machine.
Remarque : Si vous chercher une manière de produire des archives dans un format adapté pour des outils autres que Guix, voir Invoquer
guix pack
.
Pour exporter des fichiers du dépôt comme une archive sur la sortie standard, lancez :
guix archive --export options spécifications...
spécifications peut être soit des noms de fichiers soit des
spécifications de paquets, comme pour guix package
(voir Invoquer guix package
). Par exemple, la commande suivante crée une
archive contenant la sortie gui
du paquet git
et la sortie
principale de emacs
:
guix archive --export git:gui /gnu/store/...-emacs-24.3 > great.nar
Si les paquets spécifiés ne sont pas déjà construits, guix archive
les construit automatiquement. Le processus de construction peut être
contrôlé avec les options de construction communes (voir Options de construction communes).
Pour transférer le paquet emacs
vers une machine connectée en SSH, on
pourrait lancer :
guix archive --export -r emacs | ssh la-machine guix archive --import
De même, on peut transférer un profil utilisateur complet d’une machine à une autre comme cela :
guix archive --export -r $(readlink -f ~/.guix-profile) | \ ssh the-machine guix archive --import
Toutefois, il faut noter que, dans les deux exemples, tous les emacs
et le profil, ainsi que toutes leurs dépendances sont transférés (en raison
de l’-r), indépendamment de ce qui est déjà disponible dans le
dépôt sur la machine cible. L’option --missing peut aider à
déterminer quels sont les éléments manquants dans le dépôt cible. La
commande guix copy
simplifie et optimise tout ce processus, c’est
donc probablement ce que vous devriez utiliser dans ce cas (voir Invoquer guix copy
).
Chaque élément du dépôt est écrit dans le format archive normalisée ou
nar (décrit ci-dessous), et la sortie de guix archive
--export
(et entrée de guix archive --import
) est un nar
bundle.
Le format nar est comparable dans l’esprit au format "tar", mais avec des différences qui le rendent plus approprié à nos objectifs. Premièrement, plutôt que d’enregistrer toutes les métadonnées Unix pour chaque fichier, le format nar ne mentionne que le type de fichier (régulier, répertoire ou lien symbolique) ; les autorisations Unix et le propriétaire/groupe sont rejetés. Deuxièmement, l’ordre dans lequel les entrées de répertoire sont stockées, suit toujours celui des noms de fichiers selon leur vérification de concordance des locales C. Cela rend la production d’archives entièrement déterministe.
Ce format de lot nar est surtout la concaténation de zéro, un ou plusieurs nar avec des métadonnées pour chaque élément du dépôt qu’il contient : son nom de fichier, ses références, la dérivation correspondante et une signature numérique.
Lors de l’export, le démon signe numériquement le contenu de l’archive et cette signature est ajoutée à la fin du fichier. Lors de l’import, le démon vérifie la signature et rejette l’import en cas de signature invalide ou si la clef de signature n’est pas autorisée.
Les principales options sont :
--export
Exporter les fichiers ou les paquets spécifiés du dépôt (voir plus bas). Écrire l’archive résultante sur la sortie standard.
Les dépendances ne sont pas incluses dans la sortie à moins que --recursive ne soit passé.
-r
--recursive
En combinaison avec --export, cette option demande à guix
archive
d’inclure les dépendances des éléments donnés dans l’archive.
Ainsi, l’archive résultante est autonome : elle contient la fermeture des
éléments de dépôt exportés.
--import
Lire une archive depuis l’entrée standard et importer les fichiers inclus dans le dépôt. Annuler si l’archive a une signature invalide ou si elle est signée par une clef publique qui ne se trouve pas dans le clefs autorisées (voir --authorize plus bas).
--missing
Liste une liste de noms de fichiers du dépôt sur l’entrée standard, un par ligne, et écrit sur l’entrée standard le sous-ensemble de ces fichiers qui manquent dans le dépôt.
--generate-key[=paramètres]
¶Génére une nouvelle paire de clefs pour le démon. C’ est un prérequis avant
que les archives ne puissent être exportées avec --export. Cette
opération est habituellement instantanée mais elle peut prendre du temps
parce qu’elle doit récupérer suffisamment d’entropie pour générer la paire
de clefs. Sur Guix System, guix-service-type
prend soin de générer
cette paire de clés au premier démarrage.
La paire de clés générée est typiquement stockée dans /etc/guix, dans
signing-key.pub (clé publique) et signing-key.sec (clé privée,
qui doit rester secrète). Lorsque paramètres est omis, une clé ECDSA
utilisant la courbe Ed25519 est générée, ou pour les version de libgcrypt
avant 1.6.0, une clé RSA de 4096 bits. Autrement, paramètres peut
spécifier les paramètres genkey
adaptés pour libgcrypt
(voir gcry_pk_genkey
dans The Libgcrypt Reference Manual).
--authorize
¶Autoriser les imports signés par la clef publique passée sur l’entrée standard. La clef publique doit être au « format avancé s-expression » — c.-à-d. le même format que le fichier signing-key.pub.
La liste des clés autorisées est gardée dans un fichier modifiable par des humains dans /etc/guix/acl. Le fichier contient des « s-expressions au format avancé » et est structuré comme une liste de contrôle d’accès dans l’infrastructure à clefs publiques simple (SPKI).
--extract=répertoire
-x répertoire
Lit une archive à un seul élément telle que servie par un serveur de substituts (voir Substituts) et l’extrait dans répertoire. C’est une opération de bas niveau requise seulement dans de rares cas d’usage ; voir plus loin.
Par exemple, la commande suivante extrait le substitut pour Emacs servi par
bordeaux.guix.gnu.org
dans /tmp/emacs :
$ wget -O - \ https://bordeaux.guix.gnu.org/nar/gzip/…-emacs-24.5 \ | gunzip | guix archive -x /tmp/emacs
Les archives à un seul élément sont différentes des archives à plusieurs
éléments produites par guix archive --export
; elles contiennent
un seul élément du dépôt et elles n’embarquent pas de signature.
Ainsi cette opération ne vérifie pas de signature et sa sortie
devrait être considérée comme non sûre.
Le but principal de cette opération est de faciliter l’inspection du contenu
des archives venant de serveurs auxquels on ne fait potentiellement pas
confiance. (voir Invoquer guix challenge
).
--list
-t
Lit une archive à un seul élément telle que servie par un serveur de substituts (voir Substituts) et affiche la liste des fichiers qu’elle contient, comme dans cet exemple :
$ wget -O - \ https://bordeaux.guix.gnu.org/nar/lzip/…-emacs-26.3 \ | lzip -d | guix archive -t
Suivant: Développement, Précédent: Gestion de paquets, Monter: GNU Guix [Table des matières][Index]
Guix and its package collection are updated by running guix pull
.
By default guix pull
downloads and deploys Guix itself from the
official GNU Guix repository. This can be customized by providing a
file specifying the set of channels to pull from (voir Invoquer guix pull
). A channel specifies the URL and branch of a Git repository to be
deployed, and guix pull
can be instructed to pull from one or more
channels. In other words, channels can be used to customize and to
extend Guix, as we will see below. Guix is able to take into account
security concerns and deal with authenticated updates.
Suivant: Utiliser un canal Guix personnalisé, Monter: Canaux [Table des matières][Index]
Vous pouvez spécifier des canaux supplémentaires à utiliser. Pour
utiliser un canal, écrivez dans ~/.config/guix/channels.scm
pour dire
à guix pull
de récupérer votre canal personnel en plus des
canaux par défaut de Guix :
;; Ajouter des variantes de paquets à ceux fournis par Guix. (cons (channel (name 'my-personal-packages) (url "https://example.org/personal-packages.git")) %default-channels)
Remarquez que le bout de code au-dessus est (comme toujours !) du code
Scheme ; nous utilisons cons
pour ajouter un canal à la liste des
canaux que la variable %default-channels
représente (voir cons
and lists dans GNU Guile Reference Manual). Avec ce
fichier en place, guix pull
construit non seulement Guix mais
aussi les modules de paquets de votre propre dépôt. Le résultat dans
~/.config/guix/current est l’union de Guix et de vos propres modules
de paquets :
$ guix describe Génération 19 Aug 27 2018 16:20:48 guix d894ab8 URL du dépôt : https://git.savannah.gnu.org/git/guix.git branche : master commit : d894ab8e9bfabcefa6c49d9ba2e834dd5a73a300 variant-packages dd3df5e URL du dépôt : https://example.org/personal-packages.git branche : master commit : dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb
The output of guix describe
above shows that we’re now running
Generation 19 and that it includes both Guix and packages from the
variant-packages
channel (voir Invoquer guix describe
).
Suivant: Répliquer Guix, Précédent: Spécifier des canaux supplémentaires, Monter: Canaux [Table des matières][Index]
Le canal nommé guix
spécifie où Guix lui-même — ses outils en ligne
de commande ainsi que sa collection de paquets — seront téléchargés. Par
exemple, supposons que vous voulez effectuer les mises à jour depuis votre
propre copie du dépôt Guix sur example.org
, et plus particulièrement
depuis la branche super-hacks
. Vous pouvez écrire cette
spécification dans ~/.config/guix/channels.scm
:
;; Dit à « guix pull » d'utiliser un autre dépôt. (list (channel (name 'guix) (url "https://example.org/my-guix.git") (branch "super-hacks")))
Maintenant, guix pull
récupérera le code depuis la branche
super-hacks
du dépôt sur example.org
. La question de
l’authentification est traitée ci-dessous (voir Authentification des canaux).
Note that you can specify a local directory on the url
field above if
the channel that you intend to use resides on a local file system. However,
in this case guix
checks said directory for ownership before any
further processing. This means that if the user is not the directory owner,
but wants to use it as their default, they will then need to set it as a
safe directory in their global git configuration file. Otherwise,
guix
will refuse to even read it. Supposing your system-wide
local directory is at /src/guix.git
, you would then create a git
configuration file at ~/.gitconfig
with the following contents:
[safe] directory = /src/guix.git
This also applies to the root user unless when called with sudo
by
the directory owner.
Suivant: Customizing the System-Wide Guix, Précédent: Utiliser un canal Guix personnalisé, Monter: Canaux [Table des matières][Index]
La commande guix describe
ci-dessus montre précisément quels
commits ont été utilisés pour construire l’instance de Guix utilisée
(voir Invoquer guix describe
). Nous pouvons répliquer cette instance sur
une autre machine ou plus tard, en fournissant une spécification de canal «
épinglée » à ces commits et qui ressemble à ceci :
;; Déployer des commits précis de mes canaux préférés. (list (channel (name 'guix) (url "https://git.savannah.gnu.org/git/guix.git") (commit "6298c3ffd9654d3231a6f25390b056483e8f407c")) (channel (name 'variant-packages) (url "https://example.org/variant-packages.git") (commit "dd3df5e2c8818760a8fc0bd699e55d3b69fef2bb")))
Pour obtenir cette spécification de canaux épinglée, le plus simple est de
lancer guix describe
et de sauvegarder sa sortie au format
channels
dans un fichier, comme ceci :
guix describe -f channels > channels.scm
Le fichier channels.scm qui en résulte peut être passé à l’option
-C de guix pull
(voir Invoquer guix pull
) ou
guix time-machine
(voir Invoquer guix time-machine
), comme dans
cet exemple :
guix time-machine -C channels.scm -- shell python -- python3
Étant donné le fichier channels.scm, la commande ci-dessus récupérera
toujours exactement la même instance de Guix, puis utilisera cette
instance pour lancer exactement le même Python (voir Invoquer guix shell
). Sur n’importe quelle machine, à n’importe quel moment, elle lance
exactement le même binaire, bit à bit.
Les canaux épinglés répondent à un problème similaire à celui des « fichiers de verrouillage » implémentés par certains outils de déploiement — ils vous permettent d’épingler et de reproduire un ensemble de paquets. Dans le cas de Guix cependant, vous épinglez en fait l’entièreté de l’ensemble de paquets défini par les commits donnés des canaux ; en fait, vous épinglez l’ensemble de Guix, avec des modules cœurs et ses outils en ligne de commande. Vous gagnez aussi la garantie forte que vous obtenez, effectivement, exactement le même environnement logiciel.
Cela vous donne des super-pouvoirs, ce qui vous permet de suivre la provenance des artefacts binaires avec un grain très fin et de reproduire les environnements logiciels à volonté — une sorte de capacité de « méta-reproductibilité », si vous voulez. Voir Inférieurs, pour une autre manière d’utiliser ces super-pouvoirs.
Suivant: Authentification des canaux, Précédent: Répliquer Guix, Monter: Canaux [Table des matières][Index]
If you’re running Guix System or building system images with it, maybe you
will want to customize the system-wide guix
it
provides—specifically, /run/current-system/profile/bin/guix. For
example, you might want to provide additional channels or to pin its
revision.
This can be done using the guix-for-channels
procedure, which returns
a package for the given channels, and using it as part of your operating
system configuration, as in this example:
(use-modules (gnu packages package-management) (guix channels)) (define my-channels ;; Channels that should be available to ;; /run/current-system/profile/bin/guix. (append (list (channel (name 'guix-science) (url "https://github.com/guix-science/guix-science") (branch "master"))) %default-channels)) (operating-system ;; … (services ;; Change the package used by 'guix-service-type'. (modify-services %base-services (guix-service-type config => (guix-configuration (inherit config) (channels my-channels) (guix (guix-for-channels my-channels)))))))
The resulting operating system will have both the guix
and the
guix-science
channels visible by default. The channels
field
of guix-configuration
above further ensures that
/etc/guix/channels.scm, which is used by guix pull
,
specifies the same set of channels (voir channels
field of guix-configuration
).
The (gnu packages package-management)
module exports the
guix-for-channels
procedure, described below.
Return a package corresponding to channels.
The result is a “regular” package, which can be used in
guix-configuration
as shown above or in any other place that expects
a package.
Suivant: Canaux avec des substituts, Précédent: Customizing the System-Wide Guix, Monter: Canaux [Table des matières][Index]
Les commandes guix pull
et guix time-machine
authenticate téléchargent et contrôlent le code récupéré sur les
canaux : elles s’assurent que chaque commit récupéré est signé par un·e
développeur·euse autorisé·e. L’objectif est de protéger contre les
modifications non autorisées du canal qui conduiraient les
utilisateur·rice·s à exécuter du code malveillant.
En tant qu’utilisateur, vous devez fournir une introduction de canal dans votre fichier de canaux afin que Guix sache comment authentifier son premier commit. Une spécification de canal, y compris son introduction, ressemble à quelque chose de ce genre :
(channel
(name 'some-channel)
(url "https://example.org/some-channel.git")
(introduction
(make-channel-introduction
"6f0d8cc0d88abb59c324b2990bfee2876016bb86"
(openpgp-fingerprint
"CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5"))))
La spécification ci-dessus indique le nom et l’URL du canal. L’appel à
make-channel-introduction
ci-dessus spécifie que l’authentification
de ce canal commence au commit 6f0d8cc…
, qui est signé par la
clé OpenPGP avec l’empreinte digitale CABB A931…
.
Pour le canal principal, appelé guix
, vous obtenez automatiquement
cette information à partir de votre installation de Guix. Pour les autres
canaux, incluez l’introduction du canal fournie par les auteurs du canal
dans votre fichier channels.scm. Assurez-vous de récupérer
l’introduction du canal à partir d’une source fiable, car c’est la base de
votre confiance.
Si vous êtes curieux·euse à propos des mécanismes d’authentification, lisez !
Suivant: Écrire de nouveaux de canaux, Précédent: Authentification des canaux, Monter: Canaux [Table des matières][Index]
Lorsque vous lancez guix pull
, Guix compilera d’abord les
définitions de tous les paquets disponibles. C’est une opération coûteuse
pour laquelle des substituts (voir Substituts) peuvent être
disponibles. L’extrait de code suivant dans channels.scm s’assure que
guix pull
utilise le dernier commit pour lequel des substituts
sont disponibles pour les définitions des paquets : pour cela, on demande au
serveur d’intégration continue https://ci.guix.gnu.org.
(use-modules (guix ci)) (list (channel-with-substitutes-available %default-guix-channel "https://ci.guix.gnu.org"))
Remarquez que cela ne signifie pas que tous les paquets que vous installerez
après avoir lancé guix pull
auront des substituts. Cela s’assure
uniquement que guix pull
n’essaiera pas de compiler les
définitions des paquets. C’est particulièrement pratique si vous utilisez
une machine avec des ressources limitées.
Suivant: Modules de paquets dans un sous-répertoire, Précédent: Canaux avec des substituts, Monter: Canaux [Table des matières][Index]
Let’s say you have a bunch of custom package variants or personal packages that you think would make little sense to contribute to the Guix project, but would like to have these packages transparently available to you at the command line. By creating a channel, you can use and publish such a package collection. This involves the following steps:
mkdir my-channel cd my-channel git init
For example, Alice might want to provide a module called (alice
packages greetings)
that will provide her favorite “hello world”
implementations. To do that Alice will create a directory corresponding to
that module name.
mkdir -p alice/packages $EDITOR alice/packages/greetings.scm git add alice/packages/greetings.scm
You can name your package modules however you like; the main constraint to
keep in mind is to avoid name clashes with other package collections, which
is why our hypothetical Alice wisely chose the (alice packages
…)
name space.
Note that you can also place modules in a sub-directory of the repository; voir Modules de paquets dans un sous-répertoire, for more info on that.
guix build
, which needs to be
told to look for modules in the Git checkout. For example, assuming
(alice packages greetings)
provides a package called
hi-from-alice
, Alice will run this command from the Git checkout:
guix build -L. hi-from-alice
... where -L.
adds the current directory to Guile’s load path
(voir Load Paths dans GNU Guile Reference Manual).
git commit
En tant qu’auteur.e d’un canal, envisagez de regrouper le nécessaire d’authentification avec votre canal afin que les utilisatrice·eur·s puissent l’authentifier. Voir Authentification des canaux, et Spécifier les autorisations des canaux, pour savoir comment les utiliser.
guix pull
(voir Invoquer guix pull
):
$EDITOR ~/.config/guix/channels.scm guix pull
Guix will now behave as if the root directory of that channel’s Git
repository had been permanently added to the Guile load path. In this
example, (alice packages greetings)
will automatically be found by
the guix
command.
Et voilà !
Attention : Before you publish your channel, we would like to share a few words of caution:
- Avant de publier un canal, envisagez de contribuer vos définitions de paquets dans Guix (voir Contribuer). Guix en tant que projet est ouvert à tous les logiciels libres de toutes sortes, et les paquets dans Guix sont déjà disponibles à tous les utilisateurs de Guix et bénéficient des processus d’assurance qualité du projet.
- Package modules and package definitions are Scheme code that uses various programming interfaces (APIs). We, Guix developers, never change APIs gratuitously, but we do not commit to freezing APIs either. When you maintain package definitions outside Guix, we consider that the compatibility burden is on you.
- Corollaire : si vous utilisez un canal externe et que le canal est cassé, merci de rapporter le problème à l’auteur du canal, pas au projet Guix.
Vous avez été prévenus ! Maintenant, nous pensons que des canaux externes sont une manière pratique d’exercer votre liberté pour augmenter la collection de paquets de Guix et de partager vos améliorations, qui sont les principes de bases du logiciel libre. Contactez-nous par courriel sur guix-devel@gnu.org si vous souhaitez discuter à ce propos.
Suivant: Déclarer des dépendances de canaux, Précédent: Écrire de nouveaux de canaux, Monter: Canaux [Table des matières][Index]
En tant qu’auteur.e d’un canal, vous voudriez garder vos modules de canal dans un sous-répertoire. Si vos modules sont dans le sous-répertoire guix, vous devez ajouter un fichier de métadonnées .guix-channel qui contient :
(channel
(version 0)
(directory "guix"))
Les modules doivent se situer dans le répertoire spécifié, car le
directory
change le load-path
(chemin de recherche) de
Guile. Par exemple, si .guix-channel a (directory "base")
,
alors un module défini comme (define-module (gnu packages fun))
doit
être situé dans base/gnu/packages/fun.scm
.
Cela permet de n’utiliser qu’une partie du dépôt comme canal, puisque Guix
s’attend à trouver des modules Guile valide en le récupérant. Par exemple,
les fichiers de configuration de machines pour guix deploy
ne sont
pas des modules Guile valides, et les traiter comme tel fera échouer
guix pull
.
Suivant: Spécifier les autorisations des canaux, Précédent: Modules de paquets dans un sous-répertoire, Monter: Canaux [Table des matières][Index]
Les auteurs de canaux peuvent décider d’augmenter une collection de paquets fournie par d’autres canaux. Ils peuvent déclarer leur canal comme dépendant d’autres canaux dans le fichier de métadonnées .guix-channel qui doit être placé à la racine de dépôt du canal.
Le fichier de métadonnées devrait contenir une S-expression simple comme cela :
(channel
(version 0)
(dependencies
(channel
(name some-collection)
(url "https://example.org/first-collection.git")
;; La partie « introduction » ci-dessous est facultative : vous la
;; fournissez pour les dépendances qui peuvent être authentifiées.
(introduction
(channel-introduction
(version 0)
(commit "a8883b58dc82e167c96506cf05095f37c2c2c6cd")
(signer "CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5"))))
(channel
(name some-other-collection)
(url "https://example.org/second-collection.git")
(branch "testing"))))
Dans l’exemple ci-dessus, ce canal est déclaré comme dépendant de deux autres canaux, qui seront récupérés automatiquement. Les modules fournis par le canal seront compilés dans un environnement où les modules de tous les canaux déclarés sont disponibles.
Pour des raisons de fiabilité et de maintenabilité, vous devriez éviter d’avoir des dépendances sur des canaux que vous ne maîtrisez pas et vous devriez ajouter le minimum de dépendances possible.
Suivant: URL primaire, Précédent: Déclarer des dépendances de canaux, Monter: Canaux [Table des matières][Index]
Comme nous l’avons vu plus haut, Guix garantit le code source qu’il récupère depuis les canaux venant de développeur·euses autorisé·es. En tant qu’auteur·e, vous devez spécifiez la liste des développeur·euses autorisé·es dans le fichier .guix-authorizations dans le dépôt Git des canaux. Le rôle de l’authentification est simple : chaque commit doit être signé par une clé listée dans le fichier .guix-authorizations de son (ses) commit(s) parent(s)13 Le fichier .guix-authorizations ressemble à ceci :
;; Fichier d'exemple '.guix-authorizations'. (authorizations (version 0) ;version actuelle du format de fichier (("AD17 A21E F8AE D8F1 CC02 DBD9 F8AE D8F1 765C 61E3" (name "alice")) ("2A39 3FFF 68F4 EF7A 3D29 12AF 68F4 EF7A 22FB B2D5" (name "bob")) ("CABB A931 C0FF EEC6 900D 0CFB 090B 1199 3D9A EBB5" (name "charlie"))))
Chaque empreinte digitale est suivie de paires de clés/valeurs facultatives, comme dans l’exemple ci-dessus. Actuellement, ces paires clé/valeur sont ignorées.
Ce rôle d’authentification crée un problème de poule et d’œuf : comment authentifions-nous le premier commit ? Par rapport à cela : comment traiter les canaux dont l’historique du dépôt contient des commits non signés et qui n’ont pas de.guix-authorisations ? Et comment bifurquer des canaux existants ?
L’introduction des canaux répondent à ces questions en décrivant le premier
commit d’un canal qui doit être authentifiée. La première fois qu’un canal
est récupéré avec guix pull
ou guix time-machine
, la
commande recherche le commit d’introduction et vérifie qu’il est signé par
la clé OpenPGP spécifiée. Elle authentifie ensuite les commits selon la
règle ci-dessus. L’authentification échoue si le commit cible n’est ni un
descendant ni un ancêtre du commit d’introduction.
De plus, votre canal doit fournir toutes les clés OpenPGP qui ont été
mentionnées dans les fichiers .guix-authorizations, stockés dans les
fichiers .key, qui peuvent être soit binaires soit "blindés ASCII".
Par défaut, ces fichiers .key sont recherchés dans la branche nommée
keyring
, mais vous pouvez spécifier un nom de branche différent dans
.guix-channel
de cette façon :
(channel
(version 0)
(keyring-reference "my-keyring-branch"))
En résumé, en tant qu’auteur.e d’une chaîne, il y a trois choses que vous devez faire pour permettre aux utilisateur·rice·s d’authentifier votre code :
gpg -export
et les stocker dans des fichiers .key, par
défaut dans une branche nommée keyring
(nous recommandons d’en faire
une branche orpheline).
Before pushing to your public Git repository, you can run guix git
authenticate
to verify that you did sign all the commits you are about to
push with an authorized key:
guix git authenticate commit signer
où commit et signer sont votre présentation de canal.
Voir Invoquer guix git authenticate
, pour plus de détails.
Publier un canal signé demande de la discipline : toute faute, comme un commit non signé ou un commit signée par une clé non autorisée, vont empêcher les utilisateur·rice·s de récupérer depuis votre canal—bref, c’est tout l’intérêt de l’authentification ! Faites particulièrement attention aux merges : les merge commits sont considérés comme authentiques si et seulement s’ils sont signés par une clé présente dans le fichier .guix-authorizations des branches both.
Suivant: Écrire des nouveautés de canaux, Précédent: Spécifier les autorisations des canaux, Monter: Canaux [Table des matières][Index]
Les auteur.e.s de canaux peuvent indiquer l’URL principale de leur dépôt Git de canal dans le fichier .guix-channel comme ceci :
(channel
(version 0)
(url "https://example.org/guix.git"))
Cela permet à guix pull
de déterminer si elle récupère du code
d’un miroir du canal ; lorsque c’est le cas, elle avertit l’utilisateur·rice
que le miroir pourrait être périmé et affiche l’URL primaire. De cette
façon, les utilisateur·rice·s ne peuvent pas être amené·e·s à extraire du
code d’un miroir périmé qui ne reçoit pas les mises à jour de sécurité.
Cette fonctionnalité n’a de sens que pour les dépôts authentifiés, tels que
le canal officiel guix
, pour lequel guix pull
garantit
l’authenticité du code qu’il récupère.
Précédent: URL primaire, Monter: Canaux [Table des matières][Index]
Les auteur.e.s de canaux peuvent occasionnellement vouloir communiquer à leurs utilisateur·rice·s des informations au sujet de changements importants dans le canal. Vous pourriez leur envoyer un courriel, mais ce n’est pas pratique.
Au lieu de cela, les canaux peuvent fournir un fichier de nouvelles ;
lorsque les utilisateur·rice·s du canal exécutent guix pull
, ce
fichier de nouvelles est automatiquement lu et guix pull --news
peut afficher les annonces qui correspondent aux nouveaux commits qui ont
été récupérés, le cas échéant.
Pour cela, les auteur·e·s de canaux doivent en premier lieu déclarer le nom du fichier de nouvelles dans leur fichier .guix-channel :
(channel
(version 0)
(news-file "etc/news.txt"))
Le fichier de nouvelles lui-même, etc/news.txt dans cet exemple, doit ressembler à quelque chose comme ceci :
(channel-news
(version 0)
(entry (tag "the-bug-fix")
(title (en "Fixed terrible bug")
(fr "Oh la la"))
(body (en "@emph{Good news}! It's fixed!")
(eo "Certe ĝi pli bone funkcias nun!")))
(entry (commit "bdcabe815cd28144a2d2b4bc3c5057b051fa9906")
(title (en "Added a great package")
(ca "Què vol dir guix?"))
(body (en "Don't miss the @code{hello} package!"))))
Tandis que le fichier de nouvelles utilise la syntaxe Scheme, évitez de le nommer avec une extension .scm, sinon il sera récupéré lors de la construction du canal et produira une erreur puisqu’il ne s’agit pas d’un module valide. Vous pouvez également déplacer le module du canal dans un sous-répertoire et stocker le fichier de nouvelles dans un autre répertoire.
Le fichier consiste en une liste de news entries. Chaque entrée est associée à un commit ou un tag : elle décrit les changements faits dans ce commit, éventuellement dans les commits précédents comme il faut. Les utilisateur·rice·s ne voient les entrées que la première fois qu’il·elle·s obtiennent le commit auquel l’entrée se réfère.
Le titre
doit être un résumé d’une ligne tandis que body
peut
être arbitrairement long, et les deux peuvent contenir des balises Texinfo
(voir Overview dans GNU Texinfo). Le titre et le corps sont tous
deux une liste de tuples de balises/messages de langue, ce qui permet à
guix pull
d’afficher les nouvelles dans la langue qui correspond à
la locale de l’utilisateur.
Si vous souhaitez traduire des actualités en utilisant un déroulement basé
sur gettext, vous pouvez extraire des chaînes traduisibles avec
xgettext
(voir xgettext Invocation dans GNU Gettext
Utilities). Par exemple, en supposant que vous écriviez d’abord les
entrées de nouvelles en anglais, la commande ci-dessous crée un fichier PO
contenant les chaînes à traduire :
xgettext -o news.po -l scheme -ken etc/news.txt
Pour résumer, oui, vous pourriez utiliser votre chaîne comme un blog. Mais attention, ce n’est pas tout à fait ce à quoi vos utilisateur·rice·s pourraient s’attendre.
Suivant: Interface de programmation, Précédent: Canaux, Monter: GNU Guix [Table des matières][Index]
Si vous êtes développeur de logiciels, Guix fournit des outils que vous devriez trouver utiles — indépendamment du langage dans lequel vous développez. C’est ce dont parle ce chapitre.
La commande guix shell
permet de créer des environnements
logiciels à usage unique, que ce soit pour le développement ou pour lancer
une commande sans l’installer dans votre profil. La commande guix
pack
vous permet de créer des lots applicatifs qui peuvent facilement
être distribués à des utilisateurs qui n’utilisent pas Guix.
guix shell
guix environment
guix pack
guix git authenticate
Suivant: Invoquer guix environment
, Monter: Développement [Table des matières][Index]
guix shell
Le but de guix shell
est de faciliter la création d’environnements
logiciels à usage unique, sans changer votre profil. Vous l’utiliserez
typiquement pour créer des environnement de développement ; c’est aussi une
commande pratique pour lancer des applications sans « polluer » votre
profil.
Remarque : La commande
guix shell
a été introduite récemment pour remplacerguix environment
(voir Invoquerguix environment
). Si vous connaissez déjàguix environment
, vous remarquerez qu’elle est similaire mais aussi (on l’espère) plus pratique.
La syntaxe générale est :
guix shell [options] [paquet…]
L’exemple suivant crée un environnement contenant Python et NumPy, en
construisant ou en téléchargeant les paquets manquants et lance la commande
python3
dans cet environnement :
guix shell python python-numpy -- python3
Note that it is necessary to include the main python
package in this
command even if it is already installed into your environment. This is so
that the shell environment knows to set PYTHONPATH
and other related
variables. The shell environment cannot check the previously installed
environment, because then it would be non-deterministic. This is true for
most libraries: their corresponding language package should be included in
the shell invocation.
Remarque :
guix shell
can be also be used as a script interpreter, also known as shebang. Here is an example self-contained Python script making use of this feature:#!/usr/bin/env -S guix shell python python-numpy -- python3 import numpy print("This is numpy", numpy.version.version)You may pass any
guix shell
option, but there’s one caveat: the Linux kernel has a limit of 127 bytes on shebang length.
Vous pouvez créer des environnements de développement comme dans l’exemple ci-dessous, qui ouvre un shell interactif contenant toutes les dépendance et les variables d’environnement requises pour travailler sur Inkscape :
guix shell --development inkscape
Sortir du shell vous replacera dans l’environnement de départ, avant d’avoir
invoqué la commande guix shell
. Au prochain lancement du
ramasse-miettes (voir Invoquer guix gc
), les paquets installés dans
l’environnement et qui ne sont plus utilisés en dehors seront possiblement
supprimés.
En plus, guix shell
essayera de faire ce que vous espérez quand il
est invoqué de manière interactive et sans arguments, comme ceci :
guix shell
S’il trouve un manifest.scm dans le répertoire de travail actuel ou
dans l’un de ses parents, il utiliser ce manifeste comme s’il avait été
passé avec --manifest
. De la même manière, s’il trouve un
guix.scm dans ces mêmes répertoire, il l’utilisera pour construire un
profil de développement comme si --development
et --file
étaient présents. Dans tous les cas, le fichier ne sera chargé que s’il
réside dans un répertoire listé dans
~/.config/guix/shell-authorized-directories. Cela permet de
facilement définir, partager et entrer dans des environnements de
développement.
Par défaut, la session shell ou la commande est lancée dans un environnement
augmenté, où les nouveaux paquets sont ajoutés aux variables
d’environnement de recherche comme PATH
. Vous pouvez à la place créer
un environnement isolé ne contenant rien d’autre que les paquets que
vous avez demandé. Passez l’option --pure pour nettoyer les
définitions des variables d’environnement qui se trouvent dans
l’environnement parent14 ; en passant --container vous pouvez aller
plus loin en démarrant un conteneur isolé du reste du système :
guix shell --container emacs gcc-toolchain
La commande ci-dessus démarre un shell interactif dans un conteneur avec
rien d’autre que emacs
, gcc-toolchain
et leurs dépendances. Le
conteneur n’a pas d’accès au réseau et ne partage pas les fichiers autres
que ceux du répertoire de travail avec son environnement. C’est utile pour
éviter d’accéder à des ressources systèmes comme /usr/bin sur les
distributions externes.
This --container option can also prove useful if you wish to run a security-sensitive application, such as a web browser, in an isolated environment. For example, the command below launches Ungoogled-Chromium in an isolated environment, which:
DISPLAY
and XAUTHORITY
XAUTHORITY
file
guix shell --container --network --no-cwd ungoogled-chromium \ --preserve='^XAUTHORITY$' --expose="${XAUTHORITY}" \ --preserve='^DISPLAY$' -- chromium
guix shell
définie la variable GUIX_ENVIRONMENT
dans le
shell qu’il crée ; sa valeur est le nom de fichier du profil de cet
environnement. Cela permet aux utilisatrice·eur·s, disons, de définir un
prompt spécifique pour les environnement de développement dans leur
.bashrc (voir Bash Startup Files dans The GNU Bash Reference
Manual) :
if [ -n "$GUIX_ENVIRONMENT" ] then export PS1="\u@\h \w [dev]\$ " fi
… ou de naviguer dans le profil :
$ ls "$GUIX_ENVIRONMENT/bin"
Les options disponibles sont résumées ci-dessous.
--check
Met en place l’environnement et vérifie si le shell peut écraser les
variables d’environnement. C’est une bonne idée d’utiliser cette option la
première fois que vous lancez guix shell
pour une session
interactive pour vous assurer que votre configuration est correcte.
Par exemple, si le shell modifie la variable d’environnement PATH
,
cela sera rapporté car vous auriez un environnement différent de celui que
vous avez demandé.
Ces problèmes indiquent en général que les fichiers de démarrage du shell modifient ces variables d’environnement de manière inattendue. Par exemple, si vous utilisez Bash, assurez-vous que les variables d’environnement sont définie ou modifiées dans ~/.bash_profile et non dans ~/.bashrc — ce premier est sourcé seulement par les shells de connexion. Voir Bash Startup Files dans le manuel de référence de Bash pour plus de détails sur les fichiers de démarrage de Bash.
--development
-D
Fait en sorte que guix shell
ajoute à l’environnement les
dépendances du paquet suivant au lieu du paquet lui-même. Vous pouvez
combiner cette option avec d’autres paquets. Par exemple, la commande
suivante démarre un shell interactif contenant les dépendances à la
construction de GNU Guile, plus Autoconf, Automake et Libtool :
guix shell -D guile autoconf automake libtool
--expression=expr
-e expr
Crée un environnement pour le paquet ou la liste de paquets en lesquels s’évalue expr.
Par exemple, lancer :
guix shell -D -e '(@ (gnu packages maths) petsc-openmpi)'
démarre un shell avec l’environnement pour cette variante spécifique du paquet PETSc.
Lancer :
guix shell -e '(@ (gnu) %base-packages)'
démarre un shell où tous les paquets de base du système sont disponibles.
Les commande au-dessus n’utilisent que les sorties par défaut des paquets donnés. Pour choisir d’autres sorties, on peut spécifier des pairs :
guix shell -e '(list (@ (gnu packages bash) bash) "include")'
Voir package->development-manifest
,
pour apprendre à écrire un fichier manifeste ou l’environnement de
développement d’un paquet.
--file=fichier
-f fichier
Crée un environnement contenant le paquet ou la liste de paquets en lesquels fichier s’évalue.
Par exemple, fichier peut contenir une définition comme celle-ci (voir Définition des paquets) :
(use-modules (guix) (gnu packages gdb) (gnu packages autotools) (gnu packages texinfo)) ;; Augment the package definition of GDB with the build tools ;; needed when developing GDB (and which are not needed when ;; simply installing it.) (package (inherit gdb) (native-inputs (modify-inputs (package-native-inputs gdb) (prepend autoconf-2.69 automake texinfo))))
Avec le fichier ci-dessus, vous pouvez entrer un environnement de développement pour GDB en lançant :
guix shell -D -f gdb-devel.scm
--manifest=fichier
-m fichier
Crée un environnement pour les paquets contenus dans l’objet manifeste renvoyé par le code Scheme dans fichier. Vous pouvez répéter cette option plusieurs fois, auquel cas les manifestes sont concaténés.
C’est similaire à l’option de même nom de guix package
(voir --manifest) et utilise les même fichiers
manifestes.
Voir Écrire un manifeste, pour des informations sur l’écriture d’un manifeste. Voir --export-manifest ci-dessous pour apprendre à obtenir un premier manifeste.
--export-manifest
Écrire un manifeste vers la sortie standard utilisable avec --manifest et qui correspond aux options de la ligne de commande données.
C’est une manière de « convertir » les arguments de la ligne de commande en un manifeste. Par exemple, imaginez que vous en ayez marre de taper de longues lignes et souhaitez avoir un manifeste équivalent à cette ligne de commande :
guix shell -D guile git emacs emacs-geiser emacs-geiser-guile
Ajoutez l’option --export-manifest à la ligne de commande ci-dessus :
guix shell --export-manifest \ -D guile git emacs emacs-geiser emacs-geiser-guile
... et vous obtiendrez un manifeste comme ceci :
(concatenate-manifests
(list (specifications->manifest
(list "git"
"emacs"
"emacs-geiser"
"emacs-geiser-guile"))
(package->development-manifest
(specification->package "guile"))))
Vous pouvez l’enregistrer dans un fichier, disons manifest.scm, et
ensuite le passer à guix shell
ou n’importe quelle commande
guix
:
guix shell -m manifest.scm
Voilà, vous avez convertit une longue ligne de commande en un manifeste ! Ce processus de conversion prend en compte les options de transformation des paquets (voir Options de transformation de paquets) et ne devrait donc pas perdre d’information.
--profile=profil
-p profil
Crée un environnement contenant les paquets installés dans
profile. Utilisez guix package
(voir Invoquer guix package
) pour créer et gérer les profils.
--pure
Réinitialisation des variables d’environnement existantes lors de la construction du nouvel environnement, sauf celles spécifiées avec l’option --preserve. (voir ci-dessous). Cela a pour effet de créer un environnement dans lequel les chemins de recherche ne contiennent que des entrées de paquets.
--preserve=regexp
-E regexp
Lorsque vous utilisez --pure, préserver les variables d’environnement qui correspondent à regexp — en d’autres termes, cela les met en « liste blanche » de variables d’environnement qui doivent être préservées. Cette option peut être répétée plusieurs fois.
guix shell --pure --preserve=^SLURM openmpi … \ -- mpirun …
Cet exemple exécute mpirun
dans un contexte où les seules
variables d’environnement définies sont PATH
, les variables
d’environnement dont le nom commence par ‘SLURM’, ainsi que les
variables « importantes » habituelles (HOME
, USER
, etc.).
--search-paths
Affiche les définitions des variables d’environnement qui composent l’environnement.
--system=système
-s système
Essaye de construire pour système — p. ex. i686-linux
.
--container
¶-C
Lance commande dans un conteneur isolé. Le répertoire de travail actuel en dehors du conteneur est monté dans le conteneur. En plus, à moins de le changer avec --user, un répertoire personnel fictif est créé pour correspondre à celui de l’utilisateur·rice actuel·le et /etc/passwd est configuré en conséquence.
Le processus de création s’exécute en tant qu’utilisateur·rice actuel·le à l’extérieur du conteneur. À l’intérieur du conteneur, il possède les mêmes UID et GID que l’utilisateur·rice actuel·le, sauf si l’option --user est passée (voir ci-dessous).
--network
-N
Pour les conteneurs, partage l’espace de nom du réseau avec le système hôte. Les conteneurs créés sans cette option n’ont accès qu’à l’interface de boucle locale.
--link-profile
-P
Pour les conteneurs, liez le profil d’environnement à ~/.guix-profile
à l’intérieur du conteneur et définissez GUIX_ENVIRONNEMENT
à cet
endroit. Cela équivaut à faire de ~/.guix-profile un lien symbolique
vers le profil réel à l’intérieur du conteneur. La liaison échouera et
interrompra l’environnement si le répertoire existe déjà, ce qui sera
certainement le cas si guix shell
a été invoqué dans le répertoire
personnel de l’utilisateur·rice.
Certains paquets sont configurés pour chercher des fichiers de configuration et des données dans ~/.guix-profile ; 15 ; --link-profile permet à ces programmes de se comporter comme attendu dans l’environnement.
--user=utilisateur
-u utilisateur
Pour les conteneurs, utilise le nom d’utilisateur utilisateur à la place de l’utilisateur actuel. L’entrée générée dans /etc/passwd dans le conteneur contiendra le nom utilisateur ; le répertoire personnel sera /home/utilisateur ; et aucune donnée GECOS ne sera copiée. En plus, l’UID et le GID dans le conteneur seront 1000. user n’a pas besoin d’exister sur le système.
En plus, tous les chemins partagés ou exposés (voir --share et --expose respectivement) dont la cible est dans le répertoire personnel de l’utilisateur·rice seront remontés relativement à /home/USER ; cela comprend le montage automatique du répertoire de travail actuel.
# exposera les chemins comme /home/toto/wd, /home/toto/test et /home/toto/target cd $HOME/wd guix shell --container --user=toto \ --expose=$HOME/test \ --expose=/tmp/target=$HOME/target
Bien que cela limite la fuite de l’identité de l’utilisateur à travers le chemin du répertoire personnel et des champs de l’utilisateur, ce n’est qu’un composant utile pour une solution d’anonymisation ou de préservation de la vie privée — pas une solution en elle-même.
--no-cwd
Pour les conteneurs, le comportement par défaut est de partager le répertoire de travail actuel avec le conteneur isolé et de passer immédiatement à ce répertoire à l’intérieur du conteneur. Si cela n’est pas souhaitable, --no-cwd fera en sorte que le répertoire de travail courant soit automatiquement partagé not et passera au répertoire personnel de l’utilisateur·rice dans le conteneur à la place. Voir aussi --user.
--expose=source[=cible]
--share=source[=cible]
Pour les conteneurs, --expose (resp. --share) expose le système de fichiers source du système hôte comme un système de fichiers target en lecture seule (resp. en lecture-écriture) dans le conteneur. Si target n’est pas spécifiée, source est utilisé comme point de montage dans le conteneur.
L’exemple ci-dessous crée un REPL Guile dans un conteneur dans lequel le répertoire personnel de l’utilisateur est accessible en lecture-seule via le répertoire /exchange :
guix shell --container --expose=$HOME=/exchange guile -- guile
--symlink=spec
-S spec
Pour les conteneurs, crée le lien symbolique spécifié par la spec, documenté dans pack-symlink-option.
--emulate-fhs
-F
Lorsqu’elle est utilisée avec --container, cette option émule une configuration qui respecte le standard de la hiérarchie des systèmes de fichiers (FHS) dans le conteneur, en fournissant /bin, /lib et d’autres répertoires et fichiers spécifiés par le FHS.
Comme Guix ne respecte pas les spécifications du FHS, cette option configure le conteneur pour mieux reproduire le comportement des autres distributions GNU/Linux. C’est utile pour reproduire d’autres environnements de développement, tester et utiliser des programmes qui s’attendent à ce que les spécifications du FHS soient suivies. Avec cette option, le conteneur inclura une version de glibc qui lira /etc/ld.so.cache dans le conteneur pour trouver le cache des bibliothèques partagées (au contraire de glibc dans l’utilisation normale de Guix) et configurera les répertoires attendu du FHS : /bin, /etc, /lib, /usr à partir du profil du conteneur.
--nesting
-W
When used with --container, provide Guix inside the container and arrange so that it can interact with the build daemon that runs outside the container. This is useful if you want, within your isolated container, to create other containers, as in this sample session:
$ guix shell -CW coreutils [env]$ guix shell -C guile -- guile -c '(display "hello!\n")' hello! [env]$ exit
The session above starts a container with coreutils
programs
available in PATH
. From there, we spawn guix shell
to
create a nested container that provides nothing but Guile.
Another example is evaluating a guix.scm file that is untrusted, as shown here:
guix shell -CW -- guix build -f guix.scm
The guix build
command as executed above can only access the
current directory.
Under the hood, the -W option does several things:
guix
invocations are
visible;
guix
command to the profile in the
container, such that guix describe
returns the same state inside
and outside the container;
guix time-machine
and guix shell
.
--rebuild-cache
¶La plupart du temps, guix shell
met en cache l’environnement pour
que les utilisations suivantes soient instantanées. Les entrées du cache
utilisées le moins récemment sont régulièrement supprimées. Le cache est
aussi invalidé lorsque vous utilisez --file ou --manifest
à chaque fois que le fichier correspondant est modifié.
L’option --rebuild-cache force l’environnement en cache à être
rafraîchi. C’est utile si vous utilisez les options --file ou
--manifest et que les fichiers guix.scm
ou
manifest.scm
ont des dépendances externes, ou si leur comportement
dépend, disons, de variables d’environnements.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le profil de cet environnement, et l’enregistre comme une racine du ramasse-miettes.
C’est utile si vous souhaitez protéger votre environnement du ramasse-miettes, pour le rendre « persistent ».
Lorsque vous n’utilisez pas cette option, guix shell
met en cache
les profils pour les utilisations suivantes du même environnement soient
immédiates — vous pouvez comparer cela à l’utilisation de --root
sauf que guix shell
prend soin de régulièrement supprimer les
racines du ramasse-miettes utilisées le moins récemment.
Dans certains cas, guix shell
ne met pas les profils en cache –
p. ex. si des options de transformations comme --with-latest
sont utilisées. Dans ce cas, l’environnement n’est protégé du
ramasse-miettes que le temps de la session guix shell
. Cela
signifie que la prochaine fois que vous créerez le même environnement, vous
pourriez avoir à reconstruire ou télécharger des paquets.
Voir Invoquer guix gc
, pour en apprendre plus sur les racines du
ramasse-miettes.
En plus, guix shell
prend en charge toutes les options de
construction communes prises en charge par guix build
(voir Options de construction communes) et toutes les options de transformation de
paquets (voir Options de transformation de paquets).
Suivant: Invoquer guix pack
, Précédent: Invoquer guix shell
, Monter: Développement [Table des matières][Index]
guix environment
Le but de guix environment
est de vous aider à créer des
environnements de développement.
Avertissement d’obsolescence : La commande
guix environment
est obsolète et remplacée parguix shell
, qui effectue les même tâches mais est plus pratique à utiliser. Voir Invoquerguix shell
.Étant obsolète,
guix environment
sera supprimée à un moment, mais le projet Guix s’engage à la garder jusqu’au premier mai 2023. Contactez-nous sur guix-devel@gnu.org si vous voulez en parler.
La syntaxe générale est :
guix environment options paquet…
L’exemple suivant crée un nouveau shell préparé pour le développement de GNU Guile :
guix environment guile
Si les dépendances requises ne sont pas déjà construites, guix
environment
les construit automatiquement. L’environnement du nouveau
shell est une version améliorée de l’environnement dans lequel guix
environment
a été lancé. Il contient les chemins de recherche nécessaires
à la construction du paquet donné en plus des variables d’environnement
existantes. Pour créer un environnement « pur », dans lequel les variables
d’environnement de départ ont été nettoyées, utilisez l’option
--pure16.
Sortir d’un environnement Guix est comme sortir du shell, et cela vous
replacera dans l’ancien environnement avant d’avoir invoqué la commande
guix environment
. Au prochain lancement du ramasse-miettes
(voir Invoquer guix gc
), les paquets installés pour l’environnement
seront supprimés et ne seront plus disponibles en dehors de celui-ci.
guix environment
définie la variable GUIX_ENVIRONMENT
dans
le shell qu’il crée ; sa valeur est le nom de fichier du profil de cet
environnement. Cela permet aux utilisatrice·eur·s, disons, de définir un
prompt spécifique pour les environnement de développement dans leur
.bashrc (voir Bash Startup Files dans The GNU Bash Reference
Manual) :
if [ -n "$GUIX_ENVIRONMENT" ] then export PS1="\u@\h \w [dev]\$ " fi
… ou de naviguer dans le profil :
$ ls "$GUIX_ENVIRONMENT/bin"
De surcroît, plus d’un paquet peut être spécifié, auquel cas l’union des entrées des paquets données est utilisée. Par exemple, la commande ci-dessous crée un shell où toutes les dépendances de Guile et Emacs sont disponibles :
guix environment guile emacs
Parfois, une session shell interactive est inutile. On peut invoquer une
commande arbitraire en plaçant le jeton --
pour séparer la commande
du reste des arguments :
guix environment guile -- make -j4
Dans d’autres situations, il est plus pratique de spécifier la liste des
paquets requis dans l’environnement. Par exemple, la commande suivante
lance python
dans un environnement contenant Python 3 et
NumPy :
guix environment --ad-hoc python-numpy python -- python3
En plus, on peut vouloir les dépendance d’un paquet et aussi des paquets supplémentaires qui ne sont pas des dépendances à l’exécution ou à la construction, mais qui sont utiles au développement tout de même. À cause de cela, le tag --ad-hoc est positionnel. Les paquets qui apparaissent avant --ad-hoc sont interprétés comme les paquets dont les dépendances seront ajoutées à l’environnement. Les paquets qui apparaissent après --ad-hoc sont interprétés comme les paquets à ajouter à l’environnement directement. Par exemple, la commande suivante crée un environnement de développement pour Guix avec les paquets Git et strace en plus :
guix environment --pure guix --ad-hoc git strace
Parfois il est souhaitable d’isoler l’environnement le plus possible, pour une pureté et une reproductibilité maximale. En particulier, lorsque vous utilisez Guix sur une distribution hôte qui n’est pas le système Guix, il est souhaitable d’éviter l’accès à /usr/bin et d’autres ressources du système depuis les environnements de développement. Par exemple, la commande suivante crée un REPL Guile dans un « conteneur » où seuls le dépôt et le répertoire de travail actuel sont montés :
guix environment --ad-hoc --container guile -- guile
Remarque : L’option --container requiert Linux-libre 3.19 ou supérieur.
Un autre cas d’usage typique pour les conteneurs est de lancer des
applications sensibles à la sécurité, comme un navigateur web. Pour faire
fonctionner Eolie, nous devons exposer et partager certains fichiers et
répertoires ; nous incluons nss-certs
et exposons
/etc/ssl/certs/ pour l’authentification HTTPS ; enfin, nous
préservons la variable d’environnement DISPLAY
puisque les
applications graphiques conteneurisées ne s’afficheront pas sans elle.
guix environment --preserve='^DISPLAY$' --container --network \ --expose=/etc/machine-id \ --expose=/etc/ssl/certs/ \ --share=$HOME/.local/share/eolie/=$HOME/.local/share/eolie/ \ --ad-hoc eolie nss-certs dbus -- eolie
Les options disponibles sont résumées ci-dessous.
--check
Configure l’environnement et vérifie si le shell écraserait les variables d’environnement. Voir --check, pour plus d’informations.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le profil de cet environnement, et l’enregistre comme une racine du ramasse-miettes.
C’est utile si vous souhaitez protéger votre environnement du ramasse-miettes, pour le rendre « persistent ».
Lorsque cette option est omise, l’environnement n’est protégé du
ramasse-miettes que le temps de la session guix environment
. Cela
signifie que la prochaine fois que vous créerez le même environnement, vous
pourriez avoir à reconstruire ou télécharger des paquets. Voir Invoquer guix gc
, pour plus d’informations sur les racines du GC.
--expression=expr
-e expr
Crée un environnement pour le paquet ou la liste de paquets en lesquels s’évalue expr.
Par exemple, lancer :
guix environment -e '(@ (gnu packages maths) petsc-openmpi)'
démarre un shell avec l’environnement pour cette variante spécifique du paquet PETSc.
Lancer :
guix environment --ad-hoc -e '(@ (gnu) %base-packages)'
démarre un shell où tous les paquets de base du système sont disponibles.
Les commande au-dessus n’utilisent que les sorties par défaut des paquets donnés. Pour choisir d’autres sorties, on peut spécifier des pairs :
guix environment --ad-hoc -e '(list (@ (gnu packages bash) bash) "include")'
--load=fichier
-l fichier
Crée un environnement pour le paquet ou la liste de paquets en lesquels fichier s’évalue.
Par exemple, fichier peut contenir une définition comme celle-ci (voir Définition des paquets) :
(use-modules (guix) (gnu packages gdb) (gnu packages autotools) (gnu packages texinfo)) ;; Augment the package definition of GDB with the build tools ;; needed when developing GDB (and which are not needed when ;; simply installing it.) (package (inherit gdb) (native-inputs (modify-inputs (package-native-inputs gdb) (prepend autoconf-2.69 automake texinfo))))
--manifest=fichier
-m fichier
Crée un environnement pour les paquets contenus dans l’objet manifeste renvoyé par le code Scheme dans fichier. Vous pouvez répéter cette option plusieurs fois, auquel cas les manifestes sont concaténés.
C’est similaire à l’option de même nom de guix package
(voir --manifest) et utilise les même fichiers
manifestes.
Voir guix shell --export-manifest
, pour
des informations sur la « conversion » des options de la ligne de commande
en un manifeste.
--ad-hoc
Inclut tous les paquets spécifiés dans l’environnement qui en résulte, comme si un paquet ad hoc était spécifié, avec ces paquets comme entrées. Cette option est utile pour créer un environnement rapidement sans avoir à écrire une expression de paquet contenant les entrées désirées.
Par exemple la commande :
guix environment --ad-hoc guile guile-sdl -- guile
lance guile
dans un environnement où Guile et Guile-SDDL sont
disponibles.
Remarquez que cet exemple demande implicitement la sortie par défaut de
guile
et guile-sdl
, mais il est possible de demander une
sortie spécifique — p. ex. glib:bin
demande la sortie bin
de glib
(voir Des paquets avec plusieurs résultats).
Cette option peut être composée avec le comportement par défaut de
guix environment
. Les paquets qui apparaissent avant
--ad-hoc sont interprétés comme les paquets dont les dépendances
seront ajoutées à l’environnement, le comportement par défaut. Les paquets
qui apparaissent après --ad-hoc sont interprétés comme les paquets
à ajouter à l’environnement directement.
--profile=profil
-p profil
Crée un environnement contenant les paquets installés dans
profile. Utilisez guix package
(voir Invoquer guix package
) pour créer et gérer les profils.
--pure
Réinitialisation des variables d’environnement existantes lors de la construction du nouvel environnement, sauf celles spécifiées avec l’option --preserve. (voir ci-dessous). Cela a pour effet de créer un environnement dans lequel les chemins de recherche ne contiennent que des entrées de paquets.
--preserve=regexp
-E regexp
Lorsque vous utilisez --pure, préserver les variables d’environnement qui correspondent à regexp — en d’autres termes, cela les met en « liste blanche » de variables d’environnement qui doivent être préservées. Cette option peut être répétée plusieurs fois.
guix environment --pure --preserve=^SLURM --ad-hoc openmpi … \ -- mpirun …
Cet exemple exécute mpirun
dans un contexte où les seules
variables d’environnement définies sont PATH
, les variables
d’environnement dont le nom commence par ‘SLURM’, ainsi que les
variables « importantes » habituelles (HOME
, USER
, etc.).
--search-paths
Affiche les définitions des variables d’environnement qui composent l’environnement.
--system=système
-s système
Essaye de construire pour système — p. ex. i686-linux
.
--container
¶-C
Lance commande dans un conteneur isolé. Le répertoire de travail actuel en dehors du conteneur est monté dans le conteneur. En plus, à moins de le changer avec --user, un répertoire personnel fictif est créé pour correspondre à celui de l’utilisateur·rice actuel·le et /etc/passwd est configuré en conséquence.
Le processus de création s’exécute en tant qu’utilisateur·rice actuel·le à l’extérieur du conteneur. À l’intérieur du conteneur, il possède les mêmes UID et GID que l’utilisateur·rice actuel·le, sauf si l’option --user est passée (voir ci-dessous).
--network
-N
Pour les conteneurs, partage l’espace de nom du réseau avec le système hôte. Les conteneurs créés sans cette option n’ont accès qu’à l’interface de boucle locale.
--link-profile
-P
Pour les conteneurs, liez le profil d’environnement à ~/.guix-profile
à l’intérieur du conteneur et définissez GUIX_ENVIRONNEMENT
à cet
endroit. Cela équivaut à faire de ~/.guix-profile un lien symbolique
vers le profil réel à l’intérieur du conteneur. La liaison échouera et
interrompra l’environnement si le répertoire existe déjà, ce qui sera
certainement le cas si guix environment
a été invoqué dans le
répertoire personnel de l’utilisateur·rice.
Certains paquets sont configurés pour chercher des fichiers de configuration et des données dans ~/.guix-profile ; 17 ; --link-profile permet à ces programmes de se comporter comme attendu dans l’environnement.
--user=utilisateur
-u utilisateur
Pour les conteneurs, utilise le nom d’utilisateur utilisateur à la place de l’utilisateur actuel. L’entrée générée dans /etc/passwd dans le conteneur contiendra le nom utilisateur ; le répertoire personnel sera /home/utilisateur ; et aucune donnée GECOS ne sera copiée. En plus, l’UID et le GID dans le conteneur seront 1000. user n’a pas besoin d’exister sur le système.
En plus, tous les chemins partagés ou exposés (voir --share et --expose respectivement) dont la cible est dans le répertoire personnel de l’utilisateur·rice seront remontés relativement à /home/USER ; cela comprend le montage automatique du répertoire de travail actuel.
# exposera les chemins comme /home/toto/wd, /home/toto/test et /home/toto/target cd $HOME/wd guix environment --container --user=toto \ --expose=$HOME/test \ --expose=/tmp/target=$HOME/target
Bien que cela limite la fuite de l’identité de l’utilisateur à travers le chemin du répertoire personnel et des champs de l’utilisateur, ce n’est qu’un composant utile pour une solution d’anonymisation ou de préservation de la vie privée — pas une solution en elle-même.
--no-cwd
Pour les conteneurs, le comportement par défaut est de partager le répertoire de travail actuel avec le conteneur isolé et de passer immédiatement à ce répertoire à l’intérieur du conteneur. Si cela n’est pas souhaitable, --no-cwd fera en sorte que le répertoire de travail courant soit automatiquement partagé not et passera au répertoire personnel de l’utilisateur·rice dans le conteneur à la place. Voir aussi --user.
--expose=source[=cible]
--share=source[=cible]
Pour les conteneurs, --expose (resp. --share) expose le système de fichiers source du système hôte comme un système de fichiers target en lecture seule (resp. en lecture-écriture) dans le conteneur. Si target n’est pas spécifiée, source est utilisé comme point de montage dans le conteneur.
L’exemple ci-dessous crée un REPL Guile dans un conteneur dans lequel le répertoire personnel de l’utilisateur est accessible en lecture-seule via le répertoire /exchange :
guix environment --container --expose=$HOME=/exchange --ad-hoc guile -- guile
--emulate-fhs
-F
Lorsqu’elle est utilisée avec --container, cette option émule une configuration qui respecte le standard de la hiérarchie des systèmes de fichiers (FHS) dans le conteneur, en fournissant /bin, /lib et d’autres répertoires et fichiers spécifiés par le FHS. Comme Guix ne respecte pas les spécifications du FHS, cette option configure le conteneur pour mieux reproduire le comportement des autres distributions GNU/Linux. C’est utile pour reproduire d’autres environnements de développement, tester et utiliser des programmes qui s’attendent à ce que les spécifications du FHS soient suivies. Avec cette option, le conteneur inclura une version de glibc qui lira /etc/ld.so.cache dans le conteneur pour trouver le cache des bibliothèques partagées (au contraire de glibc dans l’utilisation normale de Guix) et configurera les répertoires attendu du FHS : /bin, /etc, /lib, /usr à partir du profil du conteneur.
En plus, guix environment
prend en charge toutes les options de
construction communes prises en charge par guix build
(voir Options de construction communes) et toutes les options de transformation de
paquets (voir Options de transformation de paquets).
Suivant: La chaîne d’outils GCC, Précédent: Invoquer guix environment
, Monter: Développement [Table des matières][Index]
guix pack
Parfois vous voulez passer un logiciel à des gens qui n’ont pas (encore !)
la chance d’utiliser Guix. Vous leur diriez bien de lancer guix
package -i quelque chose
mais ce n’est pas possible dans ce cas.
C’est là que guix pack
entre en jeu.
Remarque : Si vous cherchez comment échanger des binaires entre des machines où Guix est déjà installé, voir Invoquer
guix copy
, Invoquerguix publish
, et Invoquerguix archive
.
La commande guix pack
crée un pack ou lot de logiciels
: elle crée une archive tar ou un autre type d’archive contenant les
binaires pour le logiciel qui vous intéresse ainsi que ses dépendances.
L’archive qui en résulte peut être utilisée sur toutes les machines qui
n’ont pas Guix et les gens peuvent lancer exactement les mêmes binaires que
ceux que vous avez avec Guix. Le pack lui-même est créé d’une manière
reproductible au bit près, pour que n’importe qui puisse vérifier qu’il
contient bien les résultats que vous prétendez proposer.
Par exemple, pour créer un lot contenant Guile, Emacs, Geiser et toutes leurs dépendances, vous pouvez lancer :
$ guix pack guile emacs emacs-geiser … /gnu/store/…-pack.tar.gz
Le résultat ici est une archive tar contenant un répertoire
/gnu/store avec tous les paquets nécessaires. L’archive qui en
résulte contient un profil avec les trois paquets qui vous intéressent
; le profil est le même qui celui qui aurait été créé avec guix
package -i
. C’est ce mécanisme qui est utilisé pour créer les archives tar
binaires indépendantes de Guix (voir Installation binaire).
Les utilisateurs de ce pack devraient lancer /gnu/store/…-profile/bin/guile pour lancer Guile, ce qui n’est pas très pratique. Pour éviter cela, vous pouvez créer, disons, un lien symbolique /opt/gnu/bin vers le profil :
guix pack -S /opt/gnu/bin=bin guile emacs emacs-geiser
De cette façon, les utilisateurs peuvent joyeusement taper /opt/gnu/bin/guile et profiter.
Et si le destinataire de votre pack n’a pas les privilèges root sur sa
machine, et ne peut donc pas le décompresser dans le système de fichiers
root ? Dans ce cas, vous pourriez utiliser l’option --relocatable
(voir plus bas). Cette option produit des binaires repositionnables,
ce qui signifie qu’ils peuvent être placés n’importe où dans l’arborescence
du système de fichiers : dans l’exemple au-dessus, les utilisateur·rice·s
peuvent décompresser votre archive dans leur répertoire personnel et lancer
directement ./opt/gnu/bin/guile.
Autrement, vous pouvez produire un pack au format d’image Docker avec la commande suivante :
guix pack -f docker -S /bin=bin guile guile-readline
Le résultat est une archive tar qui peut être passée à la commande
docker load
, puis à docker run
:
docker load < file docker run -ti guile-guile-readline /bin/guile
where file is the image returned by guix pack
, and
guile-guile-readline
is its “image tag”. See the
Docker
documentation for more information.
Autrement, vous pouvez produire une image SquashFS avec la commande suivante :
guix pack -f squashfs bash guile emacs emacs-geiser
Le résultat est une image de système de fichiers SquashFS qui peut soit être
montée directement soit être utilisée comme image de conteneur de système de
fichiers avec l’Singularity container
execution environment, avec des commandes comme singularity shell
ou singularity exec
.
Diverses options en ligne de commande vous permettent de personnaliser votre pack :
--format=format
-f format
Produire un pack dans le format donné.
Les formats disponibles sont :
tarball
C’est le format par défaut. Il produit une archive tar contenant tous les binaires et les liens symboliques spécifiés.
docker
This produces a tarball that follows the
Docker Image Specification. By default, the “repository name” as it
appears in the output of the docker images
command is computed
from package names passed on the command line or in the manifest file.
Alternatively, the “repository name” can also be configured via the
--image-tag option. Refer to --help-docker-format for
more information on such advanced options.
squashfs
Cela produit une image SquashFS contenant tous les binaires et liens symboliques spécifiés, ainsi que des points de montages vides pour les systèmes de fichiers virtuels comme procfs.
Remarque : Singularity requiert que vous fournissiez /bin/sh dans l’image. Pour cette raison,
guix pack -f squashfs
implique toujours-S /bin=bin
. Ainsi, votre invocationguix pack
doit toujours commencer par quelque chose comme :guix pack -f squashfs bash …Si vous oubliez le paquet
bash
(ou similaire),singularity run
etsingularity exec
vont échouer avec un message « no such file or directory » peu utile.
deb
¶Cela produit une archive Debian (un paquet avec l’extension ‘.deb’) contenant tous les binaires et les liens symboliques spécifiés, qui peut être installée sur n’importe quelle distribution GNU(/Linux) basée sur dpkg. Vous trouverez des options avancées avec l’option --help-deb-format. Elles permettent d’insérer des fichiers control pour un contrôle plus fin, comme pour activer des trigger ou fournir un script de configuration pour mainteneur pour lancer du code de configuration arbitraire à l’installation.
guix pack -f deb -C xz -S /usr/bin/hello=bin/hello hello
Remarque : Because archives produced with
guix pack
contain a collection of store items and because eachdpkg
package must not have conflicting files, in practice that means you likely won’t be able to install more than one such archive on a given system. You can nonetheless pack as many Guix packages as you want in one such archive.
Attention :
dpkg
prendra possession de tout fichier contenu dans le pack qu’il ne connaît pas. Il est peu avisé d’installer des fichiers ‘.deb’ produits par Guix sur un système où /gnu/store est partagé avec un autre logiciel, comme une installation de Guix ou d’autres packs non deb.
rpm
¶This produces an RPM archive (a package with the ‘.rpm’ file extension)
containing all the specified binaries and symbolic links, that can be
installed on top of any RPM-based GNU/Linux distribution. The RPM format
embeds checksums for every file it contains, which the rpm
command
uses to validate the integrity of the archive.
Advanced RPM-related options are revealed via the --help-rpm-format option. These options allow embedding maintainer scripts that can run before or after the installation of the RPM archive, for example.
The RPM format supports relocatable packages via the --prefix
option of the rpm
command, which can be handy to install an RPM
package to a specific prefix.
guix pack -f rpm -R -C xz -S /usr/bin/hello=bin/hello hello
sudo rpm --install --prefix=/opt /gnu/store/...-hello.rpm
Remarque : Contrary to Debian packages, conflicting but identical files in RPM packages can be installed simultaneously, which means multiple
guix pack
-produced RPM packages can usually be installed side by side without any problem.
Attention :
rpm
assumes ownership of any files contained in the pack, which means it will remove /gnu/store upon uninstalling a Guix-generated RPM package, unless the RPM package was installed with the --prefix option of therpm
command. It is unwise to install Guix-produced ‘.rpm’ packages on a system where /gnu/store is shared by other software, such as a Guix installation or other, non-rpm packs.
--relocatable
-R
Produire des binaires repositionnables — c.-à-d. des binaires que vous pouvez placer n’importe où dans l’arborescence du système de fichiers et les lancer à partir de là.
Lorsque vous passez cette option une fois, les binaires qui en résultent demandent le support des espaces de nom utilisateurs dans le noyau Linux ; lorsque vous la passez deux fois18, les binaires repositionnables utilisent PRoot si les espaces de noms ne sont pas utilisables, et ça fonctionne à peu près partout — voir plus bas pour comprendre les implications.
Par exemple, si vous créez un pack contenant Bash avec :
guix pack -RR -S /mybin=bin bash
… vous pouvez copier ce pack sur une machine qui n’a pas Guix et depuis votre répertoire personnel en tant qu’utilisateur non-privilégié, lancer :
tar xf pack.tar.gz ./mybin/sh
Dans ce shell, si vous tapez ls /gnu/store
, vous remarquerez que
/gnu/store apparaît et contient toutes les dépendances de
bash
, même si la machine n’a pas du tout de /gnu/store ! C’est
sans doute la manière la plus simple de déployer du logiciel construit avec
Guix sur une machine sans Guix.
Remarque : Par défaut ,les binaires repositionnables s’appuient sur les espaces de noms utilisateurs du noyau Linux, qui permet à des utilisateurs non-privilégiés d’effectuer des montages et de changer de racine. Les anciennes versions de Linux ne le supportait pas et certaines distributions GNU/Linux le désactive.
Pour produire des binaires repositionnables qui fonctionnent même sans espace de nom utilisatrice·eur, passez --relocatable ou -R deux fois. Dans ce cas, les binaires testeront la prise en charge des espaces de noms utilisatrice·eur·s et utiliseront PRoot s’ils ne sont pas pris en charge. Les moteurs d’exécution suivants sont pris en charge :
default
Essayez les espaces de noms utilisateur·rice·s et revenez à PRoot si les espaces de noms utilisateur·rice·s ne sont pas pris en charge (voir ci-dessous).
performance
Essayez les espaces de noms utilisateur·rice·s et revenez à Fakechroot si les espaces de noms utilisateur·rice·s ne sont pas pris en charge (voir ci-dessous).
users
Lance le programme à travers les espaces de nom utilisateur·rice et échoue s’ils ne sont pas supportés.
proot
Passez à travers PRoot. Le programme PRoot fournit la prise en charge nécessaire pour la virtualisation du système de fichier. Il y parvient en utilisant l’appel système
ptrace
sur le programme courant. Cette approche a l’avantage de fonctionner sans demander de support spécial de la part du noyau, mais occasionne un coût supplémentaire en temps pour chaque appel système effectué.fakechroot
Passez à travers Fakechroot. Fakechroot virtualise les accès au système de fichier en interceptant les appels vers les fonctions de la bibliothèque C telles que
open
,stat
,exec
, et ainsi de suite. Contrairement à PRoot, il n’engendre que très peu de coûts généraux. Cependant, il ne fonctionne pas encore tout-à-fait : par exemple, certains accès au système de fichier effectués à partir de la bibliothèque C ne sont pas interceptés, et les accès au système de fichier effectués via les appels système directs ne sont pas non plus interceptés, conduisant à un comportement erratique.Lors de l’exécution d’un programme complet, vous pouvez demander explicitement l’un des moteurs d’exécution énumérés ci-dessus en définissant en conséquence la variable d’environnement
GUIX_EXECUTION_ENGINE
.
--entry-point=commande
Utiliser commande comme point d’entrée du paquet résultant, si
le format du paquet le supporte–actuellement docker
et
squashfs
(Singularity) la supportent. command doit être
relatif au profil contenu dans le pack.
Le point d’entrée spécifie la commande que des outils comme docker
run
or singularity run
lancent automatiquement par défaut. Par
exemple, vous pouvez faire :
guix pack -f docker --entry-point=bin/guile guile
Le pack résultant peut être facilement chargé et docker run
sans
arguments supplémentaires engendrera bin/guile
:
docker load -i pack.tar.gz docker run image-id
--entry-point-argument=command
-A command
Use command as an argument to entry point of the resulting
pack. This option is only valid in conjunction with --entry-point
and can appear multiple times on the command line.
guix pack -f docker --entry-point=bin/guile --entry-point-argument="--help" guile
--max-layers=n
Specifies the maximum number of Docker image layers allowed when building an image.
guix pack -f docker --max-layers=100 guile
This option allows you to limit the number of layers in a Docker image. Docker images are comprised of multiple layers, and each layer adds to the overall size and complexity of the image. By setting a maximum number of layers, you can control the following effects:
--expression=expr
-e expr
Considérer le paquet évalué par expr.
Cela a le but identique que l’option de même nom de guix build
(voir --expression
dans guix
build
).
--manifest=fichier
-m fichier
Utiliser les paquets contenus dans l’objet manifeste renvoyé par le code Scheme dans fichier. Vous pouvez répéter cette option plusieurs fois, auquel cas les manifestes sont concaténés.
Elle a un but similaire à l’option de même nom dans guix package
(voir --manifest) et utilise les mêmes
fichiers manifeste. Ils vous permettent de définir une collection de
paquets une fois et de l’utiliser aussi bien pour créer des profils que pour
créer des archives pour des machines qui n’ont pas Guix d’installé.
Remarquez que vous pouvez spécifier soit un fichier manifeste,
soit une liste de paquet, mais pas les deux.
Voir Écrire un manifeste pour des informations sur l’écriture d’un
manifeste. Voir guix shell
--export-manifest
, pour des informations sur la « conversion » des options
de la ligne de commande en un manifeste.
--system=système
-s système
Tenter de construire pour le système — p. ex. i686-linux
—
plutôt que pour le type de système de l’hôte de construction.
--target=triplet
¶Effectuer une compilation croisée pour triplet qui doit être un
triplet GNU valide, comme ""aarch64-linux-gnu""
(voir GNU configuration triplets dans Autoconf).
--compression=outil
-C outil
Compresser l’archive résultante avec outil — l’un des outils parmi
gzip
, zstd
, bzip2
, xz
, lzip
, ou
none
pour aucune compression.
--symlink=spec
-S spec
Ajouter les liens symboliques spécifiés par spec dans le pack. Cette option peut apparaître plusieurs fois.
spec a la forme source=cible
, où source est
le lien symbolique qui sera créé et cible est la cible du lien.
Par exemple, -S /opt/gnu/bin=bin
crée un lien symbolique
/opt/gnu/bin qui pointe vers le sous-répertoire bin du profil.
--save-provenance
Sauvegarder les informations de provenance des paquets passés sur la ligne de commande. Les informations de provenance contiennent l’URL et le commit des canaux utilisés (voir Canaux).
Les informations de provenance sont sauvegardées dans le fichier /gnu/store/…-profile/manifest du pack, avec les métadonnées de paquets habituelles — le nom et la version de chaque paquet, leurs entrées propagées, etc. Ce sont des informations utiles pour le destinataire du pack, qui sait alors comment le pack a (normalement) été obtenu.
Cette option n’est pas activée par défaut car, comme l’horodatage, les informations de provenance ne contribuent en rien au processus de construction. En d’autres termes, il y a une infinité d’URL et d’ID de commit qui permettent d’obtenir le même pack. Enregistrer de telles métadonnées « silencieuses » dans la sortie casse donc éventuellement la propriété de reproductibilité au bit près.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le résultat, et l’enregistre en tant que racine du ramasse-miettes.
--localstatedir
--profile-name=nom
Inclus le « répertoire d’état local », /var/guix, dans le lot qui en
résulte, et notamment le profil
/var/guix/profiles/per-user/root/nom — par défaut nom est
guix-profile
, ce qui correspond à ~root/.guix-profile.
/var/guix contient la base de données du dépôt (voir Le dépôt)
ainsi que les racines du ramasse-miettes (voir Invoquer guix gc
). Le
fournir dans le pack signifie que le dépôt et « complet » et gérable par
Guix ; ne pas le fournir dans le pack signifie que le dépôt est « mort » :
aucun élément ne peut être ajouté ni enlevé après l’extraction du pack.
Un cas d’utilisation est l’archive binaire indépendante de Guix (voir Installation binaire).
--derivation
-d
Affiche le nom de la dérivation que le pack construit.
--bootstrap
Utiliser les programmes d’amorçage pour construire le pack. Cette option n’est utile que pour les personnes qui développent Guix.
En plus, guix pack
supporte toutes les options de construction
communes (voir Options de construction communes) et toutes les options de
transformation de paquets (voir Options de transformation de paquets).
Suivant: Invoquer guix git authenticate
, Précédent: Invoquer guix pack
, Monter: Développement [Table des matières][Index]
Guix offre des paquets de compilateurs individuels comme gcc
mais si
vous avez besoin d’une chaîne de compilation complète pour compiler et lier
du code source, utilisez le paquet gcc-toolchain
. Ce paquet fournit
une chaîne d’outils complète GCC pour le développement C/C++, dont GCC
lui-même, la bibliothèque C de GNU (les en-têtes et les binaires, plus les
symboles de débogage dans la sortie debug
), Binutils et un wrapper
pour l’éditeur de liens.
Le rôle de l’enveloppe est d’inspecter les paramètres -L
et -l
passés à l’éditeur de liens, d’ajouter des arguments -rpath
correspondants et d’invoquer l’actuel éditeur de liens avec ce nouvel
ensemble d’arguments. Vous pouvez dire au wrapper de refuser de lier les
programmes à des bibliothèques en dehors du dépôt en paramétrant la variable
d’environnement GUIX_LD_WRAPPER_ALLOW_IMPURITIES
sur no
.
Le paquet gfortran-toolchain
fournit une chaîne d’outils GCC complète
pour le développement en Fortran. Pour d’autres langages, veuillez utiliser
‘guix search gcc toolchain’ (voir Invoquer guix
package).
Précédent: La chaîne d’outils GCC, Monter: Développement [Table des matières][Index]
guix git authenticate
La commande guix git authenticate
authentifie un checkout Git en
suivant la même règle que pour les canaux (voir channel authentication). C’est-à-dire qu’à partir d’un commit donné, il
s’assure que tous les commit suivants sont signés par une clé OpenPGP dont
l’empreinte digitale apparaît dans le fichier .guix-authorizations de
son ou ses commit(s) parent(s).
Vous allez trouver cette commande utile si vous maintenez un canal. Mais en fait, ce mécanisme d’authentification est utile dans un contexte plus large, Vous pourriez donc vouloir l’utiliser pour des dépôts Git qui n’ont rien à voir avec Guix.
La syntaxe générale est :
guix git authenticate commit signer [options…]
By default, this command authenticates the Git checkout in the current directory; it outputs nothing and exits with exit code zero on success and non-zero on failure. commit above denotes the first commit where authentication takes place, and signer is the OpenPGP fingerprint of public key used to sign commit. Together, they form a channel introduction (voir channel introduction). On your first successful run, the introduction is recorded in the .git/config file of your checkout, allowing you to omit them from subsequent invocations:
guix git authenticate [options…]
Should you have branches that require different introductions, you can
specify them directly in .git/config. For example, if the branch
called personal-fork
has a different introduction than other
branches, you can extend .git/config along these lines:
[guix "authentication-personal-fork"] introduction-commit = cabba936fd807b096b48283debdcddccfea3900d introduction-signer = C0FF EECA BBA9 E6A8 0D1D E643 A2A0 6DF2 A33A 54FA keyring = keyring
The first run also attempts to install pre-push and post-merge hooks, such
that guix git authenticate
is invoked as soon as you run
git push
, git pull
, and related commands; it does not
overwrite preexisting hooks though.
The command-line options described below allow you to fine-tune the process.
--repository=répertoire
-r répertoire
Ouvre le dépôt Git dans directory au lieu du répertoire courant.
--keyring=référence
-k féférence
Chargez le porte-clés OpenPGP à partir de référence, la référence
d’une branche telle que origin/keyring
ou my-keyring
. La
branche doit contenir des clés publiques OpenPGP dans des fichiers
.key, soit sous forme binaire, soit "blindée ASCII". Par défaut, le
porte-clés est chargé à partir de la branche nommée keyring
.
--end=commit
Authenticate revisions up to commit.
--stats
Affiche les statistiques sur les signatures de commits à l’issue de la procédure.
--cache-key=key
Les commits préalablement authentifiés sont mis en cache dans un fichier sous ~/.cache/guix/authentication. Cette option force le cache à être stocké dans le fichier key de ce répertoire.
--historical-authorizations=fichier
Par défaut, tout commit dont le(s) commit(s) parent(s) ne contient(nt) pas le fichier .guix-authorizations est considéré comme non authentique. En revanche, cette option considère les autorisations dans file pour tout commit dont le fichier .guix-authorizations est manquant. Le format de file est le même que celui de .guix-authorizations (au format voir .guix-autorizations).
Suivant: Utilitaires, Précédent: Développement, Monter: GNU Guix [Table des matières][Index]
GNU Guix fournit diverses interface de programmation Scheme (API) qui pour définir, construire et faire des requêtes sur des paquets. La première interface permet aux utilisateurs d’écrire des définitions de paquets de haut-niveau. Ces définitions se réfèrent à des concepts de création de paquets familiers, comme le nom et la version du paquet, son système de construction et ses dépendances. Ces définitions peuvent ensuite être transformées en actions concrètes lors de la construction.
Les actions de construction sont effectuées par le démon Guix, pour le compte des utilisateur·rice·s. Dans un environnement standard, le démon possède les droits en écriture sur le dépôt — le répertoire /gnu/store — mais pas les utilisateur·rice·s. La configuration recommandée permet aussi au démon d’effectuer la construction dans des chroots, à l’adresse des utilisateur·rice·s de construction spécifiques, pour minimiser les interférences avec le reste du système.
Il y a des API de plus bas niveau pour interagir avec le démon et le dépôt. Pour demander au démon d’effectuer une action de construction, les utilisateurs lui donnent en fait une dérivation. Une dérivation est une représentation à bas-niveau des actions de construction à entreprendre et l’environnement dans lequel elles devraient avoir lieu — les dérivations sont aux définitions de paquets ce que l’assembleur est aux programmes C. Le terme de « dérivation » vient du fait que les résultats de la construction en dérivent.
This chapter describes all these APIs in turn, starting from high-level package definitions. Voir Source Tree Structure, for a more general overview of the source code.
guix repl
Suivant: Définition des paquets, Monter: Interface de programmation [Table des matières][Index]
D’un point de vue programmatique, les définitions de paquets de la
distribution GNU sont fournies par des modules Guile dans l’espace de noms
(gnu packages …)
19 (voir Guile modules dans GNU Guile Reference
Manual). Par exemple, le module (gnu packages emacs)
exporte une
variable nommée emacs
, qui est liée à un objet <package>
(voir Définition des paquets).
L’espace de nom (gnu packages …)
est automatiquement scanné par
les outils en ligne de commande. Par exemple, lorsque vous lancez
guix install emacs
, tous les modules (gnu packages …)
sont scannés jusqu’à en trouver un qui exporte un objet de paquet dont le
nom est emacs
. Cette capacité à chercher des paquets est implémentée
dans le module (gnu packages)
.
Les utilisateur·rice·s peuvent stocker les définitions de paquets dans des
modules ayant des noms différents—par exemple, (my-packages
emacs)
20. Il y a deux façons de rendre ces définitions de
paquets visibles pour les interfaces utilisateur·rice :
-L
de guix package
et des autres
commandes (voir Options de construction communes) ou en indiquant la variable
d’environnement GUIX_PACKAGE_PATH
décrite plus bas.
guix pull
pour
qu’il l’utilise. Un canal est en substance un dépôt Git contenant des
modules de paquets. Voir Canaux, pour plus d’informations sur comment
définir et utiliser des canaux.
GUIX_PACKAGE_PATH
fonctionne comme les autres variables de chemins de
recherche :
C’est une liste séparée par des deux-points de répertoires dans lesquels trouver des modules de paquets supplémentaires. Les répertoires listés dans cette variable sont prioritaires par rapport aux paquets de la distribution.
La distribution est entièrement bootstrappée et auto-contenue :
chaque paquet est construit uniquement à partir d’autres paquets de la
distribution. La racine de ce graphe de dépendance est un petit ensemble de
binaires de bootstrap fournis par le module (gnu packages
bootstrap)
. Pour plus d’informations sur le bootstrap,
voir Bootstrapping.
Suivant: Définition de variantes de paquets, Précédent: Modules de paquets, Monter: Interface de programmation [Table des matières][Index]
L’interface de haut-niveau pour les définitions de paquets est implémentée
dans les modules (guix packages)
et (guix build-system)
. Par
exemple, la définition du paquet, ou la recette, du paquet GNU Hello
ressemble à cela :
(define-module (gnu packages hello) #:use-module (guix packages) #:use-module (guix download) #:use-module (guix build-system gnu) #:use-module (guix licenses) #:use-module (gnu packages gawk)) (define-public hello (package (name "hello") (version "2.10") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) (build-system gnu-build-system) (arguments '(#:configure-flags '("--enable-silent-rules"))) (inputs (list gawk)) (synopsis "Hello, GNU world: An example GNU package") (description "Guess what GNU Hello prints!") (home-page "https://www.gnu.org/software/hello/") (license gpl3+)))
Sans être expert·e en Scheme, on peut comprendre la signification des
différents champs présents. Cette expression lie la variable hello
à
un objet <package>
, qui est en substance un enregistrement
(voir Scheme records dans GNU Guile Reference Manual). On
peut inspecter cet objet de paquet avec les procédures qui se trouvent dans
le module (guix packages)
; par exemple, (package-name hello)
renvoie — ô surprise ! — "hello"
.
Avec un peu de chance, vous pourrez importer tout ou partie de la définition
du paquet qui vous intéresse depuis un autre répertoire avec la commande
guix import
(voir Invoquer guix import
).
Dans l’exemple précédent, hello
est défini dans un module à part,
(gnu packages hello)
. Techniquement, cela n’est pas strictement
nécessaire, mais c’est pratique : tous les paquets définis dans des modules
sous (gnu packages …)
sont automatiquement connus des outils en
ligne de commande (voir Modules de paquets).
Il y a quelques points à remarquer dans la définition de paquet précédente :
source
du paquet est un objet <origin>
(voir Référence de origin
, pour la référence complète). Ici, on utilise la méthode
url-fetch
de (guix download)
, ce qui signifie que la source
est un fichier à télécharger par FTP ou HTTP.
Le préfixe mirror://gnu
demande à url-fetch
d’utiliser l’un
des miroirs GNU définis dans (guix download)
.
Le champ sha256
spécifie le hash SHA256 attendu pour le fichier
téléchargé. Il est requis et permet à Guix de vérifier l’intégrité du
fichier. La forme (base32 …)
introduit a représentation en
base32 du hash. Vous pouvez obtenir cette information avec guix
download
(voir Invoquer guix download
) et guix hash
(voir Invoquer guix hash
).
Lorsque cela est requis, la forme origin
peut aussi avec un champ
patches
qui liste les correctifs à appliquer et un champ
snippet
qui donne une expression Scheme pour modifier le code source.
build-system
spécifie la procédure pour construire le paquet
(voir Systèmes de construction). Ici, gnu-build-system
représente le système
de construction GNU familier, où les paquets peuvent être configurés,
construits et installés avec la séquence ./configure && make && make
check && make install
habituelle.
Lorsque vous commencez à empaqueter des logiciels non triviaux, vous pouvez avoir besoin d’outils pour manipuler ces phases de construction, manipuler des fichiers, etc. Voir Utilitaires de construction, pour en savoir plus.
arguments
spécifie des options pour le système de
construction (voir Systèmes de construction). Ici il est interprété par
gnu-build-system
comme une demande de lancer configure avec le
tag --enable-silent-rules.
Que sont ces apostrophes ('
) ? C’est de la syntaxe Scheme pour
introduire une liste ; '
est synonyme de la fonction quote
.
Parfois vous verrez aussi `
(un accent grave synonyme de
quasiquote
) et ,
(une virgule, synonyme de unquote
).
Voir quoting dans GNU Guile Reference Manual, pour
des détails. Ice la valeur du champ arguments
est une liste
d’arguments passés au système de construction plus tard, comme avec
apply
(voir apply
dans GNU Guile
Reference Manual).
La séquence dièse-deux-points (#:
) définie un mot-clef Scheme
(voir Keywords dans GNU Guile Reference Manual), et
#:configure-flags
est un mot-clef utilisé pour passer un argument au
système de construction (voir Coding With Keywords dans GNU Guile
Reference Manual).
inputs
spécifie les entrées du processus de construction —
c.-à-d. les dépendances à la construction ou à l’exécution du paquet.
Ici, nous ajoutons en entrée une référence à la variable gawk
;
gawk
est lui-même lié à un objet <package>
.
Remarquez que GCC, Coreutils, Bash et les autres outils essentiels n’ont pas
besoin d’être spécifiés en tant qu’entrées ici. À la place, le
gnu-build-system
est en mesure de s’assurer qu’ils sont présents
(voir Systèmes de construction).
Cependant, toutes les autres dépendances doivent être spécifiées dans le
champ inputs
. Toute dépendance qui ne serait pas spécifiée ici sera
simplement indisponible pour le processus de construction, ce qui peut mener
à un échec de la construction.
Voir Référence de package
, pour une description complète des champs
possibles.
Pour aller plus loin : Vous vous sentez intimidé·e par le langage Scheme ou vous êtes curieux·se de le découvrir ? Le livre de recettes a une petite section pour démarrer qui résume une partie de ce qui a été montré au-dessus et explique les bases. Voir Cours accéléré du langage Scheme dans le livre de recettes de GNU Guix, pour plus d’information.
Lorsqu’une définition de paquet est en place, le paquet peut enfin être
construit avec l’outil en ligne de commande guix build
(voir Invoquer guix build
), pour résoudre les échecs de construction que
vous pourriez rencontrer (voir Débogage des échecs de construction). Vous pouvez
aisément revenir à la définition du paquet avec la commande guix
edit
(voir Invoquer guix edit
). Voir Consignes d’empaquetage, pour plus
d’informations sur la manière de tester des définitions de paquets et
Invoquer guix lint
, pour des informations sur la manière de vérifier
que la définition respecte les conventions de style.
Enfin, voir Canaux pour des informations sur la manière d’étendre la
distribution en ajoutant vos propres définitions de paquets dans un « canal
».
Finalement, la mise à jour de la définition du paquet à une nouvelle version
amont peut en partie s’automatiser avec la commande guix refresh
(voir Invoquer guix refresh
).
Sous le capot, une dérivation qui correspond à un objet <package>
est
d’abord calculé par la procédure package-derivation
. Cette
dérivation est stockée dans un fichier .drv dans /gnu/store.
Les actions de construction qu’il prescrit peuvent ensuite être réalisées
par la procédure build-derivation
(voir Le dépôt).
Renvoie l’objet <derivation>
du paquet pour le système
(voir Dérivations).
paquet doit être un objet <package>
valide et système une
chaîne indiquant le type de système cible — p. ex. "x86_64-linux"
pour un système GNU x86_64 basé sur Linux. dépôt doit être une
connexion au démon, qui opère sur les dépôt (voir Le dépôt).
De manière identique, il est possible de calculer une dérivation qui effectue une compilation croisée d’un paquet pour un autre système :
Renvoie l’objet <derivation>
du paquet construit depuis
système pour cible.
cible doit être un triplet GNU valide indiquant le matériel cible et
le système d’exploitation, comme "aarch64-linux-gnu"
(voir Specifying Target Triplets dans Autoconf).
Une fois qu’on a une définition de paquet, on peut facilement définir des variantes du paquet. Voir Définition de variantes de paquets, pour plus d’informations.
Suivant: Référence de origin
, Monter: Définition des paquets [Table des matières][Index]
package
Cette section résume toutes les options disponibles dans les déclarations
package
(voir Définition des paquets).
C’est le type de donnée représentant une recette de paquets.
name
Le nom du paquet, comme une chaîne de caractères.
version
La version du paquet, comme une chaine de caractères. Voir Numéros de version, pour un guide.
source
Un objet qui indique comment le code source du paquet devrait être
récupéré. La plupart du temps, c’est un objet origin
qui indique un
fichier récupéré depuis internet (voir Référence de origin
). Il peut aussi
s’agir de tout autre objet « simili-fichier » comme un local-file
qui
indique un fichier du système de fichier local (voir local-file
).
build-system
Le système de construction qui devrait être utilisé pour construire le paquet (voir Systèmes de construction).
arguments
(par défaut : '()
)Les arguments à passer au système de construction (voir Systèmes de construction). C’est une liste qui contient typiquement une séquence de paires de clefs-valeurs, comme dans cet exemple :
(package
(name "exemple")
;; plusieurs champs omis
(arguments
(list #:tests? #f ;passer les tests
#:make-flags #~'("VERBOSE=1") ;passer les arguments à « make »
#:configure-flags #~'("--enable-frobbing"))))
L’ensemble exact des mots-clés pris en charge dépend du système de
construction (voir Systèmes de construction), mais vous trouverez qu’ils prennent
presque tous en compte #:configure-flags
, #:make-flags
,
#:tests?
et #:phases
. Le mot-clé #:phases
en
particulier vous permet de modifier l’ensemble des phases de construction
pour votre paquet (voir Phases de construction).
The REPL has dedicated commands to interactively inspect values of some of these arguments, as a convenient debugging aid (voir Utiliser Guix de manière interactive).
Notes de compatibilité : Until version 1.3.0, the
arguments
field would typically usequote
('
) orquasiquote
(`
) and no G-expressions, like so:(package ;; several fields omitted (arguments ;old-style quoted arguments '(#:tests? #f #:configure-flags '("--enable-frobbing"))))
To convert from that style to the one shown above, you can run
guix style -S arguments package
(voir Invoquerguix style
).
inputs
(par défaut : '()
) ¶native-inputs
(par défaut : '()
)propagated-inputs
(par défaut : '()
)Ces champs listent les dépendances du paquet. Chacune de ces listes est soit un paquet, une origine ou un autre « objet simili-fichier » (voir G-Expressions) ; pour spécifier la sortie de cet objet simili-fichier à utiliser, passez une liste à deux éléments où le second élément est la sortie (voir Des paquets avec plusieurs résultats, pour plus d’informations sur les sorties des paquets). Par exemple, la liste suivante spécifie trois entrées :
(list libffi libunistring `(,glib "bin")) ;la sortie « bin » de GLib
Dans l’exemple au-dessus, on utilise la sortie "out"
de libffi
et de libunistring
.
Notes de compatibilité : Jusqu’à la version 1.3.0, les listes d’entrées étaient des listes de tuples, où chaque tuple a une étiquette pour une entrée (une chaîne de caractères) comme premier élément, un paquet, une origine ou une dérivation comme deuxième élément et éventuellement le nom d’une sortie à utiliser qui est
"out"
par défaut. Par exemple, la liste ci-dessous est équivalente à celle au-dessus, mais utilise l’ancien style d’entrées :;; Ancien style d'entrées (obsolète) `(("libffi" ,libffi) ("libunistring" ,libunistring) ("glib:bin" ,glib "bin")) ;la sortie "bin" de GlibCe style est maintenant obsolète ; il est toujours pris en charge mais la prise en charge sera supprimée dans une future version. Vous ne devriez pas l’utiliser pour de nouvelles définitions de paquets. Voir Invoquer
guix style
, pour apprendre à migrer vers le nouveau style.
La distinction entre native-inputs
et inputs
est nécessaire
lorsqu’on considère la compilation croisée. Lors d’une compilation croisée,
les dépendances listées dans inputs
sont construites pour
l’architecture cible ; inversement, les dépendances listées dans
native-inputs
sont construites pour l’architecture de la machine de
construction.
native-inputs
est typiquement utilisé pour lister les outils requis à
la construction mais pas à l’exécution, comme Autoconf, Automake,
pkg-config, Gettext ou Bison. guix lint
peut rapporter des
erreurs de ce type (voir Invoquer guix lint
).
Enfin, propagated-inputs
est similaire à inputs
, mais les
paquets spécifiés seront automatiquement installés sur les profils
(voir le rôle des profils dans Guix) à côté du paquet auquel
ils appartiennent (voir guix
package
, pour savoir comment guix package
traite les entrées
propagées).
Par exemple, cela est nécessaire lors de l’empaquetage d’une bibliothèque
C/C++ qui a besoin des en-têtes d’une autre bibliothèque pour se compiler,
ou lorsqu’un fichier pkg-config fait référence à un autre via son champ
Requires
.
Un autre exemple où le propagated-inputs
est utile, c’est pour les
langues qui ne disposent pas de la possibilité d’enregistrer le chemin de
recherche à l’exécution comme le RUNPATH
des fichiers ELF ; cela
inclut Guile, Python, Perl, et plus encore. Lors de l’empaquetage de
bibliothèques écrites dans ces langages, assurez-vous qu’elles peuvent
trouver le code de bibliothèque dont elles dépendent au moment de
l’exécution en listant les dépendances d’exécution dans
propagated-inputs
plutôt que inputs
.
outputs
(par défaut : '("out")
)La liste des noms de sorties du paquet. Voir Des paquets avec plusieurs résultats, pour des exemples typiques d’utilisation de sorties supplémentaires.
native-search-paths
(par défaut : '()
)search-paths
(par défaut : '()
)Une liste d’objets search-path-specification
décrivant les variables
d’environnement de recherche de chemins que ce paquet prend en
compte. Voir Chemins de recherche, pour plus de détails sur les spécifications de
chemins de recherche.
Comme pour les entrées, la distinction entre native-search-paths
et
search-paths
n’est importante que pour la compilation croisée. Lors
d’une compilation croisée, native-search-paths
ne s’applique qu’aux
entrées natives alors que search-paths
ne s’applique qu’aux entrées
hôtes.
Les paquets comme les compilateurs croisées font attention aux entrées de la
cible — par exemple notre compilateur GCC croisé (modifié) a
CROSS_C_INCLUDE_PATH
dans search-paths
, ce qui lui permet de
trouver les fichiers .h du système cible et pas ceux des
entrées natives. Pour la plupart des paquets cependant, seul
native-search-paths
a du sens.
replacement
(par défaut : #f
)Ce champ doit être soit #f
soit un objet de paquet qui sera utilisé
comme remplaçant de ce paquet. Voir grafts, pour
plus de détails.
synopsis
Une description sur une ligne du paquet.
description
Une description plus détaillée du paquet, en tant que chaine au format Texinfo.
license
¶La licence du paquet ; une valeur tirée de (guix licenses)
ou une
liste de ces valeurs.
home-page
L’URL de la page d’accueil du paquet, en tant que chaîne de caractères.
supported-systems
(par défaut : %supported-systems
)La liste des systèmes supportés par le paquet, comme des chaînes de
caractères de la forme architecture-noyau
, par exemple
"x86_64-linux"
.
location
(par défaut : emplacement de la source de la forme package
)L’emplacement de la source du paquet. C’est utile de le remplacer lorsqu’on hérite d’un autre paquet, auquel cas ce champ n’est pas automatiquement corrigé.
Lorsque vous l’utilisez dans la portée lexicale du champ d’une définition de paquet, cet identifiant est résolu comme étant le paquet définit.
L’exemple ci-dessous montre l’ajout d’un paquet comme entrée native de lui-même pour la compilation croisée :
(package
(name "guile")
;; ...
;; Lors de la compilation croisée, Guile par exemple dépend
;; d'une version native de lui-même. On l'ajoute ici.
(native-inputs (if (%current-target-system)
(list this-package)
'())))
C’est une erreur que de se référer à this-package
en dehors de la
définition d’un paquet.
Les procédures auxiliaires suivantes vous aideront à utiliser les entrées des paquets.
Cherche name dans les entrées de package (ou les entrées
natives, propagées ou directes). Renvoie l’entrée si elle la trouve, et
#f
sinon.
name est le nom d’un paquet de dépendance. Voici comment vous pouvez l’utiliser :
(use-modules (guix packages) (gnu packages base)) (lookup-package-direct-input coreutils "gmp") ⇒ #<package gmp@6.2.1 …>
Dans cet exemple, on obtient le paquet gmp
qui fait partie des
entrées directes de coreutils
.
Parfois vous voudrez obtenir la liste des entrées requises pour
développer un paquet — toutes les entrées visibles quand le paquet
est compilé. C’est ce que la procédure package-development-inputs
renvoie.
Renvoie la liste des entrées requises par package pour le
développement sur system. Lorsque target est vrai, les entrées
renvoyées sont celles requises pour la compilation croisée de package
de system vers target, où target est un triplet comme
"aarch64-linux-gnu"
.
Remarquez que le résultat inclus à la fois les entrées explicites et
implicites — les entrées ajoutées automatiquement par le système de
construction (voir Systèmes de construction). Prenons le paquet hello
pour
illustrer :
(use-modules (gnu packages base) (guix packages)) hello ⇒ #<package hello@2.10 gnu/packages/base.scm:79 7f585d4f6790> (package-direct-inputs hello) ⇒ () (package-development-inputs hello) ⇒ (("source" …) ("tar" #<package tar@1.32 …>) …)
Dans cet exemple, package-direct-inputs
renvoie la liste vide, parce
que hello
n’a pas de dépendance explicite. À l’inverse,
package-development-inputs
inclut les entrées implicites ajoutées par
gnu-build-system
qui sont requises pour construire hello
:
tar, gzip, GCC, libc, Bash et d’autres. Pour les visualiser, guix
graph hello
montrerait les entrées explicites, alors que guix
graph -t bag hello
inclurait les entrées implicites (voir Invoque guix graph
).
Comme les paquets sont des objets Scheme réguliers qui capturent un graphe de dépendance complet et les procédures de construction associées, il est souvent utile d’écrire des procédures qui prennent un paquet et renvoient une version modifiée de celui-ci en fonction de certains paramètres. En voici quelques exemples.
Renvoie une variante de package qui utilise toolchain au lieu de
la chaîne d’outils GNU C/C++ par défaut. toolchain doit être une
liste d’entrées (tuples label/package) fournissant une fonctionnalité
équivalente, comme le paquet gcc-toolchain
.
L’exemple ci-dessous renvoie une variante du paquet hello
construit
avec GCC 10.x et le reste de la chaîne d’outils GNU (Binutils et la
bibliothèque C GNU) au lieu de la chaîne d’outils par défaut :
(let ((toolchain (specification->package "gcc-toolchain@10")))
(package-with-c-toolchain hello `(("toolchain" ,toolchain))))
La chaîne d’outils de construction fait partie des entrées implicites des paquets— elle n’est généralement pas listée comme faisant partie des différents champs "entrées" et est à la place récupérée par le système de construction. Par conséquent, cette procédure fonctionne en modifiant le système de compilation de paquet de sorte qu’il utilise toolchain au lieu des valeurs par défaut. Systèmes de construction, pour en savoir plus sur les systèmes de construction.
Précédent: Référence de package
, Monter: Définition des paquets [Table des matières][Index]
origin
Cette section documente origins. Une déclaration origin
spécifie les données qui doivent être "produites" – téléchargées,
généralement – et dont le contenu est connu à l’avance. Les origines sont
principalement utilisées pour représenter le code source des paquets
(voir Définition des paquets). Pour cette raison, le formulaire origin
permet de déclarer des correctifs à appliquer au code source original ainsi
que des bribes de code pour le modifier.
C’est le type de donnée qui représente l’origine d’un code source.
uri
Un objet contenant l’URI de la source. Le type d’objet dépend de la
method
(voir plus bas). Par exemple, avec la méthode url-fetch
de (guix download)
, les valeurs valide d’uri
sont : une URL
représentée par une chaîne de caractères, ou une liste de chaînes de
caractères.
method
Une procédure monadique qui gère l’URI donné. La procédure doit accepter au
moins trois arguments : la valeur du champ uri
et l’algorithme de
hachage et la valeur de hachage spécifiée par le champ hash
. Elle
doit renvoyer un élément du dépôt ou une dérivation dans la monade du dépôt
(voir La monade du dépôt) ; la plupart des méthodes renvoient une dérivation
à sortie fixe (voir Dérivations).
Les méthodes couramment utilisées comprennent url-fetch
, qui récupère
les données à partir d’une URL, et git-fetch
, qui récupère les
données à partir d’un dépôt Git (voir ci-dessous).
sha256
Un bytevector contenant le hachage SHA-256 de la source. Cela équivaut à
fournir un content-hash
Objet SHA256 dans le champ hash
décrit
ci-dessous.
hash
L’objet content-hash
de la source–voir ci-dessous pour savoir
comment utiliser content-hash
.
Vous pouvez obtenir cette information avec guix download
(voir Invoquer guix download
) ou guix hash
(voir Invoquer guix hash
).
file-name
(par défaut : #f
)Le nom de fichier à utiliser pour sauvegarder le fichier. Lorsqu’elle est à
#f
, une valeur par défaut raisonnable est utilisée dans la plupart
des cas. Dans le cas où la source est récupérée depuis une URL, le nom de
fichier est celui de l’URL. Pour les sources récupérées depuis un outil de
contrôle de version, il est recommandé de fournir un nom de fichier
explicitement parce que le nom par défaut n’est pas très descriptif.
patches
(par défaut : '()
)Une liste de noms de fichiers, d’origines ou d’objets simili-fichiers (voir file-like objects) qui pointent vers des correctifs à appliquer sur la source.
Cette liste de correctifs doit être inconditionnelle. En particulier, elle
ne peut pas dépendre des valeurs de %current-system
ou
%current-target-system
.
snippet
(par défaut : #f
)Une G-expression (voir G-Expressions) ou une S-expression qui sera lancée dans le répertoire des sources. C’est une manière pratique de modifier la source, parfois plus qu’un correctif.
patch-flags
(par défaut : '("-p1")
)Une liste de drapeaux à passer à la commande patch
.
patch-inputs
(par défaut : #f
)Paquets d’entrées ou dérivations pour le processus de correction.
Lorsqu’elle est à #f
, l’ensemble d’entrées habituellement nécessaire
pour appliquer des correctifs est fournit, comme GNU Patch.
modules
(par défaut : '()
)Une liste de modules Guile qui devraient être chargés pendant le processus
de correction et pendant que le lancement du code du champ snippet
.
patch-guile
(par défaut : #f
)Le paquet Guile à utiliser dans le processus de correction. Lorsqu’elle est
à #f
, une valeur par défaut raisonnable est utilisée.
Construire un objet de hash de contenu pour l’algorithme donné, et
avec valeur comme valeur de hachage. Lorsque algorithme est
omis, on suppose qu’il s’agit de sha256
.
value peut être une chaîne littérale, auquel cas elle est décodée en base32, ou il peut s’agir d’un bytevecteur.
Les options suivantes sont équivalentes :
(content-hash "05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj") (content-hash "05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj" sha256) (content-hash (base32 "05zxkyz9bv3j9h0xyid1rhvh3klhsmrpkf3bcs6frvlgyr2gwilj")) (content-hash (base64 "kkb+RPaP7uyMZmu4eXPVkM4BN8yhRd8BTHLslb6f/Rc=") sha256)
Techniquement, le content-hash
est actuellement mis en œuvre sous
forme de macro. Il effectue des contrôles de bon sens au moment de
l’expansion de la macro, lorsque cela est possible, en s’assurant par
exemple que valeur a la bonne taille pour algorithme.
Comme nous l’avons vu plus haut, la manière dont les données auxquelles une
origine se réfère exactement sont récupérées est déterminée par son champ
method
. Le module (guix download)
fournit la méthode la plus
courante, url-fetch
, décrite ci-dessous.
Renvoie une dérivation à sortie fixe qui récupère les données de url (une chaîne de caractères, ou une liste de chaînes de caractères désignant des URLs alternatives), qui est censée avoir un hash hash de type hash-algo (un symbole). Par défaut, le nom du fichier est le nom de base de l’URL ; en option, nom peut spécifier un nom de fichier différent. Lorsque executable? est vrai, rendez le fichier téléchargé exécutable.
Lorsque l’une des URL commence par mirror://
, sa partie hôte est
alors interprétée comme le nom d’un schéma de miroir, tiré de
%mirror-file.
Alternativement, lorsque l’URL commence par file://
, renvoie le nom
du fichier correspondant dans le dépôt.
De même, le module (guix git-download)
définit la méthode d’origine
git-download
, qui récupère les données d’un dépôt de contrôle de
version Git, et le type de données git-reference
pour décrire le
dépôt et la révision à récupérer.
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<git-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This is a variant of the git-fetch
procedure that supports the Git
LFS (Large File Storage) extension. This may be useful to pull
some binary test data to run the test suite of a package, for example.
Ce type de données représente une référence Git pour le git-fetch
à
récupérer.
url
L’URL du dépôt Git à cloner.
commit
Cette chaîne indique soit le commit à récupérer (une chaîne hexadécimale),
soit le tag à récupérer. Vous pouvez aussi utiliser une chaîne de commit «
courte » ou un identifiant dans le style de git describe
comme
v1.0.1-10-g58d7909c97
.
recursive?
(par défaut : #f
)Ce booléen indique s’il faut aller chercher récursivement les sous-modules de Git.
L’exemple ci-dessous indique la balise v2.10
du dépôt GNU Hello
:
(git-reference
(url "https://git.savannah.gnu.org/git/hello.git")
(commit "v2.10"))
C’est équivalent à la référence ci-dessous, qui nomme explicitement le commit :
(git-reference
(url "https://git.savannah.gnu.org/git/hello.git")
(commit "dc7dc56a00e48fe6f231a58f6537139fe2908fb9"))
Pour les dépôts Mercurial, le module (guix hg-download)
définit la
méthode d’origine hg-download
et le type de données
hg-reference
pour la prise en charge du système de contrôle de
version Mercurial.
Return a fixed-output derivation that fetches ref, a
<hg-reference>
object. The output is expected to have recursive hash
hash of type hash-algo (a symbol). Use name as the file
name, or a generic name if #f
.
This data type represents a Mercurial reference for hg-fetch
to
retrieve.
url
The URL of the Mercurial repository to clone.
changeset
This string denotes changeset to fetch.
For Subversion repositories, the module (guix svn-download)
defines
the svn-fetch
origin method and svn-reference
data type for
support of the Subversion version control system.
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<svn-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This data type represents a Subversion reference for svn-fetch
to
retrieve.
url
The URL of the Subversion repository to clone.
revision
This string denotes revision to fetch specified as a number.
recursive?
(par défaut : #f
)This Boolean indicates whether to recursively fetch Subversion “externals”.
user-name
(default: #f
)The name of an account that has read-access to the repository, if the repository isn’t public.
password
(par défaut : #f
)Password to access the Subversion repository, if required.
For Bazaar repositories, the module (guix bzr-download)
defines the
bzr-fetch
origin method and bzr-reference
data type for
support of the Bazaar version control system.
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<bzr-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This data type represents a Bazaar reference for bzr-fetch
to
retrieve.
url
The URL of the Bazaar repository to clone.
revision
This string denotes revision to fetch specified as a number.
For CVS repositories, the module (guix cvs-download)
defines the
cvs-fetch
origin method and cvs-reference
data type for
support of the Concurrent Versions System (CVS).
Renvoie une dérivation à sortie fixe qui va chercher ref, un objet
<cvs-reference>
. La sortie est censée avoir un hash récursif
hash de type hash-algo (un symbole). Utilisez name comme
nom de fichier, ou un nom générique si #f
.
This data type represents a CVS reference for cvs-fetch
to retrieve.
root-directory
The CVS root directory.
module
Module to fetch.
revision
Revision to fetch.
The example below denotes a version of gnu-standards to fetch:
(cvs-reference
(root-directory ":pserver:anonymous@cvs.savannah.gnu.org:/sources/gnustandards")
(module "gnustandards")
(revision "2020-11-25"))
Suivant: Écrire un manifeste, Précédent: Définition des paquets, Monter: Interface de programmation [Table des matières][Index]
L’une des choses intéressantes avec Guix est qu’à partir d’une définition, on peut facilement dériver des variantes du paquet — pour une version en amont différente, avec des dépendances différentes, des options de compilation différentes, etc. Certains de ces paquets personnalisés peuvent être définis directement par la ligne de commande (voir Options de transformation de paquets). Cette section décrit comment définir des variantes de paquets avec du code. Cela est utile dans les « manifestes » (voir Écrire un manifeste) et dans votre propre collection de paquets (voir Écrire de nouveaux de canaux), entre autres choses !
Comme nous en avons parlé plus tôt, les paquets sont des objets de première
classe dans le langage Scheme. Le module (guix packages)
fournit la
construction package
pour définir de nouveaux objets de paquets
(voir Référence de package
). La manière la plus simple de définir la
variante d’un paquet est d’utiliser le mot-clé inherit
avec
package
. Cela vous permet d’hériter la définition d’un paquet tout
en redéfinissant les champs que vous voulez.
Par exemple, étant donné la variable hello
, qui contient la
définition d’une version récente de GNU Hello, voici comment définir
une variante pour la version 2.2 (publiée en 2006, c’est vintage !) :
(use-modules (gnu packages base)) ;pour 'hello' (define hello-2.2 (package (inherit hello) (version "2.2") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0lappv4slgb5spyqbh6yl5r013zv72yqg2pcl30mginf3wdqd8k9"))))))
L’exemple ci-dessus correspond à ce que font les options de transformation
des paquets --with-version et --with-source. En
substance, hello-2.2
préserve tous les champs de hello
, sauf
version
et source
, qu’il remplace. Remarquez que la variable
hello
originale est toujours là, dans le module (gnu packages
base)
, et n’est pas modifiée. Lorsque vous définissez un paquet
personnalisé comme ceci, vous ajoutez en fait une nouvelle définition
de paquet ; la version originale est toujours disponible.
Vous pouvez aussi bien définir des variantes avec un ensemble de dépendances
différent du paquet d’origine. Par exemple, le paquet gdb
par défaut
dépend de guile
, mais comme c’est une dépendance facultative, vous
pouvez définir une variante qu supprime cette dépendance de cette manière :
(use-modules (gnu packages gdb)) ; pour « gdb » (define gdb-sans-guile (package (inherit gdb) (inputs (modify-inputs (package-inputs gdb) (delete "guile")))))
La forme modify-inputs
ci-dessus supprime le paquet "guile"
du
champ inputs
de gdb
. La macro modify-inputs
est une
macro auxiliaire qui peut être utile si vous voulez supprimer, ajouter et
remplacer des paquets en entrée.
Modifie les entrées de paquet spécifiées, telles que renvoyées par
package-inputs
& co., suivant les clauses données. Chaque clause
doit avoir l’une des formes suivantes :
(delete nom…)
Supprime des entrées les paquets avec les noms donnés (chaines de caractères).
(prepend paquet…)
Ajoute les paquets au début de la liste des entrées.
(append paquet…)
Ajoute les paquets à la fin de la liste des entrées.
(replace name replacement)
Replace the package called name with replacement.
L’exemple suivant supprime les entrées GMP et ACL de Coreutils et ajoute libcap au début de la liste des entrées :
(modify-inputs (package-inputs coreutils)
(delete "gmp" "acl")
(prepend libcap))
L’exemple suivant remplace le paquet guile
des entrées de
guile-redis
avec guile-2.2
:
(modify-inputs (package-inputs guile-redis)
(replace "guile" guile-2.2))
Le dernier type de clause est append
, pour ajouter des entrées à la
fin de la liste.
Dans certains cas, vous pouvez trouver cela utile d’écrire des fonctions («
procédures », pour Scheme) qui renvoie un paquet en fonction de certains
paramètres. Par exemple, considérez la bibliothèque luasocket
pour
le langage de programmation lua. Nous voulons créer des paquets
luasocket
pour les versions majeures de Lua. Une manière de faire
est de définir une procédure qui prend un paquet Lua et renvoie un paquet
luasocket
qui en dépend :
(define (make-lua-socket name lua) ;; Renvoie un paquet luasocket construit avec LUA. (package (name name) (version "3.0") ;; plusieurs champs ont été omis (inputs (list lua)) (synopsis "Socket library for Lua"))) (define-public lua5.1-socket (make-lua-socket "lua5.1-socket" lua-5.1)) (define-public lua5.2-socket (make-lua-socket "lua5.2-socket" lua-5.2))
ici nous avons défini les paquets lua5.1-socket
et
lua5.2-socket
en appelant make-lua-socket
avec différents
arguments. Voir Procedures dans GNU Guile Reference Manual, pour
plus d’informations sur les procédures. Avoir des définitions publiques au
premier niveau pour ces deux paquets signifie qu’ils sont disponibles depuis
la ligne de commande (voir Modules de paquets).
Ce sont des variantes simples de paquets. Par simplicité, le module
(guix transformations)
fournit une interface de haut niveau qui
correspond directement aux options de transformations de paquets plus
sophistiquées (voir Options de transformation de paquets) :
Renvoie une procédure qui, lorsqu’on lui passe un objet à construire (un paquet, une dérivation, etc), applique les transformations spécifiées par opts et renvoie les objets qui en résultent. opts doit être une liste de pairs de symboles et de chaine comme dans :
((with-branch . "guile-gcrypt=master")
(without-tests . "libgcrypt"))
Chaque nom de symbole nomme une transformation et la chaine correspondante est un argument pour cette transformation.
Par exemple, un manifeste équivalent à cette commande :
guix build guix \ --with-branch=guile-gcrypt=master \ --with-debug-info=zlib
... ressemblerait à ceci :
(use-modules (guix transformations)) (define transform ;; La procédure de transformation des paquets. (options->transformation '((with-branch . "guile-gcrypt=master") (with-debug-info . "zlib")))) (packages->manifest (list (transform (specification->package "guix"))))
La procédure options->transformation
est pratique, mais elle n’est
peut-être pas aussi flexible que vous pourriez le souhaiter. Comment
est-elle implémentée ? Le lecteur attentif aura sans doute remarqué que la
plupart des options de transformation des paquets va plus loin que les
changements superficiels montrés dans les premiers exemples de cette
sections : ils font de la réécriture d’entrées, où le graphe de
dépendance d’un paquet est réécrit en remplaçant des entrées spécifiques par
d’autres.
La procédure package-input-rewriting
de (guix packages)
implémente la réécriture du graphe de dépendance, pour remplacer des paquets
dans le graphe.
Renvoie une procédure qui, lorsqu’elle est passée à un paquet, remplace ses dépendances directes et indirectes, y compris les entrées implicites lorsque deep? est vrai, selon replacements. replacements est une liste de paires de paquets ; le premier élément de chaque paire est le paquet à remplacer, et le second est le remplacement.
De manière facultative, nom-réécrit est une procédure à un argument qui prend le nom d’un paquet et renvoie son nouveau nom après l’avoir réécrit.
Regardez cet exemple :
(define libressl-instead-of-openssl ;; Cette procédure remplace OPENSSL par LIBRESSL, ;; récursivement. (package-input-rewriting `((,openssl . ,libressl)))) (define git-with-libressl (libressl-instead-of-openssl git))
Ici nous définissons d’abord une procédure de réécriture qui remplace openssl par libressl. Ensuite nous l’utilisons pour définir une variante du paquet git qui utilise libressl plutôt que openssl. cela est exactement ce que l’option en ligne de commande --with-input fait (voir --with-input).
La variante suivante de package-input-rewriting
peut repérer les
paquets à remplacer par nom à la place de leur identité.
Renvoie une procédure qui, étant donné un paquet, applique les remplacements donnés à tout le graphe du paquet, y compris les entrées implicites, à moins que deep? ne soit faux.
replacements is a list of spec/procedures pair; each spec is a package
specification such as "gcc"
or "guile@2"
, and each procedure
takes a matching package and returns a replacement for that package.
Matching packages that have the hidden?
property set are not
replaced.
L’exemple ci-dessus pourrait être réécrit de cette manière :
(define libressl-instead-of-openssl
;; Remplace tous les paquets nommés « openssl » par LibreSSL.
(package-input-rewriting/spec `(("openssl" . ,(const libressl)))))
Le différence clef est que, cette fois-ci, les paquets correspondent à la
spécification et non à l’identité. En d’autres termes, tout paquet dans le
graphe qui est appelé openssl
sera remplacé.
Une procédure plus générique pour réécrire un graphe de dépendance d’un
paquet est package-mapping
: elle supporte n’importe quel changement
dans les nœuds du graphe.
Renvoie une procédure qui, pour un paquet donné, applique proc à tous les paquets dont il dépend et renvoie le paquet résultant. La procédure arrête la récursion lorsque cut? renvoie true pour un paquet donné. Lorsque deep? est vrai, proc est également appliqué aux entrées implicites.
Tips : Understanding what a variant really looks like can be difficult as one starts combining the tools shown above. There are several ways to inspect a package before attempting to build it that can prove handy:
- You can inspect the package interactively at the REPL, for instance to view its inputs, the code of its build phases, or its configure flags (voir Utiliser Guix de manière interactive).
- When rewriting dependencies,
guix graph
can often help visualize the changes that are made (voir Invoqueguix graph
).
Suivant: Systèmes de construction, Précédent: Définition de variantes de paquets, Monter: Interface de programmation [Table des matières][Index]
Les commandes guix
vous permettent de spécifier des listes de
paquets sur la ligne de commande. C’est pratique, mais quand la ligne de
commande devient longue et moins triviale, il est plus pratique d’avoir la
liste des paquets dans ce que nous appelons un manifeste. Un manifeste
est une sorte de « nomenclature » qui définit un ensemble de
paquets. Typiquement, vous écrirez un bout de code qui construit le
manifeste, vous l’enregistrerez dans un fichier, disons manifest.scm,
puis passerez ce fichier à l’option −m (ou --manifest) que
de nombreuses commandes guix
prennent en charge. Par exemple,
voici ce à quoi un manifeste pour un simple ensemble de paquets peut
ressembler :
;; Manifeste pour trois paquets. (specifications->manifest '("gcc-toolchain" "make" "git"))
Une fois que vous avez le manifeste, vous pouvez le passer, par exemple, à
guix package
pour installer uniquement ces trois paquets dans
votre profil (voir l’option -m de guix
package
) :
guix package -m manifest.scm
... ou vous pouvez le passer à guix shell
(voir l’option -m
de guix shell
) pour créer un environnement
temporaire :
guix shell -m manifest.scm
... ou vous pouvez le passer à guix pack
de la même manière
(voir l’option -m de guix pack
). Vous
pouvez garder un manifeste sous contrôle de version, le partager avec
d’autres personnes pour qu’elles puissent facilement l’installer, etc.
Mais comment écrire votre premier manifeste ? Pour commencer, vous voudrez
peut-être écrire un manifeste qui reflète ce que vous avez déjà dans un
profil. Plutôt que de commencer par une feuille blanche, guix
package
peut générer un manifeste pour vous (voir guix package --export-manifest
) :
# Écrit dans « manifest.scm » un manifeste correspondant au profil # par défaut, ~/.guix-profile. guix package --export-manifest > manifest.scm
Ou vous voudrez peut-être « traduire » des arguments de la ligne de commande
en un manifeste. Dans ce cas, guix shell
peut aider
(voir guix shell --export-manifest
) :
# Écrit un manifeste pour les paquets spécifiés sur la ligne de commande. guix shell --export-manifest gcc-toolchain make git > manifest.scm
Dans les deux cas, l’option --export-manifest essaye de générer un manifeste fidèle ; en particulier, il prend en compte les options de transformation des paquets (voir Options de transformation de paquets).
Remarque : Les manifestes sont symboliques : ils font référence aux paquets des canaux actuellement utilisés (voir Canaux). Dans l’exemple ci-dessus,
gcc-toolchain
peut se référer à la version 11 aujourd’hui, mais pourra se référer à la version 13 dans deux ans.Si vous voulez « épingler » votre environnement logiciel à une version et une variante spécifique d’un paquet, vous devez donner des informations supplémentaires : la liste des révisions des canaux utilisés, renvoyée par
guix describe
. Voir Répliquer Guix, pour plus de détails.
Une fois que vous avez votre premier manifeste, vous voudrez peut-être le personnaliser. Comme votre manifeste est du code, vous avez maintenant accès à toutes les interfaces de programmation de Guix !
Supposons que vous souhaitiez avoir un manifeste pour déployer une variante personnalisée de GDB, le débogueur de GNU, qui ne dépend pas de Guile, avec un autre paquet. En complétant l’exemple vu dans la section précédente (voir Définition de variantes de paquets), vous pouvez écrire un manifeste de ce type :
(use-modules (guix packages) (gnu packages gdb) ;pour « gdb » (gnu packages version-control)) ;pour « git » ;; Définie une variante de GDB qui ne dépend pas de Guile. (define gdb-sans-guile (package (inherit gdb) (inputs (modify-inputs (package-inputs gdb) (delete "guile"))))) ;; Renvoie un manifeste contenant ce paquet plus Git. (packages->manifest (list gdb-sans-guile git))
Remarquez que dans cet exemple, le manifeste se réfère directement aux
variables gdb
et git
, qui sont liées à un objet package
(voir Référence de package
), au lieu d’appeler
specifications->manifest
pour rechercher les paquets par leur nom
comme nous l’avons fait précédemment. La forme use-modules
au début
nous permet d’accéder à l’interface centrale des paquets (voir Définition des paquets) et aux modules qui définissent gdb
et git
(voir Modules de paquets). Nous combinons tout cela harmonieusement — les
possibilités sont infinies, débridez votre créativité !
Le type de données pour les manifestes et les procédures auxiliaires sont
définis dans le module (guix profiles)
, qui est automatiquement
disponible pour le code passé à -m. Voici la documentation de
référence.
Type de données représentant un manifeste.
Il a actuellement un seul champ :
entries
Ce doit être une liste d’enregistrements manifest-entry
— voir plus
bas.
Type de donnée représentant une entrée d’un manifeste. Une entrée de manifeste contient les métadonnées nécessaires : un nom et une chaîne de version, l’objet (généralement un paquet) pour cette entrée, la sortie souhaitée (voir Des paquets avec plusieurs résultats) et un certain nombre d’autres informations facultatives décrites plus bas.
La plupart du temps, vous n’aurez pas à construire une entrée de manifeste
directement ; au lieu de cela, vous passerez un paquet à
package->manifest-entry
, décrit plus bas. Dans certains cas rares
cependant, vous pourriez être amené à créer des entrées de manifeste pour
des objets qui ne sont pas des paquets, comme dans cet exemple :
;; Construit manuellement une entrée de manifeste pour un objet qui n'est pas un paquet. (let ((hello (program-file "hello" #~(display "Hi!")))) (manifest-entry (name "toto") (version "42") (item (computed-file "hello-directory" #~(let ((bin (string-append #$output "/bin"))) (mkdir #$output) (mkdir bin) (symlink #$hello (string-append bin "/hello")))))))
Les champs disponibles sont les suivants :
name
version
Nom et chaine de version pour cette entrée.
item
Un paquet ou n’importe quel objet simili-fichier (voir objets de type fichier).
output
(par défaut : "out"
)Sortie de item
à utiliser, dans le cas où item
a plusieurs
sorties (voir Des paquets avec plusieurs résultats).
dependencies
(par défaut : '()
)Liste des entrées de manifeste desquelles dépend cette entrée. Lorsqu’un profil est construit, les dépendances sont ajoutées au profil.
Généralement, les entrées propagées d’un paquet (voir propagated-inputs
) ont une entrée de manifeste correspondante parmi
les dépendances de l’entrée du paquet.
search-paths
(par défaut : '()
)La liste des spécifications de chemins de recherche que cette entrée prend en compte (voir Chemins de recherche).
properties
(par défaut : '()
)Une liste de pairs de symboles et de valeurs. Lorsqu’un profil est construit, ces propriétés sont sérialisées.
Cela peut être utilisé pour intégrer des métadonnées supplémentaires — p. ex. les transformations appliquées à un paquet (voir Options de transformation de paquets).
parent
(par défaut : (delay #f)
)Une promesse pointant vers l’entrée de manifeste « parente ».
cela est utilisé comme une indication pour fournir du contexte si une erreur
liée à une entrée de manifeste provenant du champ dependencies
doit
être rapportée.
Concatène les manifestes listés dans lst et renvoie le manifeste qui en résulte.
Renvoie une entrée de manifeste pour la sortie du paquet paquet,
où sortie vaut "out"
par défaut, et avec les propriétés
properties données. Par défaut properties est la liste vide ou,
si des transformations de paquets sont appliquées à paquet, une liste
d’association représentant ces transformations, utilisable en tant
qu’argument à options->transformation
(voir options->transformation
).
Le bout de code ci-dessous construit un manifeste avec une entrée pour la
sortie par défaut et la sortie send-email
du paquet git
:
(use-modules (gnu packages version-control)) (manifest (list (package->manifest-entry git) (package->manifest-entry git "send-email")))
Renvoie une liste d’entrées de manifestes, un paquet élément listé dans paquets. Les éléments de paquets peuvent être soit des objets paquets soit des tuples paquet / chaine dénotant une sortie particulière d’un paquet.
Avec cette procédure, le manifeste ci-dessus peut être réécrit de manière plus concise :
(use-modules (gnu packages version-control)) (packages->manifest (list git `(,git "send-email")))
Renvoie un manifeste pour les entrées de développement de paquet pour système, éventuellement pour la compilation croisée vers la cible target. Les entrées de développement comprennent à la fois les entrées explicites et les entrées implicites de paquet.
Comme l’option -D de guix shell
(voir guix shell -D
), le manifeste
qui en résulte décrit l’environnement dans lequel on peut développer le
paquet. Par exemple, si vous voulez configurer un environnement de
développement pour Inkscape, avec Git pour le contrôle de version, vous
pouvez décrire cette « nomenclature » avec le manifeste suivant :
(use-modules (gnu packages inkscape) ;pour « inkscape » (gnu packages version-control)) ;pour « git » (concatenate-manifests (list (package->development-manifest inkscape) (packages->manifest (list git))))
Dans cet exemple, le manifeste de développement qui renvoie
package->development-manifest
inclus le compilateur (GCC), les
nombreuses bibliothèques qui portent le projet (Boost, GLib, GTK, etc) et
quelques outils de développement supplémentaires — ce sont les dépendances
listées par guix show inkscape
.
Enfin, le module (gnu packages)
fournit des fonctions pour construire
des manifestes. En particulier, il vous permet de rechercher des paquets par
leur nom — voir ci-dessous.
Étant données les specs, une liste de spécifications comme
"emacs@25.2"
ou "guile:debug"
, renvoie un manifeste. Les
spécifications ont le même format que celui attendu par les outils en ligne
de commande comme guix install
et guix package
(voir Invoquer guix package
).
Par exemple, elle vous permet de réécrire le manifeste avec Git que nous avons vu plus haut comme ceci :
(specifications->manifest '("git" "git:send-email"))
Remarque que nous n’avons pas à nous soucier de use-modules
,
d’importer le bon ensemble de modules et de se référer aux bonnes
variables. À la place, nous nous référons directement aux paquets de la même
manière que sur la ligne de commande, ce qui peut souvent être plus
pratique.
Suivant: Phases de construction, Précédent: Écrire un manifeste, Monter: Interface de programmation [Table des matières][Index]
Chaque définition de paquet définie un système de construction et des
arguments pour ce système de construction (voir Définition des paquets). Ce
champ build-system
représente la procédure de construction du paquet,
ainsi que des dépendances implicites pour cette procédure de construction.
Les systèmes de construction sont des objets
<build-system>
. L’interface pour les créer et les manipuler est
fournie par le module (guix build-system)
et les systèmes de
construction eux-mêmes sont exportés par des modules spécifiques.
Sous le capot, les systèmes de construction compilent d’abord des objets
paquets en sacs. Un sac est comme un paquet, mais avec moins de
décoration — en d’autres mots, un sac est une représentation à bas-niveau
d’un paquet, qui inclus toutes les entrées de ce paquet, dont certaines ont
été implicitement ajoutées par le système de construction. Cette
représentation intermédiaire est ensuite compilée en une dérivation
(voir Dérivations). Le package-with-c-toolchain
est un exemple
d’une manière de modifier les entrées implicites que le système de
construction d’un paquet récupère (voir package-with-c-toolchain
).
Les systèmes de construction acceptent une liste d’arguments
facultatifs. Dans les définitions de paquets, ils sont passés via le
champ arguments
(voir Définition des paquets). Ce sont typiquement des
arguments par mot-clef (voir keyword arguments in
Guile dans GNU Guile Reference Manual). La valeur de ces arguments est
habituellement évaluée dans la strate de construction — c.-à-d. par
un processus Guile lancé par le démon (voir Dérivations).
Le système de construction principal est le gnu-build-system
qui
implémente les procédures de construction standard pour les paquets GNU et
de nombreux autres. Il est fournit par le module (guix build-system
gnu)
.
gnu-build-system
représente le système de construction GNU et ses
variantes (voir configuration and makefile conventions dans GNU Coding Standards).
En résumé, les paquets qui l’utilisent sont configurés, construits et
installés avec la séquence ./configure && make && make check && make
install
habituelle. En pratique, des étapes supplémentaires sont souvent
requises. Toutes ces étapes sont séparées dans des phases
différentes, Voir Phases de construction pour plus d’informations sur les phases de
construction et comment les personnaliser.
En plus, ce système de construction s’assure que l’environnement « standard
» pour les paquets GNU est disponible. Cela inclus des outils comme GCC,
libc, Coreutils, Bash, Make, Diffutils, grep et sed (voir le module
(guix build-system gnu)
pour une liste complète). Nous les appelons
les entrées implicites d’un paquet parce que la définition du paquet
ne les mentionne pas.
Ce système de construction prend en charge un certain nombre de mot-clés,
qui peuvent être passés via le champ arguments
d’un paquet. Voici
certains des paramètres principaux :
#:phases
Cet argument spécifie le code du côté de la construction qui s’évalue en une liste d’association des phases de construction. Voir Phases de construction, pour plus d’informations.
#:configure-flags
C’est une liste de drapeaux (chaînes) passés au script
configure
. Voir Définition des paquets, pour un exemple.
#:make-flags
Cette liste de chaînes contient les drapeaux passés en argument aux
invocation de make
dans les phases build
, check
et
install
.
#:out-of-source?
Ce booléen, #f
par défaut, indique s’il faut lancer les constructions
dans un répertoire séparé de l’arborescence des sources.
Lorsque la valeur est vraie, la phase configure
crée un répertoire de
construction séparé, se déplace dedans et lance le script configure
à
partir de celui-ci. C’est utile pour les paquets qui en ont besoin, comme
glibc
.
#:tests?
Ce booléen, #t
par défaut, indique si la phase check
doit
lancer la suite de tests du paquet.
#:test-target
Cette chaîne, "check"
par défaut, donne le nom de la cible du
makefile à utiliser dans la phase check
.
#:parallel-build?
#:parallel-tests?
Ces booléens spécifient s’il faut construire, respectivement lancer la suite
de tests, en parallèle, avec le drapeau -j
de make
. Lorsque
la valeur est vraie, make
reçoit -jn
, où n est le
nombre spécifié dans l’option --cores de guix-daemon
ou
celle de la commande du client guix
(voir --cores).
#:validate-runpath?
Ce booléen, #t
par défaut, détermine s’il faut « valider » le
RUNPATH
des binaires ELF (les bibliothèques partagées .so
et
les exécutables) installés précédemment par la phase
install
. Voir la phase
validate-runpath
, pour plus de détails.
#:substitutable?
Ce booléen, #t
par défaut, indique si les sorties du paquet peuvent
être substituées — c.-à-d. si les utilisateur·rices peuvent obtenir des
substituts au lieu de les construire localement (voir Substituts).
#:allowed-references
#:disallowed-references
Lorsque la valeur est vraie, ces arguments doivent être une liste de dépendance qui ne doivent pas apparaître dans les dépendances des résultats de la construction. Si, à la fin de la construction, certaines de ces références sont retenues, le processus échoue.
C’est utile pour s’assurer qu’un paquet ne garde pas une référence par
erreur à ses entrées de construction, sis cela augmente par exemple la
taille de sa clôture (voir Invoquer guix size
).
La plupart des autres systèmes de construction prennent en charge ces mot-clés.
D’autres objets <build-system>
sont définis pour supporter d’autres
conventions et outils utilisés par les paquets de logiciels libres. Ils
héritent de la plupart de gnu-build-system
et diffèrent surtout dans
l’ensemble des entrées implicites ajoutées au processus de construction et
dans la liste des phases exécutées. Certains de ces systèmes de
construction sont listés ci-dessous.
This variable is exported by (guix build-system agda)
. It implements
a build procedure for Agda libraries.
It adds agda
to the set of inputs. A different Agda can be specified
with the #:agda
key.
The #:plan
key is a list of cons cells (regexp
. parameters)
, where regexp is a regexp that should match the
.agda
files to build, and parameters is an optional list of
parameters that will be passed to agda
when type-checking it.
When the library uses Haskell to generate a file containing all imports, the
convenience #:gnu-and-haskell?
can be set to #t
to add
ghc
and the standard inputs of gnu-build-system
to the input
list. You will still need to manually add a phase or tweak the
'build
phase, as in the definition of agda-stdlib
.
Cette variable est exportée par (guix build-system ant)
. Elle
implémente la procédure de construction pour les paquets Java qui peuvent
être construits avec l’outil de construction
Ant.
Elle ajoute à la fois ant
et the kit de développement Java
(JDK) fournit par le paquet icedtea
à l’ensemble des entrées. Des
paquets différents peuvent être spécifiés avec les paramètres #:ant
et #:jdk
respectivement.
Lorsque le paquet d’origine ne fournit pas de fichier de construction Ant
acceptable, le paramètre #:jar-name
peut être utilisé pour générer un
fichier de construction Ant build.xml minimal, avec des tâches pour
construire l’archive jar spécifiée. Dans ce cas, le paramètre
#:source-dir
peut être utilisé pour spécifier le sous-répertoire des
sources, par défaut « src ».
Le paramètre #:main-class
peut être utilisé avec le fichier de
construction minimal pour spécifier la classe principale du jar. Cela rend
le fichier jar exécutable. Le paramètre #:test-include
peut être
utilisé pour spécifier la liste des tests junits à lancer. Il vaut par
défaut (list "**/*Test.java")
. Le paramètre #:test-exclude
peut être utilisé pour désactiver certains tests. Sa valeur par défaut est
(list "**/Abstract*.java")
, parce que les classes abstraites ne
peuvent pas être utilisées comme des tests.
Le paramètre #:build-target
peut être utilisé pour spécifier la tâche
Ant qui devrait être lancée pendant la phase build
. Par défaut la
tâche « jar » sera lancée.
Cette variable est exportée par (guix build-system android-ndk)
.
Elle implémente une procédure de construction pour les paquets du NDK
Android (native development kit) avec des processus de construction
spécifiques à Guix.
Le système de compilation suppose que les paquets installent leurs fichiers
d’interface publique (en-tête) dans le sous-répertoire include de la
sortie out
et leurs bibliothèques dans le sous-répertoire lib
de la sortie out
.
Il est aussi supposé que l’union de toutes les dépendances d’un paquet n’a pas de fichiers en conflit.
Pour l’instant, la compilation croisée n’est pas supportées — donc pour l’instant les bibliothèques et les fichiers d’en-têtes sont supposés être des outils de l’hôte.
Ces variables, exportées par (guix build-system asdf)
, implémentent
les procédures de constructions pour les paquets en Common Lisp qui
utilisent « ASDF ». ASDF est
un dispositif de définition de systèmes pour les programmes et les
bibliothèques en Common Lisp.
Le système asdf-build-system/source
installe les paquets au format
source qui peuvent être chargés avec n’importe quelle implémentation de
common lisp, via ASDF. Les autres, comme asdf-build-system/sbcl
,
installent des binaires au format qu’un implémentation particulière
comprend. Ces systèmes de constructions peuvent aussi être utilisés pour
produire des programmes exécutables ou des images lisp qui contiennent un
ensemble de paquets pré-chargés.
Le système de construction utilise des conventions de nommage. Pour les
paquets binaires, le nom du paquet devrait être préfixé par l’implémentation
lisp, comme sbcl-
pour asdf-build-system/sbcl
.
En plus, le paquet source correspondant devrait étiquetté avec la même
convention que les paquets Python (voir Modules Python), avec le préfixe
cl-
.
Pour créer des programmes exécutables et des images, les procédures côté
construction build-program
et build-image
peuvent être
utilisées. Elles devraient être appelées dans une phase de construction
après la phase create-asdf-configuration
pour que le système qui
vient d’être construit puisse être utilisé dans l’image créée.
build-program
requiert une liste d’expressions Common Lisp dans
l’argument #:entry-program
.
Par défaut, tous les fichiers .asd présents dans les sources sont lus
pour trouver les définitions du système. Le paramètre #:asd-file
peut
être utilisé pour préciser la liste des fichiers .asd à lire. En
outre, si le paquet définit un système pour ses tests dans un fichier
séparé, il sera chargé avant l’exécution des tests s’il est spécifié par le
paramètre #:test-asd-file
. S’il n’est pas défini, les fichiers
<system>-tests.asd
, <system>-test.asd
, tests.asd
et
test.asd
seront essayés s’ils existent.
Si pour quelque raison que ce soit le paquet doit être nommé d’une manière
différente de ce que la convention de nommage suggère, ou si plusieurs
systèmes doivent être compilés, le paramètre #:asd-systems
peut être
utilisé pour spécifier la liste des noms de systèmes.
Cette variable est exportée par (guix build-system cargo)
. Elle
supporte les construction de paquets avec Cargo, le système de construction
du langage de programmation Rust.
Cela ajoute rustc
et cargo
à l’ensemble des entrées. Un autre
paquet Rust peut être spécifié avec le paramètre #:rust
.
Les dépendances régulières de cargo doivent être ajoutées à la définition du
paquet comme avec les autres paquets ; celles qui ne sont requises qu’à la
construction dans « native-inputs », les autres dans « inputs ». Si vous
devez ajouter des crates sources alors vous devez les ajouter via le
paramètre #:cargo-inputs
sous la forme d’une liste de paires de noms
et de spécifications, où la spécification peut être un paquet ou une
définition de source. Notez que la spécification doit évaluer un chemin
vers une arhive gzippée qui inclut un fichier Cargo.toml
à sa racine,
sinon elle sera ignorée. De même, les dépendances de développement de cargo
doivent être ajoutées à la définition du paquet via le paramètre
#:cargo-development-inputs
.
Dans sa phase configure
, ce système de construction mettra à
disposition de cargo toutes les entrées sources spécifiées dans les
paramètres #:cargo-inputs
et #:cargo-development-inputs
. Il
supprimera également un fichier Cargo.lock
inclus, qui sera recréé
par cargo
pendant la phase build
. La phase package
lancera cargo package
pour créer un crate source réutilisable plus
tard. La phase install
installe les binaires définis par le crate. À
moins de définir install-source? #f
elle installera aussi un crate
source et les sources décompressées pour faciliter le travail avec les
paquets rust.
Cette variable est exportée par (guix build-system chicken)
. Elle
construit des modules CHICKEN Scheme, aussi
appelés « eggs » ou « extensions ». CHICKEN génère du code source C, qui est
ensuite compilé par un compilateur C, dans ce cas GCC.
Ce système de construction ajoute chicken
aux entrées du paquet, en
plus des paquets de gnu-build-system
.
Le système de construction ne peut pas (encore) déterminer le nom de l’egg
automatiquement, donc comme avec le go-build-system
et son
#:import-path
, vous devriez définir #:egg-name
dans le champ
arguments
du paquet.
Par exemple, si vous créez un paquet pour l’egg srfi-1
:
(arguments '(#:egg-name "srfi-1"))
Les dépendances des egg doivent être définies dans propagated-inputs
,
pas inputs
parce que CHICKEN n’inclut pas de références absolues dans
les eggs compilés. Les dépendances des tests doivent aller dans
native-inputs
, comme d’habitude.
Cette variable est exportée par (guix build-system copy)
. Il prend
en charge la construction de paquets simples qui ne nécessitent pas beaucoup
de compilation, la plupart du temps juste le déplacement de fichiers.
Cela ajoute une grande partie des paquets gnu-build-system
à
l’ensemble des entrées. De ce fait, le copy-build-system
n’a pas
besoin de tout le code passe-partout souvent nécessaire pour le
trivial-build-system
.
Pour simplifier davantage le processus d’installation des fichiers, un
argument #:install-plan
est exposé pour permettre au packager de
spécifier quels fichiers vont où. Le plan d’installation est une liste de
(source cible [filtres])
. Les filtres sont
facultatifs.
#:include
, #:include-regexp
, #:exclude
,
#:exclude-regexp
, seuls les fichiers sélectionnés sont installés en
fonction des filtres. Chaque filtre est spécifié par une liste de chaînes
de caractères.
#:include
, installez tous les fichiers dont le suffixe de chemin correspond
au moins un des éléments dans la liste donnée.
#:include-regexp
, installez tous les fichiers que le
les sous-chemins correspondent à au moins une des expressions régulières de
la liste donnée.
#:exclude
et #:exclude-regexp
sont le complément de leur homologue pour l’inclusion. Sans les drapeaux
#:include
, installez tous les fichiers sauf ceux qui correspondent
aux filtres d’exclusion. Si les inclusions et les exclusions sont toutes
deux spécifiées, les exclusions sont faites en complément des inclusions.
#:output
argument
can be used to specify which output label the files should be installed to.
Dans tous les cas, les chemins relatifs à source sont préservés dans cible.
Exemples :
("toto/titi" "share/mon-app/")
: Installer titi sur share/mon-app/titi.
("toto/titi" "share/mon-app/tata")
: Installer titi sur share/mon-app/tata.
("toto/" "share/mon-app")
: Installez le contenu de toto dans share/mon-app,
par exemple, installe toto/sub/file dans
share/mon-app/sub/file.
("toto/" "share/mon-app" #:include ("sub/file"))
: Installe seulement toto/sub/file vers
share/mon-app/sub/file.
("toto/sub" "share/mon-app" #:include ("file"))
: Installe toto/sub/file vers
share/mon-app/file.
("foo/doc" "share/my-app/doc" #:output "doc")
: Install
"foo/doc" to "share/my-app/doc" within the "doc"
output.
This variable is exported by (guix build-system vim)
. It is an
extension of the copy-build-system
, installing Vim and Neovim plugins
into locations where these two text editors know to find their plugins,
using their packpaths.
Packages which are prefixed with vim-
will be installed in Vim’s
packpath, while those prefixed with neovim-
will be installed in
Neovim’s packpath. If there is a doc
directory with the plugin then
helptags will be generated automatically.
There are a couple of keywords added with the vim-build-system
:
plugin-name
it is possible to set the name of the plugin.
While by default this is set to the name and version of the package, it is
often more helpful to set this to name which the upstream author calls their
plugin. This is the name used for :packadd
from inside Vim.
install-plan
it is possible to augment the built-in
install-plan of the vim-build-system
. This is particularly helpful
if you have files which should be installed in other locations. For more
information about using the install-plan
, see the
copy-build-system
(voir copy-build-system
).
#:vim
it is possible to add this package to Vim’s packpath,
in addition to if it is added automatically because of the vim-
prefix in the package’s name.
#:neovim
it is possible to add this package to Neovim’s
packpath, in addition to if it is added automatically because of the
neovim-
prefix in the package’s name.
#:mode
it is possible to adjust the path which the plugin is
installed into. By default the plugin is installed into start
and
other options are available, including opt
. Adding a plugin into
opt
will mean you will need to run, for example, :packadd
foo
to load the foo
plugin from inside of Vim.
Cette variable est exportée par (guix build-system clojure)
. Elle
implémente une procédure de construction des paquets simple qui utilise le
bon vieux compile
de Clojure. La compilation croisée n’est pas
encore supportée.
Elle ajoute clojure
, icedtea
et zip
à l’ensemble des
entrées. Des paquets différents peuvent être spécifiés avec les paramètres
#:clojure
, #:jdk
et #:zip
.
Une liste de répertoires sources, de répertoires de tests et de noms de jar
peuvent être spécifiés avec les paramètres #:source-dirs
,
#:test-dirs
et #:jar-names
. Le répertoire de construction est
la classe principale peuvent être spécifiés avec les paramètres
#:compile-dir
et #:main-class
. Les autres paramètres sont
documentés plus bas.
Ce système de construction est une extension de ant-build-system
,
mais avec les phases suivantes modifiées :
build
Cette phase appelle compile
en Clojure pour compiler les fichiers
sources et lance jar
pour créer les fichiers jar à partir des
fichiers sources et des fichiers compilés en suivant la liste d’inclusion et
d’exclusion spécifiées dans #:aot-include
et #:aot-exclude
.
La liste d’exclusion a la priorité sur la liste d’inclusion. Ces listes
consistent en des symboles représentant des bibliothèque Clojure ou le mot
clef spécial #:all
, représentant toutes les bibliothèques Clojure
trouvées dans les répertoires des sources. Le paramètre
#:omit-source?
décide si les sources devraient être incluses dans les
fichiers jar.
check
Cette phase lance les tests en suivant les liste d’inclusion et d’exclusion
spécifiées dans #:test-include
et #:test-exclude
. Leur
signification est analogue à celle de #:aot-include
et
#:aot-exclude
, sauf que le mot-clef spécial #:all
signifie
maintenant toutes les bibliothèques Clojure trouvées dans les répertoires de
tests. Le paramètre #:tests?
décide si les tests devraient être
lancés.
install
Cette phase installe tous les fichiers jar précédemment construits.
En dehors de cela, le système de construction contient aussi la phase suivante :
install-doc
Cette phase installe tous les fichiers dans le répertoire de plus haut
niveau dont le nom correspond à %doc-regex
. On peut spécifier une
regex différente avec le paramètre #:doc-regex
. Tous les fichiers
(récursivement) dans les répertoires de documentations spécifiés dans
#:doc-dirs
sont aussi installés.
Cette variable est exportée par (guix build-system cmake)
. Elle
implémente la procédure de construction des paquets qui utilisent
l’outil de construction CMake.
Elle ajoute automatiquement le paquet cmake
à l’ensemble des
entrées. Le paquet utilisé peut être spécifié par le paramètre
#:cmake
.
Le paramètre #:configure-flags
est pris comme une liste de drapeaux à
passer à la commande cmake
. Le paramètre #:build-type
spécifie en termes abstrait les drapeaux passés au compilateur ; sa valeur
par défaut est "RelWithDebInfo"
(ce qui veut dire « mode public avec
les informations de débogage » en plus court), ce qui signifie en gros que
le code sera compilé avec -O2 -g
comme pour les paquets autoconf par
défaut.
This variable is exported by (guix build-system composer)
. It
implements the build procedure for packages using
Composer, the PHP package manager.
It automatically adds the php
package to the set of inputs. Which
package is used can be specified with the #:php
parameter.
The #:test-target
parameter is used to control which script is run
for the tests. By default, the test
script is run if it exists. If
the script does not exist, the build system will run phpunit
from the
source directory, assuming there is a phpunit.xml file.
Cette variable est exportée par (guix build-system dune)
. Elle prend
en charge la construction des paquets qui utilisent
Dune, un outil de construction pour le langage
de programmation OCaml. Elle est implémentée comme une extension de
ocaml-build-system
décrit plus bas. En tant que tel, les paramètres
#:ocaml
et #:findlib
peuvent être passés à ce système de
construction.
Elle ajoute automatiquement le paquet dune
à l’ensemble des entrées.
Le paquet utilisé peut être spécifié par le paramètre #:dune
.
Il n’y a pas de phase configure
parce que les paquets dune n’ont
habituellement pas besoin d’être configurés. Le paramètre
#:build-flags
est interprété comme une liste de drapeaux pour la
commande dune
pendant la construction.
Le paramètre #:jbuild?
peut être passé pour utiliser la commande
jbuild
à la place de la commande dune
plus récente pour la
construction d’un paquet. Sa valeur par défaut est #f
.
Le paramètre #:package
peut être passé pour spécifié un nom de
paquet, ce qui est utile lorsqu’un paquet contient plusieurs paquets et que
vous voulez n’en construire qu’un. C’est équivalent à passer l’argument
-p
à dune
.
Cette variable est exportée par (guix build-system elm)
. Elle
implémente une procédure de construction pour les paquets
Elm qui ressemble à ‘elm install’.
Le système de construction ajoute un paquet qui contient le compilateur Elm
à l’ensemble des entrées. Le paquet de compilateur par défaut (actuellement
elm-sans-reactor
) peut être remplacé avec l’argument #:elm
. En
plus, les paquets Elm requis par le système de construction lui-même sont
ajoutés en tant qu’entrées implicites s’ils ne sont pas déjà présents : pour
supprimer ce comportement, utilisez l’argument
#:implicit-elm-package-inputs?
qui est surtout utile pour
l’armorçage.
Les "dependencies"
et "test-dependencies"
du fichier
elm.json d’un paquet Elm correspondent à propagated-inputs
et
inputs
, respectivement.
Elm a besoin d’une structure particulière pour les noms des paquets :
voir Paquets elm pour plus de détails, en particulier sur les outils
fournis par (guix build-system elm)
.
Il y a actuellement quelques limites notables à elm-build-system
:
{ "type": "package"}
dans
leur fichier elm.json. Utiliser elm-build-system
pour
construire des applications Elm (qui déclarent { "type":
"application" }
est possible, mais nécessite des modifications ad-hoc des
phases de construction. Par exemple, voir les définitions de l’application
d’exemple elm-todomvc
et du paquet elm
lui-même (parce que
l’interface de la commande ‘elm reactor’ est une application Elm).
ELM_HOME
, mais cela ne fonctionne pas encore bien avec
elm-build-system
. Cette limite affecte principalement les
applications Elm, parce qu’elles spécifient les versions exactes de leurs
dépendances, alors que les paquets Elm spécifient des intervalles de
versions prises en charge. Pour contourner le problème, les applications
d’exemple mentionnées plus haut utilisent la procédure
patch-application-dependencies
fournie par (guix build
elm-build-system)
pour réécrire leur fichier elm.json pour qu’ils se
réfèrent aux versions effectivement présentes dans l’environnement de
construction. Autrement, les transformations des paquets Guix
(voir Définition de variantes de paquets) peuvent aussi réécrire tout le graphe de
dépendance d’une application.
elm-test-rs
ni
l’exécuteur elm-test
basé sur Node.js ne sont empaquetés dans Guix.
Cette variable est exportée par (guix build-system go)
. Elle
implémente la procédure pour les paquets Go utilisant les
mécanismes de construction Go standard.
L’utilisateur doit fournir une valeur à la clef #:import-path
et,
dans certains cas, #:unpack-path
. Le
chemin d’import
correspond au chemin dans le système de fichiers attendu par le script de
construction du paquet et les paquets qui s’y réfèrent et fournit une
manière unique de se référer à un paquet Go. Il est typiquement basé sur
une combinaison de l’URI du code source du paquet et d’une structure
hiérarchique du système de fichier. Dans certains cas, vous devrez extraire
le code source du paquet dans une structure de répertoires différente que
celle indiquée par le chemin d’import et #:unpack-path
devrait être
utilisé dans ces cas-là.
Les paquets qui fournissent des bibliothèques Go devraient installer leur
code source dans la sortie du paquet. La clef #:install-source?
, qui
vaut #t
par défaut, contrôle l’installation du code source. Elle
peut être mise à #f
pour les paquets qui ne fournissent que des
fichiers exécutables.
Vous pouvez effectuer une compilation croisée des paquets et si vous voulez
une architecture ou un système d’exploitation spécifique alors vous pouvez
utiliser les mot-clés #:goarch
et #:goos
pour forcer le paquet
à être construit pour l’architecture et le système d’exploitation
donnés. Vous trouverez les combinaisons connues pour Go
dans leur
documentation.
Vous pouvez utiliser le mot-clé #:go
pour spécifier le paquet du
compilateur Go avec lequel construire le paquet.
Cette variable est exportée par (guix build-system glib-or-gtk)
.
Elle est conçue pour être utilisée par des paquets qui utilisent GLib ou
GTK+.
Ce système de construction ajoute les deux phases suivantes à celles
définies par gnu-build-system
:
glib-or-gtk-wrap
La phase glib-or-gtk-wrap
garantit que les programmes dans
bin/ sont capables de trouver les « schémas » GLib et
GTK+
modules. Cela est réalisé en enveloppant les programmes dans des scripts
de lancement qui définissent de manière appropriée les variables
d’environnement XDG_DATA_DIRS
et GTK_PATH
.
Il est possible d’exclure des sorties spécifiques de ce processus
d’enveloppage en listant leur nom dans le paramètre
#:glib-or-gtk-wrap-excluded-outputs
. C’est utile lorsqu’une sortie
est connue pour ne pas contenir de binaires GLib ou GTK+, et où l’enveloppe
ajouterait une dépendance inutile vers GLib et GTK+.
glib-or-gtk-compile-schemas
La phase glib-or-gtk-compile-schemas
s’assure que tous les
schémas GSettings de GLib sont compilés. La compilation est effectuée par
le programme glib-compile-schemas
. Il est fournit par le paquet
glib:bin
qui est automatiquement importé par le système de
construction. Le paquet glib
qui fournit
glib-compile-schemas
peut être spécifié avec le paramètre
#:glib
.
Ces deux phases sont exécutées après la phase install
.
Ce système de construction sert aux paquets Guile qui consistent
exclusivement en code Scheme et qui sont si simple qu’ils n’ont même pas un
makefile, sans parler d’un script configure. Il compile le code
Scheme en utilisant guild compile
(voir Compilation dans GNU Guile Reference Manual) et installe les fichiers .scm et
.go aux bons emplacements. Il installe aussi la documentation.
Ce système de construction supporte la compilation croisée en utilisant
l’option --target de guild compile
.
Les paquets construits avec guile-build-system
doivent fournir un
paquet Guile dans leur champ native-inputs
.
Cette variable est exportée par (guix build-system julia)
. Elle
implémente la procédure de compilation utilisée par les paquets
julia, qui est globalement similaire à
l’exécution de ‘julia -e 'using Pkg ; Pkg.add(package)'’ dans un
environnement où JULIA_LOAD_PATH
contient les chemins de toutes les
entrées des paquets Julia. Les tests sont effectués en appelant
/test/runtests.jl
.
Le nom et l’uuid du paquet Julia est lu dans le fichier
Project.toml. Ces valeurs peuvent être remplacées en passant
l’argument #:julia-package-name
(le nom doit être correctement
capitalisé) ou #:julia-package-uuid
.
Les paquets Julia gèrent généralement leurs dépendances binaires via
JLLWrappers.jl
, un paquet Julia qui crée un module (nommé d’après la
bibliothèque enveloppée suivie de _jll.jl
.
Pour ajouter le chemin vers les binaires _jll.jl
, vous devez corriger
les fichiers dans src/wrappers/, en remplaçant l’appel à la macro
JLLWrappers.@generate_wrapper_header
, en ajoutant un second argument
contenant le chemin du binaire dans le dépôt.
Par exemple, dans le paquets Julia MbedTLS, on ajoute un phase de construction (voir Phases de construction) pour insérer le nom de fichier absolu du paquet enveloppé MbedTLS :
(add-after 'unpack 'override-binary-path
(lambda* (#:key inputs #:allow-other-keys)
(for-each (lambda (wrapper)
(substitute* wrapper
(("generate_wrapper_header.*")
(string-append
"generate_wrapper_header(\"MbedTLS\", \""
(assoc-ref inputs "mbedtls") "\")\n"))))
;; There's a Julia file for each platform, override them all.
(find-files "src/wrappers/" "\\.jl$"))))
Certains paquets plus anciens qui n’utilisent pas encore Project.toml
nécessiteront aussi la création de ce fichier. Cela s’effectue en interne si
les arguments #:julia-package-name
et #:julia-package-uuid
sont fournis.
Cette variable est exportée par (guix build-system maven)
. Elle
implémente une procédure de construction pour les paquets
Maven. Maven est un outil de gestion des
dépendances et du cycle de vie pour Java. Un·e utilisateur·rice de Maven
spécifie les dépendances et les plugins dans un fichier pom.xml que
Maven lit. Lorsque Maven n’a pas l’une des dépendances ou l’un des plugins
dans son dépôt, il les télécharge et les utilise pour construire le paquet.
Le système de construction de maven garantit que maven n’essaiera pas de télécharger une dépendance en s’exécutant en mode hors ligne. Maven échouera si une dépendance est manquante. Avant de lancer Maven, le fichier pom.xml (et sous-projets) sont modifiés pour spécifier la version des dépendances et des plugins qui correspondent aux versions disponibles dans l’environnement de construction de guix. Les dépendances et plugins doivent être installés dans le faux dépôt maven à lib/m2, et sont liés par un lien symbolique à un dépôt approprié avant que maven ne soit lancé. Maven a pour instruction d’utiliser ce dépôt pour la construction et y installe les artefacts construits. Les fichiers modifiés sont copiés dans le répertoire lib/m2 de la sortie du paquet.
Vous pouvez spécifier un fichier pom.xml avec l’argument
#:pom-file
, ou bien laisser le système de construction utiliser le
fichier par défaut pom.xml dans les sources.
Dans le cas où vous avez besoin de spécifier manuellement une version de
dépendances, vous pouvez utiliser l’argument #:local-packages
. Il
prend une liste d’association dont la clé est le groupId du paquet et sa
valeur est une liste d’association où la clé est l’artefactId du paquet et
sa valeur est la version que vous souhaitez remplacer dans le fichier
pom.xml.
Certains paquets utilisent des dépendances ou des plugins qui ne sont pas
utiles au moment de l’exécution ou de la compilation dans Guix. Vous pouvez
modifier le fichier pom.xml pour les supprimer en utilisant
l’argument #:exclude
. Sa valeur est une liste d’association où la
clé est le groupId du plugin ou de la dépendance que vous voulez supprimer,
et la valeur est une liste d’artifactId que vous voulez supprimer.
Vous pouvez remplacer les paquets jdk
et maven
par défaut avec
l’argument correspondant, #:jdk
et #:maven
.
L’argument #:maven-plugins
est une liste de plugins maven utilisés
pendant la construction, avec le même format que le champ inputs
de
la déclaration du paquet. Sa valeur par défaut est
(default-maven-plugins)
qui est également exportée.
Cette variable est exportée par (guix build-system minetest)
. Elle
implémente une procédure de construction pour les mods de
Minetest qui consiste à copier du code
Lua, des images et d’autres ressources aux emplacements où Minetest
recherche des mods. Le système de construction minimise aussi les images PNG
et vérifie que Minetest peut charger le mod sans erreur.
Cette variable est exportée par (guix build-system minify)
. Elle
implémente une procédure de minification pour des paquets JavaScript
simples.
Elle ajoute uglify-js
à l’ensemble des entrées et l’utilise pour
compresser tous les fichiers JavaScript du répertoire src. Un
minifieur différent peut être spécifié avec le paramètre #:uglify-js
mais il est attendu que ce paquet écrive le code minifié sur la sortie
standard.
Lorsque les fichiers JavaScript d’entrée ne sont pas situés dans le
répertoire src, le paramètre #:javascript-files
peut être
utilisé pour spécifier une liste de noms de fichiers à donner au minifieur.
This variable is exported by (guix build-system mozilla)
. It sets
the --target
and --host
configuration flags to what software
developed by Mozilla expects – due to historical reasons, Mozilla software
expects --host
to be the system that is cross-compiled from and
--target
to be the system that is cross-compiled to, contrary to the
standard Autotools conventions.
Cette variable est exportée par (guix build-system ocaml)
. Elle
implémente une procédure de construction pour les paquets
OCaml qui consiste à choisir le bon ensemble de
commande à lancer pour chaque paquet. Les paquets OCaml peuvent demander
des commandes diverses pour être construit. Ce système de construction en
essaye certaines.
Lorsqu’un fichier setup.ml est présent dans le répertoire de plus
haut niveau, elle lancera ocaml setup.ml -configure
, ocaml
setup.ml -build
et ocaml setup.ml -install
. Le système de
construction supposera que ces fichiers ont été générés par
OASIS et prendra soin
d’initialiser le préfixe et d’activer les tests s’ils ne sont pas
désactivés. Vous pouvez passer des drapeaux de configuration et de
construction avec #:configure-flags
et #:build-flags
. La clef
#:test-flags
peut être passée pour changer l’ensemble des drapeaux
utilisés pour activer les tests. La clef #:use-make?
peut être
utilisée pour outrepasser ce système dans les phases de construction et
d’installation.
Lorsque le paquet a un fichier configure, il est supposé qu’il s’agit
d’un script configure écrit à la main qui demande un format différent de
celui de gnu-build-system
. Vous pouvez ajouter plus de drapeaux avec
la clef #:configure-flags
.
Lorsque le paquet a un fichier Makefile (ou #:use-make?
vaut
#t
), il sera utilisé et plus de drapeaux peuvent être passés à la
construction et l’installation avec la clef #:make-flags
.
Enfin, certains paquets n’ont pas ces fichiers mais utilisent un emplacement
plus ou moins standard pour leur système de construction. Dans ce cas, le
système de construction lancera ocaml pkg/pkg.ml
ou
pkg/build.ml
et prendra soin de fournir le chemin du module findlib
requis. Des drapeaux supplémentaires peuvent être passés via la clef
#:bulid-flags
. L’installation se fait avec
opam-installer
. Dans ce cas, le paquet opam
doit être
ajouté au champ native-inputs
de la définition du paquet.
Remarquez que la plupart des paquets OCaml supposent qu’ils seront installés
dans le même répertoire qu’OCaml, ce qui n’est pas ce que nous voulons faire
dans Guix. En particulier, ils installeront leurs fichiers .so dans
leur propre répertoire de module, ce qui est normalement correct puisqu’il
s’agit du répertoire du compilateur OCaml. Dans Guix en revanche, ces
bibliothèques ne peuvent pas y être trouvées et on utilise
CAML_LD_LIBRARY_PATH
à la place. Cette variable pointe vers
lib/ocaml/site-lib/stubslibs et c’est là où les bibliothèques
.so devraient être installées.
Cette variable est exportée par (guix build-system python)
. Elle
implémente la procédure de construction plus ou moins standard utilisée pour
les paquets Python, qui consiste à lancer python setup.py build
puis
python setup.py install --prefix=/gnu/store/…
.
Pour les paquets qui installent des programmes autonomes Python dans
bin/
, elle prend soin d’envelopper ces binaires pour que leur
variable d’environnement GUIX_PYTHONPATH
pointe vers toutes les
bibliothèques Python dont ils dépendent.
Le paquet Python utilisé pour effectuer la construction peut être spécifié
avec le paramètre #:python
. C’est une manière utile de forcer un
paquet à être construit avec une version particulière de l’interpréteur
python, ce qui peut être nécessaire si le paquet n’est compatible qu’avec
une version de l’interpréteur.
Par défaut, guix appelle setup.py
sous le contrôle de
setuptools
, tout comme pip
le fait. Certains paquets ne
sont pas compatibles avec setuptools (et pip), vous pouvez donc le
désactiver en réglant le paramètre #:use-setuptools?
sur #f
.
Si la sortie "python"
est disponible, le paquet y est installé au
lieu de la sortie "out"
par défaut. C’est utile pour les paquets qui
incluent un paquet Python seulement comme partie du logiciel, et donc qu’il
faut combiner les phases de python-build-system
avec celles d’un
autre système de construction. Les liaisons Python sont un cas courant.
C’est une variable exportée par guix build-system pyproject
. Elle est
basée sur python-build-system et ajoute la prise en charge de
pyproject.toml et PEP
517. Elle prend aussi en charge plusieurs moteurs de construction et
cadriciels de test.
L’API est un peu différente de celle de python-build-system :
#:use-setuptools?
et #:test-target
sont supprimés.
#:build-backend
est ajouté. Sa valeur par défaut est #false
et
le système essaiera de deviner le moteur approprié en fonction de
pyproject.toml.
#:test-backend
est ajouté. Sa valeur par défaut est #false
et
le système essaiera de deviner un moteur de test approprié en fonction de ce
qui est disponible dans les entrées du paquet.
#:test-flags
est ajouté. La valeur par défaut est '()
. Ces
drapeaux sont passés en argument à la commande de test. Remarquez que les
drapeaux pour la sortie verbeuse sont toujours activés pour les moteurs pris
en charge.
Il est considéré comme « expérimental » dans le sens où les détails d’implémentation ne sont pas encore figés, mais nous vous encourageons à l’essayer pour les nouveaux projets Python (même ceux qui utilisent setup.py). L’API pourrait changer mais les changements provoquant des problèmes dans le canal Guix seront gérés.
Ce système de construction finira par être obsolète et fusionné dans python-build-system, sans doute au courant de l’année 2024.
Cette variable est exportée par (guix build-system perl)
. Elle
implémente la procédure de construction standard des paquets Perl, qui
consiste soit à lancer perl Build.PL --prefix=/gnu/store/…
,
suivi de Build
et Build install
; ou à lancer perl
Makefile.PL PREFIX=/gnu/store/…
, suivi de make
et make
install
, en fonction de la présence de Build.PL
ou
Makefile.PL
dans la distribution du paquet. Le premier a la
préférence si Build.PL
et Makefile.PL
existent tous deux dans
la distribution du paquet. Cette préférence peut être inversée en
spécifiant #t
pour le paramètre #:make-maker?
.
L’invocation initiale de perl Makefile.PL
ou perl Build.PL
passe les drapeaux spécifiés par le paramètre #:make-maker-flags
ou
#:module-build-flags
, respectivement.
Le paquet Perl utilisé peut être spécifié avec #:perl
.
Cette variable est exportée par (guix build-system renpy)
. Elle
implémente la procédure de construction plus ou moins standard utilisée pour
les jeux Ren’py, qui consiste à charger #:game
une fois, et donc à
créer le bytecode pour le jeu.
Elle crée aussi un script enveloppe dans bin/
et une entrée de bureau
dans share/applications
, tous deux pouvant être utilisés pour lancer
le jeu.
Le paquet Ren’py utilisé peut être spécifié avec #:renpy
. Les jeux
peuvent aussi être installé dans des sorties différentes de « out » avec
#:output
.
Cette variable est exportée par (guix build-system qt)
. Elle est
destinée à être employée avec des applications utilisant Qt ou KDE.
Ce système de construction ajoute les deux phases suivantes à celles
définies par gnu-build-system
:
check-setup
La phase check-setup
prépare l’environnement pour l’exécution des
contrôles tels qu’ils sont couramment utilisés par les programmes de test
Qt. Pour l’instant, elle ne définit que quelques variables d’environnement
: QT_QPA_PLATFORM=offscreen
, DBUS_FATAL_WARNINGS=0
et
CTEST_OUTPUT_ON_FAILURE=1
.
Cette phase est ajoutée avant la phase check
. C’est une phase
distincte pour faciliter l’ajustement si nécessaire.
qt-wrap
La phase qt-wrap
recherche les chemins des plugins Qt5, les chemins
QML et certains XDG dans les entrées et sorties. Si un chemin est trouvé,
tous les programmes des répertoires bin/, sbin/,
libexec/ et lib/libexec/ de la sortie sont enveloppés dans des
scripts définissant les variables d’environnement nécessaires.
Il est possible d’exclure des sorties de paquets spécifiques de ce processus
d’emballage en listant leurs noms dans le paramètre
#:qt-wrap-excluded-outputs
. Ceci est utile lorsqu’une sortie est
connue pour ne pas contenir de binaires Qt, et où le wrapping ajouterait
gratuitement une dépendance de cette sortie à Qt, KDE, ou autre.
Cette phase est exécutée après la phase install
.
Cette variable est exportée par (guix build-system r)
. Elle
implémente la procédure de compilation utilisée par les paquets
R, qui consiste en substance à exécuter
‘R CMD INSTALL --library=/gnu/store/…’ dans un environnement où
R_LIBS_SITE
contient les chemins de toutes les entrées des paquets R.
Les tests sont exécutés après l’installation en utilisant la fonction R
tools::testInstalledPackage
.
Cette variable est exportée par (guix build-system rakudo)
. Elle
implémente la procédure de construction utilisée par
Rakudo pour les paquets
Perl6. Elle installe le paquet dans
/gnu/store/…/NOM-VERSION/share/perl6
et installe les binaires,
les fichiers de bibliothèques et les ressources, et enveloppe les fichiers
dans le répertoire bin/
. Les tests peuvent être passés en indiquant
#f
au paramètre tests?
.
Le paquet rakudo utilisé peut être spécifié avec rakudo
. Le paquet
perl6-tap-harness utilisé pour les tests peut être spécifié avec
#:prove6
ou supprimé en passant #f
au paramètre
with-prove6?
. Le paquet perl6-zef utilisé pour les tests et
l’installation peut être spécifié avec #:ef
ou supprimé en passant
#f
au paramètre with-zef?
.
Cette variable est exportée par (guix build-system rebar)
. Elle
implémente une procédure de construction pour
rebar3, un système de construction pour les
programmes écrits en Erlang.
Elle ajoute à la fois rebar3
et erlang
à l’ensemble des
entrées. Des paquets différents peuvent être spécifiés avec les paramètres
#:rebar
et #:erlang
, respectivement.
Ce système de construction est basé sur gnu-build-system, mais avec les phases suivantes modifiées :
unpack
Cette phase, après avoir déballé les sources comme le fait le
gnu-build-system
, vérifie qu’un fichier contents.tar.gz
existe
au plus haut niveau des sources. Si ce fichier existe, il sera aussi
déballé. Cela facilite la gestion des paquets hébergés sur
https://hex.pm/, le dépôt des paquets Erlang et Elixir.
bootstrap
configure
Il n’y a ni phase bootstrap
ni configure
parce que les paquets
erlang n’ont pas besoin d’être configurés.
build
Cette phase lance rebar3 compile
avec les drapeaux listés dans
#:rebar-flags
.
check
À moins que #:tests? #f
ne soit passé, cette phase lance rebar3
eunit
, ou une cible spécifiée avec #:test-target
, avec les drapeaux
listés dans #:rebar-flags
,
install
Cela installe les fichiers créés dans le profil default, ou un autre
profil spécifié avec #:install-profile
.
Cette variable est exportée par (guix build-system texlive)
. Elle
est utilisée pour construire des paquets TeX en mode batch avec le moteur
spécifié. Le système de construction initialise la variable TEXINPUTS
pour trouver tous les fichiers source TeX dans ses entrées.
By default it tries to run luatex
on all .ins files, and if it
fails to find any, on all .dtx files. A different engine and format
can be specified with, respectively, the #:tex-engine
and
#:tex-format
arguments. Different build targets can be specified
with the #:build-targets
argument, which expects a list of file
names.
It also generates font metrics (i.e., .tfm files) out of Metafont
files whenever possible. Likewise, it can also create TeX formats (i.e.,
.fmt files) listed in the #:create-formats
argument, and
generate a symbolic link from bin/ directory to any script located in
texmf-dist/scripts/, provided its file name is listed in
#:link-scripts
argument.
The build system adds texlive-bin
from (gnu packages tex)
to
the native inputs. It can be overridden with the #:texlive-bin
argument.
The package texlive-latex-bin
, from the same module, contains most of
the tools for building TeX Live packages; for convenience, it is also added
by default to the native inputs. However, this can be troublesome when
building a dependency of texlive-latex-bin
itself. In this
particular situation, the #:texlive-latex-bin?
argument should be set
to #f
.
Cette variable est exportée par (guix build-system ruby)
. Elle
implémenter la procédure de construction RubyGems utilisée par les paquets
Ruby qui consiste à lancer gem build
suivi de gem install
.
Le champ source
d’un paquet qui utilise ce système de construction
référence le plus souvent une archive gem, puisque c’est le format utilisé
par les personnes qui développent en Ruby quand elles publient leur
logiciel. Le système de construction décompresse l’archive gem,
éventuellement en corrigeant les sources, lance la suite de tests,
recompresse la gemme et l’installe. En plus, des répertoires et des
archives peuvent être référencés pour permettre de construire des gemmes qui
n’ont pas été publiées depuis Git ou une archive de sources traditionnelle.
Le paquet Ruby utilisé peut être spécifié avec le paramètre #:ruby
.
Une liste de drapeaux supplémentaires à passer à la commande gem
peut être spécifiée avec le paramètre #:gem-flags
.
Cette variable est exportée par (guix build-system waf)
. Elle
implémente une procédure de construction autour du script waf
. Les
phases usuelles — configure
, build
et install
— sont
implémentée en passant leur nom en argument au script waf
.
Le script waf
est exécuté par l’interpréteur Python. Le paquet
Python utilisé pour lancer le script peut être spécifié avec le paramètre
#:python
.
This variable is exported by (guix build-system zig)
. It implements
the build procedures for the Zig build system
(zig build
command).
Selecting this build system adds zig
to the package inputs, in
addition to the packages of gnu-build-system
.
There is no configure
phase because Zig packages typically do not
need to be configured. The #:zig-build-flags
parameter is a list of
flags that are passed to the zig
command during the build. The
#:zig-test-flags
parameter is a list of flags that are passed to the
zig test
command during the check
phase. The default compiler
package can be overridden with the #:zig
argument.
The optional zig-release-type
parameter declares the type of
release. Possible values are: safe
, fast
, or
small
. The default value is #f
, which causes the release flag
to be omitted from the zig
command. That results in a debug
build.
Cette variable est exportée par (guix build-system scons)
. Elle
implémente la procédure de construction utilisée par l’outil de construction
SCons. Ce système de construction lance scons
pour construire le
paquet, scons test
pour lancer les tests puis scons install
pour installer le paquet.
Des drapeaux supplémentaires à passer à scons
peuvent être spécifiés
avec le paramètre #:scons-flags
. Les cibles de construction et
d’installation par défaut peuvent être remplacées respectivement par les
paramètres #:build-targets
et #:install-targets
. La version
de Python utilisée pour exécuter SCons peut être spécifiée en sélectionnant
le paquet SCons approprié avec le paramètre #:scons
.
Cette variable est exportée par (guix build-system haskell)
. Elle
implémente la procédure de construction Cabal utilisée par les paquets
Haskell, qui consiste à lancer runhaskell Setup.hs configure
--prefix=/gnu/store/…
et runhaskell Setup.hs build
. Plutôt
que d’installer le paquets en lançant runhaskell Setup.hs install
,
pour éviter d’essayer d’enregistrer les bibliothèques dans le répertoire du
dépôt en lecture-seule du compilateur, le système de construction utilise
runhaskell Setup.hs copy
, suivi de runhaskell Setup.hs
register
. En plus, le système de construction génère la documentation du
paquet en lançant runhaskell Setup.hs haddock
, à moins que
#:haddock? #f
ne soit passé. Des paramètres facultatifs pour Haddock
peuvent être passés à l’aide du paramètre #:haddock-flags
. Si le
fichier Setup.hs
n’est pas trouvé, le système de construction
cherchera Setup.lhs
à la place.
Le compilateur Haskell utilisé peut être spécifié avec le paramètre
#:haskell
qui a pour valeur par défaut ghc
.
Cette variable est exportée par (guix build-system dub)
. Elle
implémente la procédure de construction Dub utilisée par les paquets D qui
consiste à lancer dub build
et dub run
. L’installation est
effectuée en copiant les fichiers manuellement.
Le compilateur D utilisé peut être spécifié avec le paramètre #:ldc
qui vaut par défaut ldc
.
Cette variable est exportée par (guix build-system emacs)
. Elle
implémente une procédure d’installation similaire au système de gestion de
paquet d’Emacs lui-même (voir Packages dans The GNU Emacs Manual).
Cela crée d’abord le fichier
, puis
compile tous les fichiers Emacs Lisp en bytecode. Contrairement au système
de gestion de paquets d’Emacs, les fichiers de documentation info sont
déplacés dans le répertoire standard et le fichier dir est supprimé.
Les fichiers du paquet Elisp sont directement installés sous
share/emacs/site-lisp.
package
-autoloads.el
Cette variable est exportée par (guix build-system font)
. Elle
implémente une procédure d’installation pour les paquets de polices où des
fichiers de polices TrueType, OpenType, etc. sont fournis en amont et
n’ont qu’à être copiés à leur emplacement final. Elle copie les fichiers de
polices à l’emplacement standard dans le répertoire de sortie.
Cette variable est exportée par (guix build-system meson)
. Elle
implémente la procédure de construction des paquets qui utilisent
Meson comme système de construction.
Elle ajoute à la fois Meson et Ninja à
l’ensemble des entrées, et ils peuvent être modifiés avec les paramètres
#:meson
et #:ninja
si requis.
Ce système de construction est une extension de gnu-build-system
,
mais avec les phases suivantes modifiées pour Meson :
configure
La phase lance meson
avec les drapeaux spécifiés dans
#:configure-flags
. Le drapeau --buildtype est toujours
défini à debugoptimized
à moins qu’autre chose ne soit spécifié dans
#:build-type
.
build
La phase lance ninja
pour construire le paquet en parallèle par
défaut, mais cela peut être changé avec #:parallel-build?
.
check
La phase lance ‘meson test’ avec un ensemble d’options de base qui ne
peuvent pas être modifiées. Cette base d’options peut être étendue avec
l’argument #:test-options
, par exemple pour choisir ou passer une
suite de test spécifique.
install
La phase lance ninja install
et ne peut pas être changée.
En dehors de cela, le système de construction ajoute aussi la phase suivante :
fix-runpath
Cette phase s’assure que tous les binaire peuvent trouver les bibliothèques
dont ils ont besoin. Elle cherche les bibliothèques requises dans les
sous-répertoires du paquet en construction et les ajoute au RUNPATH
là où c’est nécessaire. Elle supprime aussi les références aux
bibliothèques laissées là par la phase de construction par meson
comme les dépendances des tests, qui ne sont pas vraiment requises pour le
programme.
glib-or-gtk-wrap
Cette phase est la phase fournie par glib-or-gtk-build-system
et
n’est pas activée par défaut. Elle peut l’être avec #:glib-or-gtk?
.
glib-or-gtk-compile-schemas
Cette phase est la phase fournie par glib-or-gtk-build-system
et
n’est pas activée par défaut. Elle peut l’être avec #:glib-or-gtk?
.
linux-module-build-system
permet de construire des modules du noyau
Linux.
Ce système de construction est une extension de gnu-build-system, mais avec les phases suivantes modifiées :
configure
Cette phase configure l’environnement pour que le Makefile du noyau Linux puisse être utilisé pour construire le module du noyau externe.
build
Cette phase utilise le Makefile du noyau Linux pour construire le module du noyau externe.
install
Cette phase utilise le Makefile du noyau Linux pour installer le module du noyau externe.
Il est possible et utile de spécifier le noyau Linux à utiliser pour
construire le module (sous la forme arguments
d’un paquet utilisant
le linux-module-build-system
, utilisez la clé #:linux
pour le
spécifier).
Cette variable est exportée par (guix build-system node)
. Elle
implémente la procédure de compilation utilisée par
Node.js, qui implémente une approximation de la
commande npm install
, suivie d’une commande npm test
.
Le paquet Node.js utilisé pour interpréter les commandes npm
peut
être spécifié avec le paramètre #:node
dont la valeur par défaut est
node
.
This variable is exported by (guix build-system tree-sitter)
. It
implements procedures to compile grammars for the
Tree-sitter parsing
library. It essentially runs tree-sitter generate
to translate
grammar.js
grammars to JSON and then to C. Which it then compiles to
native code.
Tree-sitter packages may support multiple grammars, so this build system
supports a #:grammar-directories
keyword to specify a list of
locations where a grammar.js
file may be found.
Grammars sometimes depend on each other, such as C++ depending on C and TypeScript depending on JavaScript. You may use inputs to declare such dependencies.
Enfin, pour les paquets qui n’ont pas besoin de choses sophistiquées, un système de construction « trivial » est disponible. Il est trivial dans le sens où il ne fournit en gros aucun support : il n’apporte pas de dépendance implicite, et n’a pas de notion de phase de construction.
Cette variable est exportée par (guix build-system trivial)
.
Ce système de construction requiert un argument #:builder
. Cet
argument doit être une expression Scheme qui construit la sortie du paquet —
comme avec build-expression->derivation
(voir build-expression->derivation
).
Cette variable est exportée par (guix build-system channel)
.
Ce système de construction est surtout conçu pour usage interne. Pour
utiliser ce système de construction, un paquet doit avoir une spécification
de canal dans son champ source
(voir Canaux); autrement, sa
source doit être un nom de répertoire, auquel cas un argument
#:commit
supplémentaire doit être fournit pour spécifier le commit à
construire (une chaine hexadécimale).
Optionally, a #:channels
argument specifying additional channels can
be provided.
The resulting package is a Guix instance of the given channel(s), similar to
how guix time-machine
would build it.
Suivant: Utilitaires de construction, Précédent: Systèmes de construction, Monter: Interface de programmation [Table des matières][Index]
Presque tous les systèmes de construction de paquets mettent en œuvre une
notion de phase de construction : une séquence d’actions que le
système de construction exécute, lorsque vous construisez le paquet,
conduisant aux sous-produits installés dans le dépôt. Une exception notable
est le trivial-build-system
(voir Systèmes de construction) minimaliste.
Comme nous l’avons dit dans la section précédente, ces systèmes de
construction fournissent une liste de phases standards. Pour
gnu-build-system
, les phases de construction principales sont les
suivantes :
set-paths
Défini les variables d’environnement de chemins de recherche pour tous les
paquets d’entrée, dont PATH
(voir Chemins de recherche).
unpack
Décompresse l’archive des sources et se déplace dans l’arborescence des sources fraîchement extraites. Si la source est en fait un répertoire, le copie dans l’arborescence de construction et entre dans ce répertoire.
patch-source-shebangs
Corrige les shebangs (#!
) rencontrés dans les fichiers pour qu’ils se
réfèrent aux bons noms de fichiers. Par exemple, elle change
#!/bin/sh
en #!/gnu/store/…-bash-4.3/bin/sh
.
configure
Lance le script configure
avec un certain nombre d’options par
défaut, comme --prefix=/gnu/store/…, ainsi que les options
spécifiées par l’argument #:configure-flags
.
build
Lance make
avec la liste des drapeaux spécifiés avec
#:make-flags
. Si l’argument #:parallel-build?
est vrai (par
défaut), construit avec make -j
.
check
Lance make check
, ou une autre cible spécifiée par
#:test-target
, à moins que #:tests? #f
ne soit passé. Si
l’argument #:parallel-tests?
est vrai (par défaut), lance make
check -j
.
install
Lance make install
avec les drapeaux listés dans #:make-flags
.
patch-shebangs
Corrige les shebangs des fichiers exécutables installés.
strip
Nettoie les symboles de débogage dans les fichiers ELF (à moins que
#:strip-binaries?
ne soit faux), les copie dans la sortie
debug
lorsqu’elle est disponible (voir Installer les fichiers de débogage).
validate-runpath
Valide le RUNPATH
des binaires ELF, à moins que
#:validate-runpath?
ne soit faux (voir Systèmes de construction).
Cette étape de validation s’assure que toutes les bibliothèques partagées
par les binaires ELF, qui sont listées dans des entrées DT_NEEDED
de
leur segment PT_DYNAMIC
apparaissent dans l’entrée DT_RUNPATH
de ce même binaire. En d’autres termes, elle s’assure que lancer ou utiliser
ces binaires ne renvoie pas l’erreur « fichier introuvable » à
l’exécution. Voir -rpath dans The GNU Linker, pour plus
d’informations sur le RUNPATH
.
Les autres systèmes de construction ont des phases similaires, avec quelques
variations. Par exemple, cmake-build-system
a des phases de même nom,
mais sa phase configure
exécute cmake
au lieu de
./configure
. D’autres, tels que python-build-system
, ont une
liste de phases standard totalement différente. Tout ce code s’exécute
côté construction : il est évalué lorsque vous construisez réellement
le paquet, dans un processus de construction dédié engendré par le démon de
construction (voir Invoquer guix-daemon
).
Les phases de construction sont représentées sous forme de listes d’associations ou « alists » (voir Listes d’association dans Manuel de référence de GNU Guile) où chaque clé est un symbole pour le nom de la phase et la valeur associée est une procédure qui accepte un nombre arbitraire d’arguments. Par convention, ces procédures reçoivent des informations sur la construction sous la forme de paramètres nommés, qu’elles peuvent utiliser ou ignorer.
Par exemple, voici comment (guix build gnu-build-system)
définit
%standard-phases
, la variable contenant sa liste de phases de
construction21 :
;; Les phases de construction de « gnu-build-system ». (define* (unpack #:key source #:allow-other-keys) ;; Extrait l'archive des sources. (invoke "tar" "xvf" source)) (define* (configure #:key outputs #:allow-other-keys) ;; Exécute le script « configure ». Installe la sortie « out ». (let ((out (assoc-ref outputs "out"))) (invoke "./configure" (string-append "--prefix=" out)))) (define* (build #:allow-other-keys) ;; Compile. (invoke "make")) (define* (check #:key (test-target "check") (tests? #true) #:allow-other-keys) ;; Lance la suite de tests. (if tests? (invoke "make" test-target) (display "test suite not run\n"))) (define* (install #:allow-other-keys) ;; Installe les fichiers sous le préfixe spécifié à « configure ». (invoke "make" "install")) (define %standard-phases ;; La liste des phases standard (un certain nombre d'entre elles sont omises ;; par souci de concision). Chaque élément est une paire symbole/procédure. (list (cons 'unpack unpack) (cons 'configure configure) (cons 'build build) (cons 'check check) (cons 'install install)))
Cela montre comment %standard-phases
est défini comme une liste de
paires symbole/procédure (voir Pairs dans GNU Guile Reference
Manual). La première paire associe le symbole unpack
— un nom —
à la procédure unpack
; la deuxième paire définit la phase
configure
de manière similaire, et ainsi de suite. Lors de la
construction d’un paquet qui utilise gnu-build-system
avec sa liste
de phases par défaut, ces phases sont exécutées de manière séquentielle.
Vous pouvez voir le nom de chaque phase commencée et terminée dans le
journal de construction des paquets que vous construisez.
Examinons maintenant les procédures elles-mêmes. Chacune est définie par
define*
: #:key
énumère les paramètres nommés que la procédure
accepte, éventuellement avec une valeur par défaut, et
#:allow-other-keys
précise que les autres paramètres nommés sont
ignorés (voir Optional Arguments dans GNU Guile Reference Manual).
La procédure unpack
prend en compte le paramètre source
, que
le système de compilation utilise pour passer le nom de fichier de l’archive
source (ou le répertoire cloné d’un système de contrôle de version), et elle
ignore les autres paramètres. La phase configure
ne s’intéresse
qu’au paramètre outputs
, une liste d’association des noms des sorties
du paquet avec le nom de leur fichier du dépôt (voir Des paquets avec plusieurs résultats). Elle extrait le nom de fichier de out
, la sortie
par défaut, et le transmet à ./configure
comme préfixe
d’installation, ce qui signifie que make install
copiera tous les
fichiers vers ce répertoire (voir configuration and
makefile conventions dans GNU Coding Standards). build
et
install
ignorent tous leurs arguments. check
prend en compte
l’argument test-target
, qui spécifie le nom de la cible du Makefile
pour exécuter les tests ; il imprime un message et saute les tests lorsque
tests?
est faux.
La liste des phases utilisées pour un paquet particulier peut être modifiée
avec le paramètre #:phases
du système de construction. La
modification de l’ensemble des phases de construction se résume à la
création d’une nouvelle liste de phases basée sur la liste
%standard-phases
décrite ci-dessus. On peut faire cela à l’aide des
procédures standards qui manipulent des listes d’associations telles que
alist-delete
(voir SRFI-1 Association Lists dans GNU Guile
Reference Manual) ; cependant, il est plus pratique de le faire avec
modify-phases
(voir modify-phases
).
Voici un exemple de définition de paquet qui supprime la phase
configure
de %standard-phases
et insère une nouvelle phase
avant la phase build
, appelée set-prefix-in-makefile
:
(define-public example
(package
(name "example")
;; other fields omitted
(build-system gnu-build-system)
(arguments
(list
#:phases
#~(modify-phases %standard-phases
(delete 'configure)
(add-before 'build 'set-prefix-in-makefile
(lambda* (#:key inputs #:allow-other-keys)
;; Modify the makefile so that its
;; 'PREFIX' variable points to #$output and
;; 'XMLLINT' points to the correct path.
(substitute* "Makefile"
(("PREFIX =.*")
(string-append "PREFIX = " #$output "\n"))
(("XMLLINT =.*")
(string-append "XMLLINT = "
(search-input-file inputs "/bin/xmllint")
"\n"))))))))))
The new phase that is inserted is written as an anonymous procedure,
introduced with lambda*
; it looks for the xmllint executable
under a /bin directory among the package’s inputs (voir Référence de package
). It also honors the outputs
parameter we have seen
before. Voir Utilitaires de construction, for more about the helpers used by this
phase, and for more examples of modify-phases
.
Astuce : You can inspect the code associated with a package’s
#:phases
argument interactively, at the REPL (voir Utiliser Guix de manière interactive).
Gardez à l’esprit que le code des phases de construction est évalué à la
construction effective des paquets. Cela explique pourquoi toute
l’expression modify-phases
ci-dessus est citée (elle vient après
'
ou apostrophe) : elle est mise de côté pour une exécution
ultérieure. Voir G-Expressions, pour une explication de la mise en place
du code et des strates de code concernées.
Suivant: Chemins de recherche, Précédent: Phases de construction, Monter: Interface de programmation [Table des matières][Index]
Dès que vous commencerez à écrire des définitions de paquets non triviales
(voir Définition des paquets) ou d’autres actions de compilation
(voir G-Expressions), vous commencerez probablement à chercher des
fonctions auxiliaires pour les actions « de type shell » — créer des
répertoires, copier et supprimer des fichiers de manière récursive,
manipuler les phases de compilation, etc. Le module (guix build
utils)
fournit de telles procédures utilitaires.
La plupart des systèmes de construction chargent (guix build utils)
(voir Systèmes de construction). Ainsi, lorsque vous écrivez des phases de
construction personnalisées pour vos définitions de paquets, vous pouvez
généralement supposer que ces procédures sont disponibles.
Lorsque vous écrivez des G-expressions, vous pouvez importer (guix
build utils)
« côté construction » en utilisant
with-imported-modules
et ensuite le rendre disponible avec la forme
use-modules
(voir Using Guile Modules dans GNU Guile Reference
Manual) :
(with-imported-modules '((guix build utils)) ;on l'importe
(computed-file "empty-tree"
#~(begin
;; On le rend disponible.
(use-modules (guix build utils))
;; On utilise sa procédure « mkdir-p » sans souci.
(mkdir-p (string-append #$output "/a/b/c")))))
Le reste de cette section est la référence pour la plupart des procédures
auxiliaires fournies par (guix build utils)
.
Cette section documente les procédures de traitement des noms de fichier du dépôt.
Renvoie le nom de répertoire du dépôt.
Renvoie vrai si fichier est dans le dépôt.
Enlevez le /gnu/store et le hash de fichier, un nom de fichier
du dépôt. Le résultat est généralement une chaîne
"paquet-version"
.
Si l’on passe nom, un nom de paquet comme "toto-0.9.1b"
, on
obtient deux valeurs : "toto"
et "0.9.1b"
. Lorsque la partie
version est indisponible, nom et #f
sont renvoyés. Le premier
trait d’union suivi d’un chiffre est considéré comme introduisant la partie
version.
Les procédures ci-dessous portent sur les fichiers et les types de fichiers.
Renvoie #t
si dir existe et est un répertoire.
Renvoie #t
si fichier existe et est exécutable.
Renvoie #t
si fichier est un lien symbolique (un « symlink »).
Renvoie #t
si fichier est, respectivement, un fichier ELF, une
archive ar
(telle qu’une bibliothèque statique .a), ou un
fichier gzip.
Si fichier est un fichier gzip, réinitialise son horodatage intégré
(comme avec gzip --no-name
) et renvoie vrai. Sinon, renvoie
#f
. Lorsque keep-mtime? est vrai, conserve la date de
modification de fichier.
Les procédures et macros suivantes permettent de créer, modifier et
supprimer des fichiers. Elles offrent des fonctionnalités comparables à
celles des utilitaires shell courants tels que mkdir -p
,
cp -r
, rm -r
et sed
. Elles complètent
l’interface de système de fichiers étendue, mais de bas niveau, de Guile
(voir POSIX dans GNU Guile Reference Manual).
Exécute corps avec répertoire comme répertoire actuel du processus.
En gros, cette macro change le répertoire actuel en répertoire avant
d’évaluer corps, en utilisant chdir
. (voir Processus dans Manuel de référence de GNU Guile). Elle revient au répertoire
initial à la sortie de la portée dynamique de corps, qu’il s’agisse
d’un retour de procédure normal ou d’une sortie non locale telle qu’une
exception.
Crée le répertoire dir et tous ses ancètres.
Crée répertoire s’il n’existe pas et y copie fichier sous le même nom.
Rend fichier inscriptible pour son propriétaire.
copy-file] [#:keep-mtime? #f] [#:keep-permissions? #t] [#:select? (const
#t)] Copy source directory to destination. Follow symlinks if
follow-symlinks? is true; otherwise, just preserve them. Call
copy-file to copy regular files. Call select?, taking two
arguments, file and stat, for each entry in source, where
file is the entry’s absolute file name and stat is the result of
lstat
(or stat
if follow-symlinks? is true); exclude
entries for which select? does not return true. When
keep-mtime? is true, keep the modification time of the files in
source on those of destination. When keep-permissions? is
true, preserve file permissions. Write verbose output to the log
port.
Efface récursivement dir, comme rm -rf
, sans suivre les
liens symboliques. Ne suit pas non plus les points de montage, à moins que
follow-mounts? ne soit vrai. Rapporte mais ignore les erreurs.
fichier par la chaîne renvoyée par body. body est évalué avec chaque match-var lié à la sous-expression de regexp positionnelle correspondante. Par exemple :
(substitute* file
(("hello")
"good morning\n")
(("toto([a-z]+)titi(.*)$" all letters end)
(string-append "tata" letters end)))
Ici, chaque fois qu’une ligne de fichier contient hello
, elle
est remplacée par good morning
. Chaque fois qu’une ligne de
fichier correspond à la deuxième regexp, all
est lié à la
correspondance complète, letters
est lié à la première
sous-expression, et end
est lié à la dernière.
Lorsque l’une des match-var est _
, aucune variable n’est liée à
la sous-chaîne de correspondance associée.
Autrement, fichier peut être une liste de noms de fichier, auquel cas ils sont tous sujets aux substitutions.
Be careful about using $
to match the end of a line; by itself it
won’t match the terminating newline of a line. For example, to match a
whole line ending with a backslash, one needs a regex like
"(.*)\\\\\n$"
.
Cette section documente les procédures pour chercher et filtrer des fichiers.
Renvoie un prédicat qui devient vrai lorsqu’on lui passe un nom de fichier dont le nom de base correspond à regexp.
Renvoie la liste des fichiers triés lexicographiquement sous dir pour
lesquels pred renvoie « vrai ». Deux arguments sont passés à
pred : le nom absolu du fichier et son tampon stat ; le prédicat par
défaut renvoie toujours « vrai ». pred peut également être une
expression régulière, auquel cas elle est équivalente à
(file-name-predicate pred)
. stat est utilisé pour
obtenir des informations sur les fichiers ; l’utilisation de lstat
signifie que les liens symboliques ne sont pas suivis. Si
directories? est vrai, alors les répertoires seront également inclus.
Si fail-on-error? est vrai, il lance une exception en cas d’erreur.
Voici quelques exemples où nous supposons que le répertoire actuel est la racine de l’arborescence des sources de Guix :
;; Liste tous les fichiers normaux dans le répertoire actuel. (find-files ".") ⇒ ("./.dir-locals.el" "./.gitignore" …) ;; Liste tous les fichiers .scm sous gnu/services. (find-files "gnu/services" "\\.scm$") ⇒ ("gnu/services/admin.scm" "gnu/services/audio.scm" …) ;; Liste les fichiers ar dans le répertoire actuel. (find-files "." (lambda (file stat) (ar-file? file))) ⇒ ("./libformat.a" "./libstore.a" …)
Renvoie le nom complet du fichier pour programme tel qu’il se trouve
dans $PATH
, ou #f
si programme n’a pas pu être trouvé.
Renvoie le nom de fichier complet de nom trouvé dans entrées ;
search-input-file
recherche les fichiers normaux et
search-input-directory
recherche les dossiers. Si nom n’est pas
trouvé, une exception est levée.
Ici, entrées doit être une liste d’association comme les variables
inputs
et native-inputs
disponibles dans les phases de
construction (voir Phases de construction).
Voici un exemple (simplifié) d’utilisation de search-input-file
dans
une phase de construction du paquet wireguard-tools
:
(add-after 'install 'wrap-wg-quick
(lambda* (#:key inputs outputs #:allow-other-keys)
(let ((coreutils (string-append (assoc-ref inputs "coreutils")
"/bin")))
(wrap-program (search-input-file outputs "bin/wg-quick")
#:sh (search-input-file inputs "bin/bash")
`("PATH" ":" prefix ,(list coreutils))))))
Vous trouverez des procédures pratiques pour invoquer des processus dans ce
module, en particulier des enveloppes pratiques autour de system*
de
Guile (voir system*
dans le manuel de référence de
Guile).
Invoque le programme avec les args donnés. Lève une exception
&invoke-error
si le code de retour n’est pas zéro ; sinon renvoie
#t
.
L’avantage par rapport à system*
c’est que vous n’avez pas besoin de
vérifier la valeur de sortie. Cela réduit le code dans les petits scripts
comme par exemple dans les phases de construction des paquets.
Renvoie vrai si c est une condition &invoke-error
.
Accède aux champs de c, une condition &invoke-error
.
Rapporte c, une condition &invoke-error
, sur port (par
défaut le port d’erreur actuel), dans un format humainement lisible.
L’utilisation habituelle ressemblerait à ceci :
(use-modules (srfi srfi-34) ;pour « guard » (guix build utils)) (guard (c ((invoke-error? c) (report-invoke-error c))) (invoke "date" "--option-imaginaire")) -| command "date" "--option-imaginaire" failed with status 1
Invoque programme avec args et capture la sortie standard et
l’erreur standard de programme. Si programme termine sans
erreur, n’affiche rien et renvoie la valeur non spécifiée ; sinon, lève une
condition d’erreur &message
qui inclut le code de statut et la sortie
de programme.
Voici un exemple :
(use-modules (srfi srfi-34) ;pour « guard » (srfi srfi-35) ;pour « message-condition? » (guix build utils)) (guard (c ((message-condition? c) (display (condition-message c)))) (invoke/quiet "date") ; tout va bien (invoke/quiet "date" "--imaginary-option")) -| 'date --imaginary-option' exited with status 1; output follows: date : option non reconnue '--imaginary-option' Saisissez « date --help » pour plus d'informations.
Le (guix build utils)
contient également des outils permettant de
manipuler les phases de construction telles qu’elles sont utilisées par les
systèmes de construction (voir Systèmes de construction). Les phases de
construction sont représentées sous forme de listes d’associations ou «
alists » (voir Association Lists dans Manuel de référence de GNU
Guile) où chaque clé est un symbole désignant la phase et où la valeur
associée est une procédure (voir Phases de construction).
Le noyau Guile et le module (srfi srfi-1)
fournissent tous deux des
outils pour manipuler les alignements. Le module (guix build utils)
complète ces outils avec des outils écrits en tenant compte des phases de
construction.
Modifie phases séquentiellement selon chaque clause, qui peut avoir l’une des formes suivantes :
(delete old-phase-name) (replace old-phase-name new-phase) (add-before old-phase-name new-phase-name new-phase) (add-after old-phase-name new-phase-name new-phase)
Où chaque phase-name ci-dessus est une expression s’évaluant en un symbole, et new-phase une expression évaluant à une procédure.
L’exemple ci-dessous est tiré de la définition du paquet grep
. Il
ajoute une phase à exécuter après la phase install
, appelée
fix-egrep-and-fgrep
. Cette phase est une procédure (lambda*
pour les procédures anonymes) qui prend un paramètre nommé #:outputs
et ignore les paramètres nommés supplémentaires (voir Optional
Arguments dans GNU Guile Reference Manual, pour en savoir plus sur
lambda*
et les arguments optionnels et nommés). La phase utilise
substitute*
pour modifier les scripts egrep et fgrep
installés afin qu’ils se réfèrent à grep
par son nom de fichier
absolu :
(modify-phases %standard-phases
(add-after 'install 'fix-egrep-and-fgrep
;; Corrige « egrep » et « fgrep » pour exécuter « grep » via son
;; nom de fichier absolu au lieu de le chercher dans $PATH.
(lambda* (#:key outputs #:allow-other-keys)
(let* ((out (assoc-ref outputs "out"))
(bin (string-append out "/bin")))
(substitute* (list (string-append bin "/egrep")
(string-append bin "/fgrep"))
(("^exec grep")
(string-append "exec " bin "/grep")))))))
Dans l’exemple ci-dessous, les phases sont modifiées de deux façons : la
phase standard configure
est supprimée, vraisemblablement parce que
le paquet n’a pas de script configure ou quelque chose de similaire,
et la phase par défaut install
est remplacée par une phase qui copie
manuellement les fichiers exécutables à installer :
(modify-phases %standard-phases
(delete 'configure) ;pas de script « configure »
(replace 'install
(lambda* (#:key outputs #:allow-other-keys)
;; Le Makefile du paquet ne fournit pas de règle « install »
;; alors on le fait nous-mêmes.
(let ((bin (string-append (assoc-ref outputs "out")
"/bin")))
(install-file "footswitch" bin)
(install-file "scythe" bin)))))
Il est courant qu’une commande ait besoin que certaines variables d’environnement soient initialisées pour fonctionner correctement, souvent des chemins de recherche (voir Chemins de recherche). Sans cela, la commande peut échouer à trouver les fichiers et les autres commandes dont elle a besoin, ou elle pourrait trouver la « mauvaise » dépendance — en dépendant de l’environnement sur lequel elle tourne. Voici quelques exemples :
PATH
;
GUILE_LOAD_PATH
et GUILE_LOAD_COMPILED_PATH
;
QT_PLUGIN_PATH
.
Pour l’auteur ou l’autrice d’un paquet, le but est de s’assurer que les
commandes fonctionnent toujours pareil plutôt que de dépendre de paramètres
externes. Une manière d’y arriver est d’envelopper les commandes dans
un petit script qui défini ces variables d’environnement, ce qui assure que
ces dépendances à l’exécution seront trouvées. L’enveloppe serait utilisée
pour initialiser PATH
, GUILE_LOAD_PATH
ou QT_PLUGIN_PATH
dans les exemple ci-dessus.
Pour faciliter cette tâche, le module (guix build utils)
fournit
quelques fonctions auxiliaires pour envelopper des commandes.
Crée une enveloppe pour programme. variables doit ressembler à ceci :
'(variable délimiteur position liste-de-répertoires)
où délimiteur est facultatif. :
sera utilisé si
délimiteur n’est pas fourni.
Par exemple, cet appel :
(wrap-program "toto"
'("PATH" ":" = ("/gnu/.../titi/bin"))
'("CERT_PATH" suffix ("/gnu/.../tata/certs"
"/qux/certs")))
copiera toto dans .toto-real et créera le fichier toto avec le contenu suivant :
#!emplacement/de/bin/bash export PATH="/gnu/.../titi/bin" export CERT_PATH="$CERT_PATH${CERT_PATH:+:}/gnu/.../tata/certs:/qux/certs" exec -a $0 emplacement/de/.foo-real "$@"
Si programme a déjà été enveloppé par wrap-program
, l’enveloppe
est agrandie avec les définitions de variables. Sinon, sh sera
utilisé comme interpréteur.
Enveloppe le script programme pour que variables soient définie
avant. Le format de variables est le même que pour la procédure
wrap-program
. Cette procédure est différente de wrap-program
car elle ne crée pas de script shell séparé. Au lieu de cela, program
est modifié directement en ajoutant un script Guile au début, qui est
interprété comme un commentaire par le langage de script.
Les commentaires à l’encodage spécifique pris en charge par Python sont recréés sur la seconde ligne.
Remarquez que cette procédure ne peut être utilisée qu’une seule fois par fichier car les scripts Guile ne sont pas pris en charge.
Suivant: Le dépôt, Précédent: Utilitaires de construction, Monter: Interface de programmation [Table des matières][Index]
De nombreux programmes et bibliothèques cherchent leurs données d’entrée dans un chemin de recherch, une liste de répertoire : les shells comme Bash cherchent des exécutables dans le chemin de recherche des commandes, un compilateur C cherche des fichiers .h dans son chemin de recherche d’en-têtes, l’interpréteur Python cheche des fichiers .py dans son chemin de recherche, le correcteur orthographique a un chemin de recherche pour les dictionnaires, et cætera.
Les chemins de recherche peuvent habituellement être définis ou remplacés
par des variables d’environnement (voir Environment Variables dans le
manuel de référence de la bibliothèque C de GNU). Par exemple, les chemins
de recherches mentionnés ci-dessus peuvent être modifiés en définissant les
variables d’environnement PATH
, C_INCLUDE_PATH
, PYTHONPATH
(ou GUIX_PYTHONPATH
) et DICPATH
— vous savez, toutes ces
variables comme PATH que vous devez paramétrer correctement sous peine de
voir les choses « non trouvée ».
Vous aurez peut-être remarqué en utilisant la ligne de commande, Guix « sait
» quelles variables d’environnement de chemin de recherche doivent être
définies et comment. Quand vous installez des paquets dans votre profil par
défaut, le fichier ~/.guix-profile/etc/profile est créé, et vous
pouvez le « sourcer » à partir du shell pour initialiser ces variables. De
même, si vous demandez à guix shell
de créer un environnement
contenant Python et NumPy, une bibliothèque Python, et que vous passez
l’option --search-paths, il vous parlera de PATH
et
GUIX_PYTHONPATH
(voir Invoquer guix shell
) :
$ guix shell python python-numpy --pure --search-paths export PATH="/gnu/store/…-profile/bin" export GUIX_PYTHONPATH="/gnu/store/…-profile/lib/python3.9/site-packages"
Si vous omettez --search-paths, il défini ces variables d’environnement directement, si bien que Python peut immédiatement trouver NumPy :
$ guix shell python python-numpy -- python3 Python 3.9.6 (default, Jan 1 1970, 00:00:01) [GCC 10.3.0] on linux Type "help", "copyright", "credits" or "license" for more information. >>> import numpy >>> numpy.version.version '1.20.3'
Pour que cela fonctionne, la définition du paquet python
déclare le chemin de recherche qui l’intéresse et sa variable
d’environnement associée, GUIX_PYTHONPATH
. Cela ressemble à ceci :
(package
(name "python")
(version "3.9.9")
;; quelques champs omis...
(native-search-paths
(list (search-path-specification
(variable "GUIX_PYTHONPATH")
(files (list "lib/python/3.9/site-packages"))))))
Ce qui ce champ native-search-paths
signifie que lorsque le paquet
python
est utilisé, la variable d’environnement GUIX_PYTHONPATH
doit être définie et inclure tous les sous-répertoires
lib/python/3.9/site-packages rencontrés dans son
environnement. (native-
signifie que, dans un environnement de
compilation croisée, seules les entrées natives seront ajoutées au chemin de
recherche ; voir search-paths
.) Dans l’exemple
NumPy ci-dessus, le profil où python
apparait contient exactement un
de ces sous-répertoires, et GUIX_PYTHONPATH
est initialisé à cette
valeur. Lorsqu’il y a plusieurs lib/python/3.9/site-packages —
c’est le cas dans l’environnement de construction des paquets — ils sont
ajoutés à GUIX_PYTHONPATH
, séparés par des deux-points (:
).
Remarque : Remarquez que
GUIX_PYTHONPATH
est spécifié dans la définition du paquetpython
, et pas dans celle depython-numpy
. C’est parce que cette variable d’environnement « appartient » à Python, pas à NumPy : Python lit effectivement la valeur de cette variable et la prend en compte.Corollaire : si vous créez un profil qui ne contient pas
python
,GUIX_PYTHONPATH
ne sera pas défini, même s’il contient des paquets qui fournissent des fichiers .py :$ guix shell python-numpy --search-paths --pure export PATH="/gnu/store/…-profile/bin"Cela a plus de sens si on considère ce profil individuellement : aucun logiciel de ce profil ne lirait
GUIX_PYTHONPATH
.
Bien sûr, il y a de nombreuses variations sur ce thème : certains paquets
prennent en compte plus d’un chemin de recherche, certains utiliser d’autres
séparateurs que le deux-points, certains accumulent plusieurs répertoires
dans leur chemin de recherche, etc. Un exemple plus complexe est le chemin
de recherche de libxml2 : la valeur de la variable d’environnement
XML_CATALOG_FILES
utilise des espaces pour séparer ses composants,
elle doit contenir une liste de fichiers catalog.xml (pas des
répertoires), qui doivent se trouver dans des sous-répertoires xml
— rien de moins. La spécification du chemin de recherche ressemble à ceci
:
(search-path-specification
(variable "XML_CATALOG_FILES")
(separator " ")
(files '("xml"))
(file-pattern "^catalog\\.xml$")
(file-type 'regular))
Ne vous inquiétez pas, les spécifications de chemins de recherche ne sont généralement pas aussi complexes.
Le module (guix search-paths)
défini le type de donnée des
spécifications de chemins de recherche et un certain nombre de procédures
auxiliaires. Vous trouverez ci-dessous la référence des spécifications de
chemins de recherche.
Le type de données représentant les spécifications de chemins de recherche.
variable
le nom de la variable d’environnement pour ce chemin de recherche (une chaine).
files
La liste des sous-répertoires (des chaines) qui devraient être ajoutés au chemin de recherche.
separator
(par défaut : ":"
)La chaine utilisée pour séparer les composants du chemin de recherche.
Un cas spécial, quand separator
vaut #f
, signifie qu’il n’y a
« qu’un composant au chemin de recherche » — en d’autres termes, le chemin
de recherche ne peut contenir plus d’un élément. C’est utile dans certains
cas, comme la variable SSL_CERT_DIR
(prise en compte par OpenSSL,
cURL, et quelques autres paquets) ou la variable ASPELL_DICT_DIR
(prise en compte par le correcteur orthographique GNU Aspell), toutes deux
devant pointer vers un unique répertoire.
file-type
(par défaut : 'directory
)Le type de fichier qui doit être trouvé — 'directory
ou
'regular
, même si cela peut aussi être n’importe quel symbole renvoyé
par stat:type
(voir stat
dans le manuel de
référence de Guile).
In the XML_CATALOG_FILES
example above, we would match regular files;
in the Python example, we would match directories.
file-pattern
(par défaut : #f
)Cela doit être soit #f
, soit une expression régulière qui spécifie
les fichiers à trouver à l’intérieur des sous-répertoires spécifiés
par le champ files
.
Again, the XML_CATALOG_FILES
example shows a situation where this is
needed.
Certains chemins de recherche ne sont pas liés à une seul paquet, mais à
plusieurs. Pour réduire la duplication, certains sont prédéfinis dans
(guix search-paths)
.
These two search paths indicate where the TR9401 catalog22 or XML catalog files can be found.
Ces deux chemins de recherche indiquent où trouver les certificats X.509 (voir Certificats X.509).
Ces chemins de recherche prédéfinis peuvent être utilisés comme dans l’exemple suivant :
(package
(name "curl")
;; certains champs sont omis ...
(native-search-paths (list $SSL_CERT_DIR $SSL_CERT_FILE)))
Comment transformer des spécifications de chemins de recherche d’un côté en
et un tas de répertoire de l’autre en un ensemble de définitions de
variables d’environnement ? C’est le travail de
evaluate-search-paths
.
Évalue search-paths, une liste de spécifications de chemins de recherche, par rapport à directories, une liste de noms de répertoires, et renvoie une liste de paires de spécification / valeur. Utilise getenv pour déterminer les paramètres actuel et rapporter seulement les paramètres qui ne sont pas déjà en place.
Le module (guix profiles)
fournit une procédure auxiliaire de
haut-niveau, load-profile
, qui met en place les variables
d’environnement d’un profil.
Suivant: Dérivations, Précédent: Chemins de recherche, Monter: Interface de programmation [Table des matières][Index]
Conceptuellement, le dépôt est l’endroit où les dérivations qui ont bien été construites sont stockées — par défaut, /gnu/store. Les sous-répertoires dans le dépôt s’appellent des éléments du dépôt ou parfois des chemins du dépôt. Le dépôt a une base de données associée qui contient des informations comme les chemins du dépôt auxquels se réfèrent chaque chemin du dépôt et la liste des éléments du dépôt valides — les résultats d’une construction réussie. Cette base de données se trouve dans localstatedir/guix/db où localstatedir est le répertoire d’états spécifié via --localstatedir à la configuration, typiquement /var.
C’est toujours le démon qui accède au dépôt pour le compte de ses
clients (voir Invoquer guix-daemon
). Pour manipuler le dépôt, les
clients se connectent au démon par un socket Unix-domain, envoient une
requête dessus et lisent le résultat — ce sont des appels de procédures
distantes, ou RPC.
Remarque : Les utilisateurs ne doivent jamais modifier les fichiers dans /gnu/store directement. Cela entraînerait des incohérences et casserait l’hypothèse d’immutabilité du modèle fonctionnel de Guix (voir Introduction).
Voir
guix gc --verify
, pour des informations sur la manière de vérifier l’intégrité du dépôt et d’essayer de réparer des modifications accidentelles.
Le module (guix store)
fournit des procédures pour se connecter au
démon et pour effectuer des RPCs. Elles sont décrites plus bas. Par
défaut, open-connection
, et donc toutes les commandes guix
se connectent au démon local ou à l’URI spécifiée par la variable
d’environnement GUIX_DAEMON_SOCKET
.
Lorsqu’elle est initialisée, la valeur de cette variable devrait être un nom de fichier ou une URI qui désigne l’extrémité du démon. Lorsque c’est un nom de fichier, il dénote un socket Unix-domain où se connecter. En plus des noms de fichiers, les schémas d’URI supportés sont :
file
unix
Pour les sockets Unix-domain. file:///var/guix/daemon-socket/socket
est équivalent à /var/guix/daemon-socket/socket.
guix
¶Ces URI dénotent des connexions par TCP/IP, sans chiffrement ni authentification de l’hôte distant. L’URI doit spécifier le nom d’hôte et éventuellement un numéro de port (par défaut 44146) :
guix://master.guix.example.org:1234
Ce paramétrage est adapté aux réseaux locaux, comme dans le cas de grappes
de serveurs, où seuls des noms de confiance peuvent se connecter au démon de
construction sur master.guix.example.org
.
L’option --listen
de guix-daemon
peut être utilisé pour lui
dire d’écouter les connexions TCP (voir --listen).
ssh
¶Ces URI vous permettent de vous connecter à un démon distant via SSH.
Cette fonctionnalité nécessite Guile-SSH (voir Prérequis) et un
binaire guile
fonctionnel dans PATH
sur la machine de
destination. Elle prend en charge l’authentification par clé publique et
GSSAPI. Une URL typique pourrait ressembler à ceci :
ssh://charlie@guix.example.org:22
Comme pour guix copy
, les fichiers de configuration du client
OpenSSH sont pris en compte (voir Invoquer guix copy
).
Des schémas d’URI supplémentaires pourraient être supportés dans le futur.
Remarque : La capacité de se connecter à un démon de construction distant est considéré comme expérimental à la version f977cb2. Contactez-nous pour partager vos problèmes ou des suggestions que vous pourriez avoir (voir Contribuer).
Se connecte au démon à travers le socket Unix-domain à uri (une chaîne de caractères). Lorsque reserve-space? est vrai, cela demande de réserver un peu de place supplémentaire sur le système de fichiers pour que le ramasse-miette puisse opérer au cas où le disque serait plein. Renvoie un objet serveur.
file prend par défaut la valeur %default-socket-path
, qui est
l’emplacement normal compte tenu des options qui ont été passées à
configure
.
Ferme la connexion au serveur.
Cette variable est liée à un paramètre SRFI-39, qui se réfère au port où les journaux de construction et d’erreur envoyés par le démon devraient être écrits.
Les procédures qui font des RPC prennent toutes un objet serveur comme premier argument.
Renvoie #t
lorsque path désigne un élément valide du dépôt et
#f
sinon (un élément invalide peut exister sur le disque mais être
toujours invalide, par exemple parce qu’il est le résultat d’une
construction avortée ou échouée).
Une condition &store-protocol-error
est levée si path n’est pas
préfixée par le répertoire du dépôt (/gnu/store).
Ajoute text dans le fichier name dans le dépôt et renvoie son chemin. references est la liste des chemins du dépôt référencés par le chemin du dépôt qui en résulte.
Construit derivations, une liste d’objets <derivation>
, de noms
de fichiers .drv, ou de paires dérivation/sortie, en utilisant le
mode—(build-mode normal)
spécifié par défaut.
Remarque que le module (guix monads)
fournit une monade ainsi que des
version monadiques des procédures précédentes, avec le but de rendre plus
facile de travailler avec le code qui accède au dépôt (voir La monade du dépôt).
Cette section est actuellement incomplète.
Suivant: La monade du dépôt, Précédent: Le dépôt, Monter: Interface de programmation [Table des matières][Index]
Les actions de construction à bas-niveau et l’environnement dans lequel elles sont effectuées sont représentés par des dérivations. Une dérivation contient cet ensemble d’informations :
x86_64-linux
.
Les dérivations permettent aux client du démon de communiquer des actions de
construction dans le dépôt. Elles existent sous deux formes : en tant que
représentation en mémoire, à la fois côté client et démon, et en tant que
fichiers dans le dépôt dont le nom finit par .drv
— on dit que ce
sont des chemins de dérivations. Les chemins de dérivations peuvent
être passés à la procédure build-derivations
pour effectuer les
actions de construction qu’ils prescrivent (voir Le dépôt).
Des opérations comme le téléchargement de fichiers et la récupération de sources gérés par un logiciel de contrôle de version pour lesquels le hash du contenu est connu à l’avance sont modélisés par des dérivations à sortie fixe. Contrairement aux dérivation habituelles, les sorties d’une dérivation à sortie fixe sont indépendantes de ses entrées — p.ex. un code source téléchargé produit le même résultat quelque soit la méthode de téléchargement utilisée.
Les sorties des dérivations — c.-à-d. les résultats de la construction —
ont un ensemble de références, comme le rapporte le RPC
references
ou la commande guix gc --references
(voir Invoquer guix gc
). Les références sont l’ensemble des dépendances
à l’exécution des résultats de la construction. Les références sont un
sous-ensemble des entrées de la dérivation ; ce sous-ensemble est
automatiquement calculé par le démon de construction en scannant tous les
fichiers dans les sorties.
Le module (guix derivations)
fournit une représentation des
dérivations comme des objets Scheme, avec des procédures pour créer et
manipuler des dérivations. La primitive de plus bas-niveau pour créer une
dérivation est la procédure derivation
:
Construit une dérivation avec les arguments donnés et renvoie l’objet
<derivation>
obtenu.
Lorsque hash et hash-algo sont donnés, une dérivation à sortie fixe est créée — c.-à-d. une dérivation dont le résultat est connu à l’avance, comme dans le cas du téléchargement d’un fichier. Si, en plus, recursive? est vrai, alors la sortie fixe peut être un fichier exécutable ou un répertoire et hash doit être le hash d’une archive contenant la sortie.
Lorsque references-graphs est vrai, il doit s’agir d’une liste de paires de noms de fichiers et de chemins du dépôt. Dans ce cas, le graphe des références de chaque chemin du dépôt est exporté dans l’environnement de construction dans le fichier correspondant, dans un simple format texte.
Lorsque allowed-references est vrai, il doit s’agir d’une liste d’éléments du dépôt ou de sorties auxquelles la sortie de la dérivations peut faire référence. De même, disallowed-references, si vrai, doit être une liste de choses que la sortie ne doit pas référencer.
Lorsque leaked-env-vars est vrai, il doit s’agir d’une liste de
chaînes de caractères qui désignent les variables d’environnements qui
peuvent « fuiter » de l’environnement du démon dans l’environnement de
construction. Ce n’est possible que pour les dérivations à sortie fixe —
c.-à-d. lorsque hash est vrai. L’utilisation principale est de
permettre à des variables comme http_proxy
d’être passées aux
dérivations qui téléchargent des fichiers.
Lorsque local-build? est vrai, déclare que la dérivation n’est pas un bon candidat pour le déchargement et devrait plutôt être construit localement (voir Utiliser le dispositif de déchargement). C’est le cas des petites dérivations où le coût du transfert de données est plus important que les bénéfices.
Lorsque que substitutable? est faux, déclare que les substituts de la sortie de la dérivation ne devraient pas être utilisés (voir Substituts). Cela est utile par exemple pour construire des paquets qui utilisent des détails du jeu d’instruction du CPU hôte.
properties doit être une liste d’association décrivant les « propriétés » de la dérivation. Elle est gardée telle-quelle, sans être interprétée, dans la dérivation.
Voici un exemple avec un script shell comme constructeur, en supposant que store est une connexion ouverte au démon et bash pointe vers un exécutable Bash dans le dépôt :
(use-modules (guix utils) (guix store) (guix derivations)) (let ((builder ; ajoute le script Bash au dépôt (add-text-to-store store "my-builder.sh" "echo hello world > $out\n" '()))) (derivation store "toto" bash `("-e" ,builder) #:inputs `((,bash) (,builder)) #:env-vars '(("HOME" . "/homeless")))) ⇒ #<derivation /gnu/store/…-toto.drv => /gnu/store/…-toto>
Comme on pourrait s’en douter, cette primitive est difficile à utiliser
directement. Une meilleure approche est d’écrire les scripts de
construction en Scheme, bien sur ! Le mieux à faire pour cela est d’écrire
le code de construction comme une « G-expression » et de la passer à
gexp->derivation
. Pour plus d’informations, voir G-Expressions.
Il fut un temps où gexp->derivation
n’existait pas et où construire
une dérivation donc le code de construction était écrit en Scheme se faisait
avec build-expression->derivation
, documenté plus bas. Cette
procédure est maintenant obsolète, remplacée par gexp->derivation
qui
est meilleure.
Renvoie une dérivation qui exécute l’expression Scheme exp comme un
constructeur pour la dérivation name. inputs doit être une
liste de tuples (name drv-path sub-drv)
; lorsque sub-drv est
omis, "out"
est utilisé. modules est une liste de noms de
modules Guile du chemin de recherche actuel qui seront copiés dans le dépôt,
compilés et rendus disponibles dans le chemin de chargement pendant
l’exécution de exp — p. ex. ((guix build utils) (guix build
gnu-build-system))
.
exp est évaluée dans une environnement où %outputs
est lié à
une liste de paires de sortie/chemin, et où %build-inputs
est lié à
une liste de paires de chaînes de caractères et de chemin de sortie
construite à partir de inputs. Éventuellement, env-vars est une
liste de paires de chaînes de caractères spécifiant le nom et la valeur de
variables d’environnement visibles pour le constructeur. Le constructeur
termine en passant le résultat de exp à exit
; ainsi, lorsque
exp renvoie #f
, la construction est considérée en échec.
exp est construite avec guile-for-build (une dérivation).
Lorsque guile-for-build est omis où est #f
, la valeur du fluide
%guile-for-build
est utilisée à la place.
Voir la procédure derivation
pour la signification de
references-graph, allowed-references,
disallowed-references, local-build? et substitutable?.
Voici un exemple de dérivation à sortie unique qui crée un répertoire avec un fichier :
(let ((builder '(let ((out (assoc-ref %outputs "out"))) (mkdir out) ; create /gnu/store/…-goo (call-with-output-file (string-append out "/test") (lambda (p) (display '(hello guix) p)))))) (build-expression->derivation store "goo" builder)) ⇒ #<derivation /gnu/store/…-goo.drv => …>
Suivant: G-Expressions, Précédent: Dérivations, Monter: Interface de programmation [Table des matières][Index]
Les procédures qui travaillent sur le dépôt décrites dans les sections précédentes prennent toutes une connexion ouverte au démon de construction comme premier argument. Bien que le modèle sous-jacent soit fonctionnel, elles ont soit des effets de bord, soit dépendent de l’état actuel du dépôt.
Le premier point est embêtant : on doit se balader avec la connexion au démon dans toutes ces fonctions, ce qui rend impossible le fait de composer des fonctions qui ne prennent pas ce paramètre avec des fonctions qui le prennent. Le deuxième point est problématique : comme les opérations sur le dépôt ont des effets de bord ou dépendent d’états externes, elles doivent être enchaînés correctement.
C’est là que le module (guix monads)
arrive à la rescousse. Ce
module fournit un cadre pour travailler avec des monads, en
particulier une monade très utile pour notre usage, la monade du
dépôt. Les monades sont des constructions qui permettent deux choses :
associer un « contexte » avec une valeur (dans notre cas, le contexte est le
dépôt) et construire une séquence de calculs (ici les calculs comprennent
des accès au dépôt). Les valeurs dans une monade — les valeurs qui
contiennent ce contexte supplémentaire — sont appelées des valeurs
monadiques ; les procédures qui renvoient ce genre de valeur sont appelées
des procédures monadiques.
Considérez cette procédure « normale » :
(define (sh-symlink store)
;; Renvoie une dérivation qui crée un lien symbolique vers l'exécutable « bash ».
(let* ((drv (package-derivation store bash))
(out (derivation->output-path drv))
(sh (string-append out "/bin/bash")))
(build-expression->derivation store "sh"
`(symlink ,sh %output))))
En utilisant (guix monads)
et (guix gexp)
, on peut la réécrire
en une fonction monadique :
(define (sh-symlink)
;; Pareil, mais renvoie une valeur monadique.
(mlet %store-monad ((drv (package->derivation bash)))
(gexp->derivation "sh"
#~(symlink (string-append #$drv "/bin/bash")
#$output))))
Il y a plusieurs choses à remarquer avec cette deuxième version : le
paramètre store
est maintenant implicitement « enfilé » dans les
appels aux procédures monadiques package->derivation
et
gexp->derivation
, et la valeur monadique renvoyée par
package->derivation
est liée avec mlet
plutôt qu’avec un
simple let
.
Il se trouve que l’appel à package->derivation
peut même être omis
puisqu’il aura lieu implicitement, comme nous le verrons plus tard
(voir G-Expressions) :
(define (sh-symlink)
(gexp->derivation "sh"
#~(symlink (string-append #$bash "/bin/bash")
#$output)))
L’appel à la procédure monadique sh-symlink
n’a aucun effet. Comme
on pourrait le dire, « on sort d’une monade comme de la monarchie : en
l’exécutant »23. Donc, pour sortir de la monade et obtenir l’effet escompté, on
doit utiliser run-with-store
:
(run-with-store (open-connection) (sh-symlink)) ⇒ /gnu/store/...-sh-symlink
Remarquez que le module (guix monad-repl)
étend la console Guile avec
de nouvelles « commandes » pour rendre plus facile la manipulation de
procédures monadiques : run-in-store
et enter-store-monad
(voir Utiliser Guix de manière interactive). La première est utilisée pour « lancer
» une seule valeur monadique à travers le dépôt :
scheme@(guile-user)> ,run-in-store (package->derivation hello) $1 = #<derivation /gnu/store/…-hello-2.9.drv => …>
La deuxième entre dans une console récursive, où toutes les valeurs de retour sont automatiquement lancées à travers le dépôt :
scheme@(guile-user)> ,enter-store-monad store-monad@(guile-user) [1]> (package->derivation hello) $2 = #<derivation /gnu/store/…-hello-2.9.drv => …> store-monad@(guile-user) [1]> (text-file "toto" "Hello!") $3 = "/gnu/store/…-toto" store-monad@(guile-user) [1]> ,q scheme@(guile-user)>
Remarquez qu’on ne peut pas renvoyer de valeur non monadique dans la console
store-monad
.
D’autres méta-commandes sont disponibles sur la REPL, comme ,build
pour construire un objet simili-fichier (voir Utiliser Guix de manière interactive).
Les formes syntaxiques principales pour utiliser des monades en général sont
disponibles dans le module (guix monads)
et sont décrites ci-dessous.
Évalue n’importe quelle forme >>=
ou return
dans body
comme une monad.
Renvoie une valeur monadique qui encapsule val.
Lie une valeur monadique mval, en passant son « contenu » aux
procédures monadiques mproc…24. Il peut y avoir une ou plusieurs mproc
, comme dans
cet exemple :
(run-with-state (with-monad %state-monad (>>= (return 1) (lambda (x) (return (+ 1 x))) (lambda (x) (return (* 2 x))))) 'some-state) ⇒ 4 ⇒ some-state
Lie les variables var aux valeurs monadiques mval dans
body, une séquence d’expressions. Comme avec l’opérateur de liaison,
on peut réfléchir comme si on « ouvrait » la valeur non-monadique « contenue
» dans mval et comme si on faisait en sorte que var se réfère à
cette valeur pure, non-monadique, dans la portée de body. La forme
(var -> val) lie var à la valeur « normale » val,
comme let
. L’opération de liaison a lieu en séquence de la gauche
vers la droite. La dernière expression de body doit être une
expression monadique et son résultat deviendra le résultat de mlet
ou
mlet*
lorsque lancé dans la monad.
mlet*
est à mlet
ce que let*
est à let
(voir Local Bindings dans GNU Guile Reference Manual).
Lie mexp et les expressions monadiques suivantes en séquence, et renvoie le résultat de la dernière expression. Chaque expression dans la séquence doit être une expression monadique.
Cette procédure est similaire à mlet
, sauf que les valeurs de retour
des expressions monadiques sont ignorées. Dans ce sens, elle est analogue à
begin
, mais appliqué à des expressions monadiques.
Lorsque la condition est vraie, évalue la séquence des expressions
monadiques mexp0..mexp* comme dans un mbegin
. Lorsque la
condition est fausse, renvoie *unspecified*
dans la monade
actuelle. Chaque expression dans la séquence doit être une expression
monadique.
Lorsque la condition est fausse, évalue la séquence des expressions
monadiques mexp0..mexp* comme dans un mbegin
. Lorsque la
condition est vraie, renvoie *unspecified*
dans la monade
actuelle. Chaque expression dans la séquence doit être une expression
monadique.
Le module (guix monads)
fournit la monade d’état qui permet à
une valeur supplémentaire — l’état — d’être enfilée à travers les appels de
procédures.
La monade d’état. les procédure dans la monade d’état peuvent accéder et modifier l’état qui est enfilé.
Considérez l’exemple ci-dessous. La procédure square
renvoie une
valeur dans la monade d’état. Elle renvoie le carré de son argument, mais
incrémente aussi la valeur actuelle de l’état :
(define (square x) (mlet %state-monad ((count (current-state))) (mbegin %state-monad (set-current-state (+ 1 count)) (return (* x x))))) (run-with-state (sequence %state-monad (map square (iota 3))) 0) ⇒ (0 1 4) ⇒ 3
Lorsque c’est « lancé » à travers %state-monad
, nous obtenons cette
valeur d’état supplémentaire, qui est le nombre d’appels au square
.
Renvoie l’état actuel dans une valeur monadique.
Initialise l’état actuel à value et renvoie l’état précédent dans une valeur monadique.
Pousse value sur l’état actuel, qui est supposé être une liste, et renvoie l’état précédent dans une valeur monadique.
Récupère (pop) une valeur dans l’état actuel et la renvoie comme une valeur monadique. L’état est supposé être une liste.
Lance la valeur monadique mval avec state comme valeur initiale. Renvoie deux valeurs : la valeur du résultat et l’état du résultat.
L’interface principale avec la monade du dépôt, fournit par le module
(guix store)
, est la suivante.
La monade du dépôt — un alias pour %state-monad
.
Les valeurs dans la monade du dépôt encapsulent les accès vers le dépôt.
Lorsque son effet est nécessaire, une valeur de la monade du dépôt doit être
« évaluée » en la passant à la procédure run-with-store
(voir
ci-dessous).
Lance mval, une valeur monadique dans la monade du dépôt, dans store, une connexion ouvert au dépôt.
Renvoie une valeur monadique correspondant au nom de fichier dans le dépôt du fichier contenant text, une chaîne de caractères. references est une liste d’éléments du dépôt auxquels le fichier texte en résultat se réfère ; c’est la liste vide par défaut.
Renvoie une valeur monadique correspondant au nom de fichier absolu dans le dépôt du fichier contenant data, un vecteur d’octets. references est une liste d’éléments du dépôt auxquels le fichier binaire en résultat se réfère ; c’est la liste vide par défaut.
Renvoie le nom de file une fois ajouté au dépôt. Utilise name comme nom dans le dépôt ou le nom de fichier de file si name est omis.
Lorsque recursive? est vraie, le contenu de file est ajouté récursivement ; si file désigne un fichier simple et que recursive? est vrai, son contenu est ajouté et ses bits de permissions sont préservés.
Lorsque recursive? est vraie, appelle (select? file
stat)
pour chaque répertoire où file est le nom de fichier
absolu de l’entrée et stat est le résultat de lstat
; à
l’exception des entrées pour lesquelles select? ne renvoie pas vrai.
L’exemple ci-dessous ajoute un fichier au dépôt, sous deux noms différents :
(run-with-store (open-connection) (mlet %store-monad ((a (interned-file "README")) (b (interned-file "README" "LEGU-MIN"))) (return (list a b)))) ⇒ ("/gnu/store/rwm…-README" "/gnu/store/44i…-LEGU-MIN")
Le module (guix packages)
exporte les procédures monadiques liées aux
paquets suivantes :
Renvoie une valeur monadique qui contient le nom de fichier absolu de file dans le répertoire output de package. Lorsque file est omis, renvoie le nom du répertoire output de package. Lorsque target est vrai, l’utilise comme un triplet de cible pour la compilation croisée.
Notez que cette procédure ne permet pas de construire package. Ainsi, le résultat peut ou non désigner un fichier existant. Nous vous recommandons de ne pas utiliser cette procédure si vous ne savez pas ce que vous faites.
Version monadique de package-derivation
et
package-cross-derivation
(voir Définition des paquets).
Suivant: Invoquer guix repl
, Précédent: La monade du dépôt, Monter: Interface de programmation [Table des matières][Index]
On a donc des « dérivations » qui représentent une séquence d’actions de
construction à effectuer pour produire un élément du dépôt
(voir Dérivations). Ces actions de construction sont effectuées
lorsqu’on demande au démon de construire effectivement les dérivations ;
elles sont lancées par le démon dans un conteneur (voir Invoquer guix-daemon
).
Ça ne devrait pas vous surprendre, mais nous aimons écrire ces actions de
construction en Scheme. Lorsqu’on fait ça, on fini avec deux strates
de code Scheme25 : le « code hôte » — le code qui définit
les paquets, parle au démon, etc. — et le « code côté construction » — le
code qui effectue effectivement les actions de construction, comme créer des
répertoires, invoquer make
, etc. (voir Phases de construction).
Pour décrire une dérivation et ses actions de construction, on a typiquement
besoin d’intégrer le code de construction dans le code hôte. Ça revient à
manipuler le code de construction comme de la donnée, et l’homoiconicité de
Scheme — le code a une représentation directe en tant que donnée — est très
utile pour cela. Mais on a besoin de plus que le mécanisme de
quasiquote
en Scheme pour construire des expressions de construction.
Le module (guix gexp)
implémente les G-expressions, une forme
de S-expression adaptée aux expressions de construction. Les G-expression,
ou gexps, consistent en gros en trois formes syntaxiques :
gexp
, ungexp
et ungexp-splicing
(ou plus simplement :
#~
, #$
et #$@
), qui sont comparable à
quasiquote
, unquote
et unquote-splicing
respectivement
(voir quasiquote
dans GNU Guile Reference
Manual). Cependant il y a des différences majeures :
Ce mécanisme n’est pas limité aux paquets et aux objets de dérivation : Des
compilateurs capables d’ « abaisser » d’autres objets de haut niveau
vers des dérivations ou des fichiers dans le dépôt peuvent être définis, de
sorte que ces objets peuvent également être insérés dans des gexps. Par
exemple, un type utile d’objets de haut niveau pouvant être insérés dans un
gexp est celui des « objets de type fichier », qui permettent d’ajouter
facilement des fichiers au dépôt et d’y faire référence dans des dérivations
et autres (voir local-file
et plain-file
ci-dessous).
Pour illustrer cette idée, voici un exemple de gexp :
(define build-exp
#~(begin
(mkdir #$output)
(chdir #$output)
(symlink (string-append #$coreutils "/bin/ls")
"list-files")))
Cette gexp peut être passée à gexp->derivation
; on obtient une
dérivation qui construit un répertoire contenant exactement un lien
symbolique à /gnu/store/…-coreutils-8.22/bin/ls :
(gexp->derivation "the-thing" build-exp)
Comme on pourrait s’y attendre, la chaîne
"/gnu/store/…-coreutils-8.22"
est substituée à la place de la
référence au paquet coreutils dans le code de construction final, et
coreutils est automatiquement devenu une entrée de la dérivation. De
même, #$output
(équivalent à (ungexp output)
) est remplacé par
une chaîne de caractères contenant le nom du répertoire de la sortie de la
dérivation.
Dans le contexte d’une compilation croisée, il est utile de distinguer entre
des références à la construction native d’un paquet — qui peut être
lancé par l’hôte — et des références à la construction croisée d’un paquet.
Pour cela, #+
joue le même rôle que #$
, mais référence une
construction native d’un paquet :
(gexp->derivation "vi"
#~(begin
(mkdir #$output)
(mkdir (string-append #$output "/bin"))
(system* (string-append #+coreutils "/bin/ln")
"-s"
(string-append #$emacs "/bin/emacs")
(string-append #$output "/bin/vi")))
#:target "aarch64-linux-gnu")
Dans l’exemple ci-dessus, la construction native de coreutils est
utilisée, pour que ln
puisse effectivement être lancé sur l’hôte ;
mais ensuite la construction croisée d’emacs est utilisée.
Une autre fonctionnalité, ce sont les modules importés : parfois vous
voudriez pouvoir utiliser certains modules Guile de « l’environnement hôte »
dans la gexp, donc ces modules devraient être importés dans «
l’environnement de construction ». La forme with-imported-modules
vous permet d’exprimer ça :
(let ((build (with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils))
(mkdir-p (string-append #$output "/bin"))))))
(gexp->derivation "empty-dir"
#~(begin
#$build
(display "success!\n")
#t)))
Dans cet exemple, le module (guix build utils)
est automatiquement
récupéré dans l’environnement de construction isolé de notre gexp, pour que
(use-modules (guix build utils))
fonctionne comme on s’y attendrait.
Typiquement, vous voudriez que la closure complète du module soit
importé — c.-à-d. le module lui-même et tous les modules dont il dépend —
plutôt que seulement le module ; sinon, une tentative de chargement du
module échouera à cause des modules dépendants manquants. La procédure
source-module-closure
calcule la closure d’un module en cherchant
dans ses en-têtes sources, ce qui est pratique dans ce cas :
(use-modules (guix modules)) ;pour 'source-module-closure' (with-imported-modules (source-module-closure '((guix build utils) (gnu build image))) (gexp->derivation "something-with-vms" #~(begin (use-modules (guix build utils) (gnu build image)) …)))
Dans la même idée, parfois vous pouvez souhaiter importer non seulement des
modules en Scheme pur, mais aussi des « extensions » comme des liaisons
Guile de bibliothèques C ou d’autres paquet « complets ». Disons que vous
voulez utiliser le paquet guile-json
du côté de la construction,
voici comme procéder :
(use-modules (gnu packages guile)) ;pour 'guile-json' (with-extensions (list guile-json) (gexp->derivation "something-with-json" #~(begin (use-modules (json)) …)))
La forme syntaxique pour construire des gexps est résumée ci-dessous.
Renvoie une G-expression contenant exp. exp peut contenir une ou plusieurs de ces formes :
#$obj
(ungexp obj)
Introduit une référence à obj. obj peut être d’un des types
supportés, par exemple un paquet ou une dérivation, auquel cas la forme
ungexp
est remplacée par le nom de fichier de sa sortie — p. ex.
"/gnu/store/…-coreutils-8.22
.
Si boj est une liste, elle est traversée et les références aux objets supportés sont substitués de manière similaire.
Si obj est une autre gexp, son contenu est inséré et ses dépendances sont ajoutées à celle de la gexp qui l’entoure.
Si obj est un autre type d’objet, il est inséré tel quel.
#$obj:output
(ungexp obj output)
Cette forme est similaire à la précédente, mais se réfère explicitement à la sortie output de l’objet obj — c’est utile lorsque obj produit plusieurs sorties (voir Des paquets avec plusieurs résultats).
Sometimes a gexp unconditionally refers to the "out"
output, but the
user of that gexp would still like to insert a reference to another output.
The gexp-input
procedure aims to address that. Voir gexp-input.
#+obj
#+obj:output
(ungexp-native obj)
(ungexp-native obj output)
Comme ungexp
, mais produit une référence à la construction
native de obj lorsqu’elle est utilisée dans une compilation
croisée.
#$output[:output]
(ungexp output [output])
Insère une référence à la sortie output de la dérivation, ou à la sortie principale lorsque output est omis.
Cela ne fait du sens que pour les gexps passées à gexp->derivation
.
#$@lst
(ungexp-splicing lst)
Comme au dessus, mais recolle (splice) le contenu de lst dans la liste qui la contient.
#+@lst
(ungexp-native-splicing lst)
Comme au dessus, mais se réfère à la construction native des objets listés dans lst.
Les G-expressions créées par gexp
ou #~
sont des objets
d’exécution du type gexp?
(voir ci-dessous).
Marque les gexps définies dans body… comme requérant modules dans leur environnement d’exécution.
Chaque élément dans module peut être le nom d’un module, comme
(guix build utils)
ou le nom d’un module suivi d’une flèche, suivie
d’un objet simili-fichier :
`((guix build utils) (guix gcrypt) ((guix config) => ,(scheme-file "config.scm" #~(define-module …))))
Dans l’exemple au dessus, les deux premiers modules sont récupérés dans le chemin de recherche, et le dernier est créé à partir d’un objet simili-fichier.
Cette forme a une portée lexicale : elle a un effet sur les gexp directement définies dans body…, mais pas sur celles définies dans des procédures appelées par body….
Marque les gexps définies dans body… comme requérant
extensions dans leur environnement de construction et d’exécution.
extensions est typiquement une liste d’objets paquets comme définis
dans le module (gnu packages guile)
.
Concrètement, les paquets listés dans extensions sont ajoutés au chemin de chargement lors de la compilation des modules importés dans body… ; ils sont aussi ajoutés au chemin de chargement de la gexp renvoyée par body….
Renvoie #t
si obj est une G-expression.
Les G-expressions sont conçues pour être écrites sur le disque, soit en tant que code pour construire une dérivation, soit en tant que fichier normal dans le dépôt. Les procédures monadiques suivantes vous permettent de faire cela (voir La monade du dépôt, pour plus d’information sur les monads).
%load-path
] [#:effective-version "2. 2"] [#:references-graphs #f] [#:allowed-references #f] [#:disallowed-references #f] [#:leaked-env-vars #f] [#:script-name (string-append name "-builder")] [#:deprecation-warnings #f] [#:local-build ? #f] [#:substituable ? #t] [#:properties '()] [#:guile-for-build #f]Renvoie une dérivation name qui exécute exp (un gexp) avec guile-for-build (une dérivation) sur system ; exp est stocké dans un fichier appelé script-name. Lorsque target est vrai, il est utilisé comme le triplet cible de compilation croisée pour les paquets auxquels exp fait référence.
modules est devenu obsolète en faveur de
with-imported-modules
. Sa signification est de rendre modules
disponibles dans le contexte d’évaluation de exp ; modules est
une liste de noms de modules Guile qui sont cherchés dans module-path
pour les copier dans le dépôt, les compiler et les rendre disponibles dans
le chemin de chargement pendant l’exécution de exp — p. ex.
((guix build utils) (guix build gnu-build-system))
.
effective-version détermine la chaîne à utiliser lors d’ajout
d’extensions de exp (voir with-extensions
) au chemin de
recherche — p. ex. "2.2"
.
graft? détermine si les paquets référencés par exp devraient être greffés si possible.
Lorsque references-graphs est vrai, il doit s’agir d’une liste de tuples de la forme suivante :
(file-name obj) (file-name obj output) (file-name gexp-input) (file-name store-item)
La partie droite des éléments de references-graphs est automatiquement transformée en une entrée du processus de construction exp. Dans l’environnement de construction, chaque file-name contient le graphe des références de l’élément correspondant, dans un format texte simple.
allowed-references doit soit être #f
, soit une liste de noms de
sorties ou de paquets. Dans ce dernier cas, la liste dénote les éléments du
dépôt auxquels le résultat a le droit de faire référence. Toute référence à
un autre élément du dépôt conduira à une erreur à la construction. Comme
pour disallowed-references, qui peut lister des éléments qui ne
doivent pas être référencés par les sorties.
deprecation-warnings détermine s’il faut afficher les avertissement
d’obsolescence à la compilation de modules. Il peut valoir #f
,
t
ou 'detailed
.
Les autres arguments sont les mêmes que pour derivation
(voir Dérivations).
Les procédures local-file
, plain-file
, computed-file
,
program-file
et scheme-file
ci-dessous renvoient des
objets simili-fichiers. C’est-à-dire, lorsqu’ils sont unquotés dans
une G-expression, ces objets donnent un fichier dans le dépôt. Considérez
cette G-expression :
#~(system* #$(file-append glibc "/sbin/nscd") "-f" #$(local-file "/tmp/my-nscd.conf"))
Ici, l’effet est « d’internaliser » /tmp/my-nscd.conf en le copiant
dans le dépôt. Une fois étendu, par exemple via gexp->derivation
, la
G-expression se réfère à cette copie dans /gnu/store ; ainsi,
modifier ou supprimer le fichier dans /tmp n’a aucun effet sur ce que
fait la G-expression. plain-file
peut être utilisé de la même
manière ; elle est seulement différente par le fait que le contenu du
fichier est passé directement par une chaîne de caractères.
Renvoie un objet représentant le fichier local file à ajouter au magasin ; cet objet peut être utilisé dans un gexp. Si file est une chaîne littérale désignant un nom de fichier relatif, il est recherché par rapport au fichier source où il apparaît ; si file n’est pas une chaîne littérale, il est recherché par rapport au répertoire de travail courant au moment de l’exécution. file sera ajouté au dépôt sous name–par défaut le nom de base de file.
Lorsque recursive? est vraie, le contenu de file est ajouté récursivement ; si file désigne un fichier simple et que recursive? est vrai, son contenu est ajouté et ses bits de permissions sont préservés.
Lorsque recursive? est vraie, appelle (select? file
stat)
pour chaque répertoire où file est le nom de fichier
absolu de l’entrée et stat est le résultat de lstat
; à
l’exception des entrées pour lesquelles select? ne renvoie pas vrai.
file can be wrapped in the assume-valid-file-name
syntactic
keyword. When this is done, there will not be a warning when
local-file
is used with a non-literal path. The path is still looked
up relative to the current working directory at run time. Wrapping is done
like this:
(define alice-key-file-path "alice.pub") ;; ... (local-file (assume-valid-file-name alice-key-file-path))
file can be wrapped in the assume-source-relative-file-name
syntactic keyword. When this is done, the file name will be looked up
relative to the source file where it appears even when it is not a string
literal.
C’est la version déclarative de la procédure monadique interned-file
(voir interned-file
).
Renvoie un objet représentant un fichier texte nommé name avec pour contenu content (une chaîne de caractères ou un vecteur d’octets) à ajouter un dépôt.
C’est la version déclarative de text-file
.
Renvoie un objet représentant l’élément du dépôt name, un fichier ou
un répertoire calculé par gexp. Lorsque local-build? est vrai
(par défaut), la dérivation est construite localement. options est
une liste d’arguments supplémentaires à passer à gexp->derivation
.
C’est la version déclarative de gexp->derivation
.
Renvoie un script exécutable name qui exécute exp en utilisant guile, avec les modules importés de exp dans son chemin de recherche. Recherchez les modules de exp dans module-path.
L’exemple ci-dessous construit un script qui invoque simplement la commande
ls
:
(use-modules (guix gexp) (gnu packages base)) (gexp->script "list-files" #~(execl #$(file-append coreutils "/bin/ls") "ls"))
Lorsqu’elle est « lancée » à travers le dépôt (voir run-with-store
), on obtient une dérivation qui produit une fichier
exécutable /gnu/store/…-list-files qui ressemble à :
#!/gnu/store/…-guile-2.0.11/bin/guile -ds !# (execl "/gnu/store/…-coreutils-8.22"/bin/ls" "ls")
Renvoie un objet représentant un élément du dépôt name qui lance gexp. guile est le paquet Guile à utiliser pour exécuter le script. Les modules importés par gexp sont recherchés dans module-path.
C’est la version déclarative de gexp->script
.
Renvoie une dérivation qui construit un fichier name contenant exp. Lorsque splice? est vrai, exp est considéré comme une liste d’expressions qui seront splicée dans le fichier qui en résulte.
Lorsque set-load-path? est vrai, émet du code dans le fichier de
résultat pour initialiser %load-path
et %load-compiled-path
pour prendre en compte les modules importés de exp. Les modules de
exp sont trouvés dans module-path.
Le fichier qui en résulte retient les références à toutes les dépendances de exp ou un sous-ensemble.
file name that contains exp. guile is the Guile package used to produce that file.
C’est la version déclarative de gexp->file
.
Renvoie une valeur monadique qui construit un ficher texte contenant text. text peut lister, en plus de chaînes de caractères, des objet de n’importe quel type qui peut être utilisé dans une gexp : des paquets, des dérivations, des fichiers objet locaux, etc. Le fichier du dépôt qui en résulte en retient toutes les références.
Cette variante devrait être préférée à text-file
lorsque vous
souhaitez créer des fichiers qui référencent le dépôt. Cela est le cas
typiquement lorsque vous construisez un fichier de configuration qui
contient des noms de fichiers du dépôt, comme ceci :
(define (profile.sh)
;; Renvoie le nom d'un script shell dans le dépôt qui initialise
;; la variable d'environnement « PATH ».
(text-file* "profile.sh"
"export PATH=" coreutils "/bin:"
grep "/bin:" sed "/bin\n"))
Dans cet exemple, le fichier /gnu/store/…-profile.sh qui en résulte référence coreutils, grep et sed, ce qui les empêche d’être glanés tant que le script est accessible.
Renvoie un objet représentant le fichier du dépôt name contenant text. text est une séquence de chaînes de caractères et de fichiers simili-objets, comme dans :
(mixed-text-file "profile"
"export PATH=" coreutils "/bin:" grep "/bin")
C’est la version déclarative de text-file*
.
Renvoie un <computed-file>
qui construit un répertoire qui contient
tous les fichiers de files. Chaque élément de files doit être
une paire où le premier élément est le nom de fichier à utiliser dans le
nouveau répertoire et le second élément est une gexp dénotant le fichier
cible. Voici un exemple :
(file-union "etc"
`(("hosts" ,(plain-file "hosts"
"127.0.0.1 localhost"))
("bashrc" ,(plain-file "bashrc"
"alias ls='ls --color=auto'"))))
Cela crée un répertoire etc
contenant ces deux fichiers.
Renvoie un répertoire qui est l’union de things, où things est une liste d’objets simili-fichiers qui dénotent des répertoires. Par exemple :
(directory-union "guile+emacs" (list guile emacs))
crée un répertoire qui est l’union des paquets guile
et emacs
.
Renvoie un objet simili-fichier qui correspond à la concaténation de obj et suffix où obj est un objet abaissable et chaque suffix est une chaîne de caractères.
Par exemple, considérez cette gexp :
(gexp->script "run-uname"
#~(system* #$(file-append coreutils
"/bin/uname")))
On peut obtenir le même effet avec :
(gexp->script "run-uname"
#~(system* (string-append #$coreutils
"/bin/uname")))
Il y a une différence cependant : dans le cas file-append
, le script
qui en résulte contient le nom de fichier absolu comme une chaîne de
caractère alors que dans le deuxième cas, le script contient une expression
(string-append …)
pour construire le nom de fichier à
l’exécution.
Lier system au système actuellement visé—par exemple,
"x86_64-linux"
—dans body.
Dans le second cas, lier également target à la cible de compilation
croisée actuelle–un triplet GNU tel que "arm-linux-gnueabihf"
—ou
#f
si nous ne faisons pas de compilation croisée.
let-system
est utile occasionellement dans le cas où l’objet raccordé
au gexp dépend de la cible sur le système cible, comme dans cet exemple :
#~(system* #+(let-system system (cond ((string-prefix? "armhf-" system) (file-append qemu "/bin/qemu-system-arm")) ((string-prefix? "x86_64-" system) (file-append qemu "/bin/qemu-system-x86_64")) (else (error "dunno!")))) "-net" "user" #$image)
Cette macro est similaire à la forme parameterize
pour les
paramètres liés dynamiquement (voir Parameters dans GNU Guile
Reference Manual). La principale différence est qu’il prend effet lorsque
l’objet de type fichier renvoyé par exp est abaissé à un élément de
dérivation ou de stockage.
Une utilisation typique de with-parameters
consiste à forcer le
système en vigueur pour un objet donné :
(with-parameters ((%current-system "i686-linux"))
coreutils)
L’exemple ci-dessus renvoie un objet qui correspond à la version i686 de
Coreutils, quelle que soit la valeur actuelle de %current-système
.
Return a gexp input record for the given output of file-like
object obj, with #:native?
determining whether this is a native
reference (as with ungexp-native
) or not.
This procedure is helpful when you want to pass a reference to a specific output of an object to some procedure that may not know about that output. For example, assume you have this procedure, which takes one file-like object:
(define (make-symlink target)
(computed-file "the-symlink"
#~(symlink #$target #$output)))
Here make-symlink
can only ever refer to the default output of
target—the "out"
output (voir Des paquets avec plusieurs résultats). To have it refer to, say, the "lib"
output of the
hwloc
package, you can call it like so:
(make-symlink (gexp-input hwloc "lib"))
You can also compose it like any other file-like object:
(make-symlink
(file-append (gexp-input hwloc "lib") "/lib/libhwloc.so"))
Bien sûr, en plus de gexps inclues dans le code « hôte », certains modules
contiennent des outils de construction. Pour savoir facilement qu’ils sont
à utiliser dans la strate de construction, ces modules sont gardés dans
l’espace de nom (guix build …)
.
En interne, les objets de haut-niveau sont abaissés, avec leur
compilateur, soit en des dérivations, soit en des objets du dépôt. Par
exemple, abaisser un paquet crée une dérivation, et abaisser un
plain-file
crée un élément du dépôt. Cela est effectué par la
procédure monadique lower-object
.
Renvoie comme valeur dans %store-monad
la dérivation ou l’élément de
dépôt correspondant à obj pour system, en effectuant une
compilation croisée pour target si target est vrai. obj
doit être un objet auquel est associé un compilateur gexp, tel qu’un
<package>
.
Il peut parfois être utile de convertir une G-expression en
S-expression. Par exemple, certains outils d’analyse statique de style (dits
« linters », voir Invoquer guix lint
) vérifient les phases de compilation
des paquets pour détecter des problèmes potentiels. Cette conversion peut
être réalisée avec cette procédure. Toutefois, certaines informations
peuvent être perdues au cours de l’opération. Plus spécifiquement, les
objets abaissables seront remplacés silencieusement par un objet arbitraire
– pour l’instant la liste (*approximate*)
, mais cela pourrait
changer.
Suivant: Utiliser Guix de manière interactive, Précédent: G-Expressions, Monter: Interface de programmation [Table des matières][Index]
guix repl
La commande guix repl
facilite la programmation de Guix dans Guile
en lançant une boucle Guile read-eval-print. (REPL) pour la
programmation interactive (voir Using Guile Interactively dans GNU
Guile Reference Manual), ou en exécutant des scripts Guile (voir (GNU Guile Reference Manual)guile). Par rapport au simple
lancement de la commande guile
, guix repl
garantit que
tous les modules Guix et toutes ses dépendances sont disponibles dans le
chemin de recherche.
La syntaxe générale est :
guix repl option fichier args]
Lorsqu’un argument file est fourni, file est exécuté comme un script Guile :
guix repl mon-script.scm
Pour passer des arguments au script, utilisez --
pour éviter qu’ils
ne soient interprétés comme des arguments pour guix repl
lui-même
:
guix repl -- mon-script.scm --input=toto.txt
Pour rendre exécutable un script directement depuis le shell, en utilisant l’exécutable guix qui se trouve dans le chemin de recherche utilisateur·rice, ajoutez les deux lignes suivantes en haut du script :
#!/usr/bin/env -S guix repl --
!#
Pour écrire un script qui lance une REPL interactive directement depuis le
shell, utilisez le drapeau --interactive
:
#!/usr/bin/env -S guix repl --interactive
!#
En l’absence d’un argument de nom de fichier, une REPL guile est lancé, ce qui permet de l’utiliser de manière interactive (voir Utiliser Guix de manière interactive) :
$ guix repl scheme@(guile-user)> ,use (gnu packages base) scheme@(guile-user)> coreutils $1 = #<package coreutils@8.29 gnu/packages/base.scm:327 3e28300>
En plus, guix repl
implémente un protocole REPL simple lisible par
une machine à utiliser avec (guix inferior)
, un dispositif pour
interagir avec des inférieurs, des processus séparés qui font tourner
une version potentiellement différente de Guix.
Les options disponibles sont les suivantes :
--list-types
Affiche les options de TYPE pour guix repl --type=TYPE
et
quitte.
--type=type
-t type
Démarrer un REPL du type donné, qui peut être l’un de ces types :
guile
C’est la valeur par défaut. Elle démarre un REPL Guile standard fonctionnel.
machine
Démarre un REPL qui utilise le protocole lisible par machine. C’est le
protocole que parle le module (guix inferior)
.
--listen=extrémité
Par défaut, guix repl
lit depuis l’entrée standard et écrit sur la
sortie standard. Lorsque cette option est passée, il écoutera plutôt les
connexions sur endpoint. Voici un exemple d’options valides :
--listen=tcp:37146
Accepte les connexions sur localhost, sur le port 31.
--listen=unix:/tmp/socket
Accepte les connexions sur le socket Unix-domain /tmp/socket.
--interactive
-i
Lance la REPL interactive après avoir exécuté file.
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles au script ou au REPL.
-q
Inhiber le chargement du fichier ~/.guile. Par défaut, ce fichier de
configuration est chargé lors de la création d’un fichier
guile
. REPL.
Précédent: Invoquer guix repl
, Monter: Interface de programmation [Table des matières][Index]
La commande guix repl
vous donne accès à une
boucle-lecture-évalutation-affichage (BLÉA ou REPL en anglais)
chaleureuse et amicale (voir Invoquer guix repl
). Si vous commencez la
programmation avec Guix — pour définir vos propres paquets, écrire des
manifestes, définir des services pour le système Guix ou Guix Home, etc —
vous la trouverez sans doute pratique pour jouer avec vos idées sur la REPL.
Si vous utilisez Emacs, le moyen le plus pratique pour cela est d’utiliser
Geiser (voir La configuration parfaite), mais vous n’avez pas besoin d’utiliser
Emacs pour profiter de la REPL. Lorsque vous utilisez guix repl
ou guile
dans un terminal, nous vous recommandons d’utiliser
Readline pour la complétion et Colorized pour avoir une sortie colorée. Pour
cela, vous pouvez lancer :
guix install guile guile-readline guile-colorized
… puis créer un fichier .guile dans votre répertoire personnel, contenant ceci :
(use-modules (ice-9 readline) (ice-9 colorized)) (activate-readline) (activate-colorized)
La REPL vous permet d’évaluer du code Scheme ; vous tapez une expression Scheme sur l’invite, et la REPL affiche ce en quoi elle s’évalue :
$ guix repl scheme@(guix-user)> (+ 2 3) $1 = 5 scheme@(guix-user)> (string-append "a" "b") $2 = "ab"
Ça devient plus intéressant quand vous commencez à jouer avec Guix sur la
REPL. La première chose à faire est « d’importer » le module (guix)
,
qui vous donne accès à la partie principale de l’interface de programmation,
et peut-être à un ensemble de modules Guix utiles. Vous pouvez taper
(use-modules (guix))
, ce qui est du code Scheme valide pour importer
un module (voir Using Guile Modules dans manuel de référence de GNU
Guile), mais la REPL fournit la commande use
comme raccourci
(voir REPL Commands dans manuel de référence de GNU Guile) :
scheme@(guix-user)> ,use (guix) scheme@(guix-user)> ,use (gnu packages base)
Remarquez que les commandes de la REPL sont introduites par une virgule. Une
commande REPL comme use
n’est pas du code Scheme valide, elle est
interprétée de manière spéciale par la REPL.
Guix étend la REPL Guile avec des commandes supplémentaires pour votre
confort. Parmi celles-ci, la commande build
est pratique : elle
s’assure que l’objet simili-fichier donné est construit, en le construisant
si nécessaire, et renvoie le nom de fichier de sa sortie. Dans l’exemple
ci-dessous, nous construisons les paquets coreutils
et grep
,
ainsi qu’un « fichiers calculé » (voir computed-file
), et nous utilisons la procédure scandir
pour
lister les fichiers du répertoire /bin
de Grep :
scheme@(guix-user)> ,build coreutils $1 = "/gnu/store/…-coreutils-8.32-debug" $2 = "/gnu/store/…-coreutils-8.32" scheme@(guix-user)> ,build grep $3 = "/gnu/store/…-grep-3.6" scheme@(guix-user)> ,build (computed-file "x" #~(mkdir #$output)) construction de /gnu/store/…-x.drv... $4 = "/gnu/store/…-x" scheme@(guix-user)> ,use(ice-9 ftw) scheme@(guix-user)> (scandir (string-append $3 "/bin")) $5 = ("." ".." "egrep" "fgrep" "grep")
As a packager, you may be willing to inspect the build phases or flags of a given package; this is particularly useful when relying a lot on inheritance to define package variants (voir Définition de variantes de paquets) or when package arguments are a result of some computation, both of which can make it harder to foresee what ends up in the package arguments. Additional commands let you inspect those package arguments:
scheme@(guix-user)> ,phases grep $1 = (modify-phases %standard-phases (add-after 'install 'fix-egrep-and-fgrep (lambda* (#:key outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (bin (string-append out "/bin"))) (substitute* (list (string-append bin "/egrep") (string-append bin "/fgrep")) (("^exec grep") (string-append "exec " bin "/grep"))))))) scheme@(guix-user)> ,configure-flags findutils $2 = (list "--localstatedir=/var") scheme@(guix-user)> ,make-flags binutils $3 = '("MAKEINFO=true")
À plus bas niveau, une commande utile est lower
: elle prend un objet
simili-fichier et l’« abaisse » en une dérivation (voir Dérivations) ou
un fichier du dépôt :
scheme@(guix-user)> ,lower grep $6 = #<derivation /gnu/store/…-grep-3.6.drv => /gnu/store/…-grep-3.6 7f0e639115f0> scheme@(guix-user)> ,lower (plain-file "x" "Hello!") $7 = "/gnu/store/…-x"
La liste complète des commandes de la REPL se trouvent en tapant ,help
guix
et est donnée ci-dessous pour référence.
Abaisse objet et le construit s’il n’est pas déjà construit, et renvoie le nom de fichier de ses sorties.
Abaisse objet en une dérivation ou un nom de fichier du dépôt et le renvoie.
Change la verbosité des construction à niveau.
C’est similaire à l’option en ligne de commande --verbosity (voir Options de construction communes) : le niveau 0 signifie le silence total, le niveau 1 montre les événements de construction et les niveaux plus élevés affichent les journaux de construction.
These REPL commands return the value of one element of the arguments
field of package (voir Référence de package
): the first one show the
staged code associated with #:phases
(voir Phases de construction), the
second shows the code for #:configure-flags
, and ,make-flags
returns the code for #:make-flags
.
Lance exp, une expression monadique dans la monade du dépôt. Voir La monade du dépôt, pour plus d’information.
Entre dans une nouvelle REPL pour évaluer des expressions monadiques
(voir La monade du dépôt). Vous pouvez quitter la REPL « interne » en tapant
,q
.
Suivant: Architectures externes, Précédent: Interface de programmation, Monter: GNU Guix [Table des matières][Index]
Cette section décrit les utilitaires en ligne de commande de Guix. certains sont surtout faits pour les personnes qui écrivent de nouvelles définitions de paquets tandis que d’autres sont plus utiles pour une utilisation générale. Ils complètent l’interface de programmation Scheme de Guix d’une manière pratique.
guix build
guix edit
guix download
guix hash
guix import
guix refresh
guix style
guix lint
guix size
guix graph
guix publish
guix challenge
guix copy
guix container
guix weather
guix processes
Suivant: Invoquer guix edit
, Monter: Utilitaires [Table des matières][Index]
guix build
La commande guix build
construit des paquets ou des dérivations et
leurs dépendances et affiche les chemins du dépôt qui en résulte. Remarquez
qu’elle ne modifie pas le profil de l’utilisateur — c’est le travail de la
commande guix package
(voir Invoquer guix package
). Ainsi,
elle est surtout utile pour les personnes qui développent la distribution.
La syntaxe générale est :
guix build options package-or-derivation…
Par exemple, la commande suivante construit la dernière version d’Emacs et de Guile, affiche leur journaux de construction et enfin affiche les répertoires des résultats :
guix build emacs guile
De même, la commande suivante construit tous les paquets disponibles :
guix build --quiet --keep-going \ $(guix package -A | awk '{ print $1 "@" $2 }')
package-or-derivation peut être soit le nom d’un paquet trouvé dans la
distribution logicielle comme coreutils
, soit coreutils@8.20
,
soit une dérivation comme /gnu/store/…-coreutils-8.19.drv.
Dans le premier cas, la commande cherchera un paquet avec le nom
correspondant (et éventuellement la version) dans les modules de la
distribution GNU (voir Modules de paquets).
Autrement, l’option --expression peut être utilisée pour spécifier une expression Scheme qui s’évalue en un paquet ; c’est utile lorsqu’il est nécessaire de faire la distinction entre plusieurs paquets ou variantes de paquets portant le même nom.
Il peut y avoir aucune, une ou plusieurs options. Les options disponibles sont décrites dans les sous-sections ci-dessous.
Suivant: Options de transformation de paquets, Monter: Invoquer guix build
[Table des matières][Index]
Un certain nombre d’options qui contrôlent le processus de construction sont
communes avec guix build
et les autres commandes qui peuvent
générer des constructions, comme guix package
ou guix
archive
. Voici ces options :
--load-path=répertoire
-L répertoire
Ajoute répertoire au début du chemin de recherche de module de paquets (voir Modules de paquets).
Cela permet à des utilisateurs de définir leur propres paquets et les rendre disponibles aux outils en ligne de commande.
--keep-failed
-K
Garde l’arborescence de construction des constructions en échec. Ainsi, si une construction échoue, son arborescence de construction est préservée dans /tmp, dans un répertoire dont le nom est affiché à la fin du journal de construction. Cela est utile pour déboguer des échecs de construction. Voir Débogage des échecs de construction, pour des astuces sur la manière de déboguer des problèmes de construction.
Cette option implique --no-offload, et elle n’a pas d’effet quand
elle est connectée à un démon distant avec une guix://
URI
(voir the GUIX_DAEMON_SOCKET
variable).
--keep-going
-k
Continue lorsque certaines dérivations échouent ; ne s’arrête que lorsque toutes les constructions ont soit réussies, soit échouées.
Le comportement par défaut est de s’arrêter dès qu’une des dérivations spécifiées échoue.
--dry-run
-n
Ne pas construire les dérivations.
--fallback
Lorsque la substitution d’un binaire pré-compilé échoue, construit les paquets localement à la place (voir Échec de substitution).
--substitute-urls=urls
Considère urls comme une liste d’URL de sources de substituts séparés
par des espaces, et remplace la liste par défaut d’URL de
guix-daemon
(voir guix-daemon
URLs).
Cela signifie que les substituts peuvent être téléchargés depuis urls, tant qu’ils sont signés par une clef autorisée par l’administrateur système (voir Substituts).
Lorsque urls est la chaîne vide, cela a pour effet de désactiver la substitution.
--no-substitutes
Ne pas utiliser de substitut pour les résultats de la construction. C’est-à-dire, toujours construire localement plutôt que de permettre le téléchargement de binaires pré-construits (voir Substituts).
--no-grafts
Ne par « greffer » les paquets. En pratique, cela signifie que les mises à jour des paquets disponibles comme des greffes ne sont pas appliquées. Voir Mises à jour de sécurité, pour plus d’information sur les greffes.
--rounds=n
Construit chaque dérivation n fois d’affilé, et renvoie une erreur si les constructions consécutives ne sont pas identiques bit-à-bit.
Cela est une manière utile pour détecter des processus de construction non
déterministes. Les processus de construction non déterministes sont
problématiques car ils rendent pratiquement impossible la
vérification par les utilisateurs de l’authenticité de binaires
tiers. Voir Invoquer guix challenge
, pour plus d’informations.
Lorsqu’utilisé avec --keep-failed, la sortie différente est gardée dans le dépôt sous /gnu/store/…-check. Cela rend plus facile l’étude des différences entre les deux résultats.
--no-offload
N’essaye pas de décharger les constructions vers d’autres machines (voir Utiliser le dispositif de déchargement). C’est-à-dire que tout sera construit localement au lieu de décharger les constructions à une machine distante.
--max-silent-time=secondes
Lorsque le processus de construction ou de substitution restent silencieux pendant plus de secondes, le terminer et rapporter une erreur de construction.
Par défaut, le paramètre du démon est pris en compte (voir --max-silent-time).
--timeout=secondes
De même, lorsque le processus de construction ou de substitution dure plus de secondes, le terminer et rapporter une erreur de construction.
Par défaut, le paramètre du démon est pris en compte (voir --timeout).
-v [niveau]
--verbosity=niveau
Utiliser le niveau de verbosité, en tant qu’entier. 0 signifie qu’aucune sortie n’est produite, 1 signifie une sortie silencieuse ; 2 est similaire à 1 mais affiche aussi les URL des téléchargements ; 3 montre tous les journaux de construction sur la sortie d’erreur standard.
--cores=n
-c n
Permet d’utiliser jusqu’à n cœurs du CPU pour la construction. La
valeur spéciale 0
signifie autant de cœurs que possible.
--max-jobs=n
-M n
Permettre au maximum à n de construire des jobs en parallèle.
Voir --max-jobs, pour plus de détails sur
cette option et l’option équivalente guix-daemon
.
--debug=niveau
Produire une sortie de débogage qui provient du démon de construction. niveau doit être un entier entre 0 et 5 ; plus grand est ce nombre, plus verbeuse sera la sortie. Indiquer un niveau de 4 ou plus peut être utile pour déboguer des problèmes d’installation avec le démon de construction.
Sous le capot, guix build
est surtout une interface à la procédure
package-derivation
du module (guix packages)
, et à la
procédure build-derivations
du module (guix derivations)
.
En plus des options passées explicitement par la ligne de commande,
guix build
et les autres commandes guix
qui peuvent
effectuer des constructions prennent en compte la variable d’environnement
GUIX_BUILD_OPTIONS
.
Les utilisateurs peuvent définir cette variable à une liste d’options de la
ligne de commande qui seront automatiquement utilisées par guix
build
et les autres commandes guix
qui peuvent effectuer des
constructions, comme dans l’exemple suivant :
$ export GUIX_BUILD_OPTIONS="--no-substitutes -c 2 -L /toto/titi"
Ces options sont analysées indépendamment, et le résultat est ajouté aux options de la ligne de commande analysées.
Suivant: Options de construction supplémentaires, Précédent: Options de construction communes, Monter: Invoquer guix build
[Table des matières][Index]
Un autre ensemble d’options de la ligne de commande supportés par
guix build
et aussi guix package
sont les options
de transformation de paquets. Ce sont des options qui rendent possible la
définition de variantes de paquets — par exemple, des paquets
construit à partir de sources différentes. C’est une manière simple de
créer des paquets personnalisés à la volée sans avoir à taper les
définitions de variantes de paquets (voir Définition des paquets).
Les options de transformation des paquets sont préservées dans les mises à
jour : guix upgrade
tente d’appliquer aux paquets mis à jour les
options de transformation initialement utilisées lors de la création du
profil.
Les options disponibles sont énumérées ci-dessous. La plupart des commandes les prennent en charge, ainsi qu’une option --help-transform qui liste toutes les options disponibles et un synopsis (ces options ne sont pas affichées dans la sortie --help par souci de concision).
--tune[=cpu]
Utilise les versions des paquets marqués comme « réglables » optimisées pour
cpu. Lorsque cpu est native
, ou s’il est omis, règle pour
le CPU sur lequel la commande guix
est lancée.
Les noms de cpu valides sont ceux reconnus par le compilateur
sous-jacent, par défaut la collection de compilateurs de GNU (GCC). Sur les
processurs x86_64, cela comprend les noms des CPU comme nehalem
,
haswell
et skylake
(voir -march
dans Using the GNU Compiler Collection (GCC)).
Au fur et à mesure de la sortie de nouvelles générations de CPU, de nouvelles instructions sont ajoutées à l’ensemble d’instruction standard de l’architecture (ISA), en particulier des instructions pour le calcul parallèle instruction-unique/données-multiples (SIMD). Par exemple, alors que les CPU Core2 et Skylake implémentent tous deux l’ISA x86_64, seul ce dernier prend en charge les instructions SIMD AVX2.
Le principal bénéfice attendu de --tune est que les programmes
peuvent utiliser ces fonctionnalités SIMD et qu’ils n’ont pas déjà un
mécanisme pour choisir le bon code optimisé à l’exécution. Les paquets qui
possèdent la propriété tunable?
sont considérés comme des
paquets réglables par l’option --tune ; une définition de
paquet avec la bonne propriété ressemble à ceci :
(package
(name "hello-simd")
;; ...
;; Ce paquet peut bénéficier des extensions SIMD donc
;; on le marque « réglable ».
(properties '((tunable? . #t))))
Les autres paquets ne sont pas considérés comme réglables. Cela permet à Guix d’utiliser des binaires génériques dans le cas où le réglage pour un CPU particulier ne donnera probablement aucun avantage.
Les paquets réglés sont construits avec -march=CPU
; sous le
capot, l’option -march est passée à l’enveloppe par une enveloppe
du compilateur. Comme la machine de construction peut ne pas être capable de
lancer du code pour la micro-architecture CPU cible, la suite de tests n’est
pas lancée lors de la construction d’un paquet réglé.
Pour réduire les reconstructions au minimum, les paquets réglés sont greffés sur les paquets qui en dépendent (voir grafts). Ainsi, utiliser --no-grafts annule l’effet de --tune.
Nous appelons cette technique le multi-versionement des paquets : on peut construire plusieurs variantes d’un paquet réglable, une pour chaque variante de CPU. C’est la contrepartie à gros grain du multi-versionement fonctionnel implémenté par la chaine d’outils de GNU (voir Function Multiversioning dans Using the GNU Compiler Collection (GCC)).
--with-source=source
--with-source=paquet=source
--with-source=paquet@version=source
Utilise source comme la source de paquet, et version comme
son numéro de version. source doit être un nom de fichier ou une URL,
comme pour guix download
(voir Invoquer guix download
).
Lorsque paquet est omis, la commande utilisera le nom de paquet
spécifié par la base de source — p. ex. si source est
/src/guix-2.0.10.tar.gz
, le paquet correspondant est guile
.
De même, lorsque version est omis, la chaîne de version est inférée à
partir de source ; dans l’exemple précédent, il s’agit de
2.0.10
.
Cette option permet aux utilisateurs d’essayer des version des paquets
différentes de celles fournies par la distribution. L’exemple ci-dessous
télécharge ed-1.7.tar.g depuis un miroir GNU et l’utilise comme
source pour le paquet ed
:
guix build ed --with-source=mirror://gnu/ed/ed-1.4.tar.gz
En tant que développeur·euse, --with-source permet de tester facilement des version bêta, et même de vérifier leur impact sur les paquets qui en dépendent :
guix build elogind --with-source=…/shepherd-0.9.0rc1.tar.gz
… ou pour construire un dépôt de gestion de version dans un environnement vierge :
$ git clone git://git.sv.gnu.org/guix.git $ guix build guix --with-source=guix@1.0=./guix
--with-input=paquet=remplaçant
Remplace la dépendance sur paquet par une dépendance à
remplaçant. paquet doit être un nom de paquet et
remplaçant doit être une spécification de paquet comme guile
ou
guile@1.8
.
Par exemple, la commande suivante construit Guix, mais remplace sa
dépendance à la version stable actuelle de Guile par une dépendance à une
ancienne version de Guile, guile@2.2
:
guix build --with-input=guile=guile@2.2 guix
C’est un remplacement récursif profond. Donc dans cet exemple, à la fois
guix
et ses dépendances guile-json
(qui dépend aussi de
guile
) sont reconstruits avec guile@2.2
.
This is implemented using the package-input-rewriting/spec
Scheme
procedure (voir package-input-rewriting/spec
).
--with-graft=paquet=remplaçant
Cette option est similaire à --with-input mais avec une différence importante : plutôt que de reconstruire la chaîne de dépendance complète, remplaçant est construit puis greffé sur les binaires qui référençaient initialement paquet. Voir Mises à jour de sécurité, pour plus d’information sur les greffes.
Par exemple, la commande ci-dessous greffe la version 3.5.4 de GnuTLS sur Wget et toutes ses dépendances, en remplaçant les références à la version actuelle de GnuTLS à laquelle ils se réfèrent actuellement :
guix build --with-graft=gnutls=gnutls@3.5.4 wget
Cela a l’avantage d’être bien plus rapide que de tout reconstruire. Mais il y a un piège : cela ne fonctionne que si paquet et remplaçant sont strictement compatibles — par exemple, s’ils fournissent une bibliothèque, l’interface binaire applicative (ABI) de ces bibliothèques doivent être compatibles. Si remplaçant est incompatible avec paquet, alors le paquet qui en résulte peut devenir inutilisable. À utiliser avec précaution !
--with-debug-info=paquet
Construire paquet de manière à préserver ses informations de débogage
et les greffer sur les paquets qui en dépendent. Cela est utile si
paquet ne fournit pas déjà les informations de débogage sous forme de
sortie debug
(voir Installer les fichiers de débogage).
Par exemple, supposons que vous subissiez un plantage de Inkscape et que
vous vouliez voir ce qui se passe dans GLib, une bibliothèque au fond du
graphe de dépendance d’Inkscape. GLib n’a pas de sortie debug
, donc
le débogage est difficile. Heureusement, vous reconstruisez la GLib avec
les informations de débogage et vous l’installez dans Inkscape :
guix install inkscape --with-debug-info=glib
Seule GLib doit être recompilée, ce qui prend un temps raisonnable. Voir Installer les fichiers de débogage, pour plus d’informations.
Remarque : Sous le capot, cette option fonctionne en passant par le ‘#:strip-binaries ? #f’ au système de construction du paquet qui nous intéresse (voir Systèmes de construction). La plupart des systèmes de compilation supportent cette option, mais certains ne le font pas. Dans ce cas, une erreur se produit.
De même, si un paquet C/C++ est construit sans
-g
(ce qui est rarement le cas), les informations de débogage resteront indisponibles même si#:strip-binaries?
est faux.
--with-c-toolchain=package=toolchain
Cette option modifie la compilation de package et de tout ce qui en dépend afin qu’ils soient construits avec toolchain au lieu de la chaîne d’outils GNU par défaut pour C/C++.
Regardez cet exemple :
guix build octave-cli \ --with-c-toolchain=fftw=gcc-toolchain@10 \ --with-c-toolchain=fftwf=gcc-toolchain@10
La commande ci-dessus construit une variante des paquets fftw
et
fftwf
en utilisant la version 10 de gcc-toolchain
au lieu de
la chaîne d’outils par défaut, puis construit une variante de l’interface en
ligne de commande GNU Octave en les utilisant. GNU Octave
lui-même est également construit avec gcc-toolchain@10
.
Cet autre exemple construit la bibliothèque Hardware Locality (hwloc
)
et ses dépendances jusqu’à intel-mpi-benchmarks
avec le compilateur
Clang C :
guix build --with-c-toolchain=hwloc=clang-toolchain \ intel-mpi-benchmarks
Remarque : Il peut y avoir des incompatibilités d’interface binaire d’application (ABI) entre les chaînes d’outils. Cela est particulièrement vrai pour la bibliothèque standard C++ et les bibliothèques de support d’exécution telles que celle d’OpenMP. En reconstruisant toutes les dépendances avec la même chaîne d’outils, --with-c-toolchain minimise les risques d’incompatibilité mais ne peut pas les éliminer entièrement. Choisissez package judicieusement.
--with-git-url=paquet=url
¶Construire paquet depuis le dernier commit de la branche master
du dépôt sur url. Les sous-modules Git du dépôt sont récupérés,
récursivement.
Par exemple, la commande suivante construit la bibliothèque Python NumPy avec le dernier commit de la branche master de Python lui-même :
guix build python-numpy \ --with-git-url=python=https://github.com/python/cpython
Cette option peut aussi être combinée avec --with-branch ou --with-commit (voir plus bas).
Évidemment, comme cela utilise le dernier commit d’une branche donnée, le résultat d’une telle commande varie avec le temps. Néanmoins c’est une manière pratique pour reconstruire des piles logicielles entières avec le dernier commit d’un ou plusieurs paquets. C’est particulièrement pratique dans le contexte d’une intégration continue.
Les clones sont gardés dans un cache dans ~/.cache/guix/checkouts pour accélérer les accès consécutifs au même dépôt. Vous pourriez vouloir le nettoyer de temps en temps pour récupérer de l’espace disque.
--with-branch=paquet=branche
Construire paquet à partir du dernier commit de la branche. Si
le champ source
de paquet est une origine avec la méthode
git-fetch
(voir Référence de origin
) ou un objet git-checkout
,
l’URL du dépôt est récupérée à partir de cette source
. Sinon, vous
devez utiliser --with-git-url pour spécifier l’URL du dépôt Git.
Par exemple, la commande suivante construit guile-sqlite3
à partir du
dernier commit de sa branche master
, puis construit guix
(qui
en dépend) et cuirass
(qui dépend de guix
) avec cette
construction spécifique de guile-sqlite3
:
guix build --with-branch=guile-sqlite3=master cuirass
--with-commit=paquet=commit
Cela est similaire à --with-branch, sauf qu’elle construite à
partir de commit au lieu du sommet d’une branche. commit doit
être un identifiant SHA1 de commit Git valide, un tag ou un identifiant dans
le style de git describe
comme 1.0-3-gabc123
.
--with-patch=paquet=fichier
Ajoute fichier à la liste des correctifs appliqués à paquet, où
paquet est une spécification comme python@3.8
ou
glibc
. fichier doit contenir un correctif ; il est appliqué
avec les drapeaux spécifiés dans l’origin
de paquet
(voir Référence de origin
), qui par défaut inclus -p1
voir patch
Directories dans Comparing and Merging Files).
Par exemple, la commande ci-dessous reconstruit Coreutils avec la bibliothèque C de GNU (glibc) corrigée avec le correctif donné :
guix build coreutils --with-patch=glibc=./glibc-frob.patch
Dans cet exemple, glibc lui-meme ainsi que tout ce qui mène à Coreutils dans le graphe des dépendances est reconstruit.
--with-configure-flag=package=flag
Append flag to the configure flags of package, where
package is a spec such as guile@3.0
or glibc
. The
build system of package must support the #:configure-flags
argument.
For example, the command below builds GNU Hello with the configure flag
--disable-nls
:
guix build hello --with-configure-flag=hello=--disable-nls
The following command passes an extra flag to cmake
as it builds
lapack
:
guix build lapack \ --with-configure-flag=lapack=-DBUILD_SHARED_LIBS=OFF
Remarque : Under the hood, this option works by passing the ‘#:configure-flags’ argument to the build system of the package of interest (voir Systèmes de construction). Most build systems support that option but some do not. In that case, an error is raised.
--with-latest=paquet
--with-version=paquet=version
Alors vous aimez les toutes dernières technologies ? L’option
--with-latest est faite pour vous ! Elle remplace les occurrence de
paquet dans le graphe des dépendances avec sa toute dernière version
en amont, telle que rapportée par guix refresh
(voir Invoquer guix refresh
).
Elle fait cela en déterminant la dernière version publiée en amont (si possible), en la téléchargeant et en l’authentifiant si elle propose une signature OpenPGP.
Par exemple, la commande ci-dessous construit Guix avec la dernière version de Guile-JSON :
guix build guix --with-latest=guile-json
L’option --with-version fonctionne de manière identique sauf qu’il vous laisse spécifier la version spécifique, en supposant que cette version existe en amont. Par exemple, pour créer un environnement de développement avec SciPy construit avec la version 1.22.4 de NumPy (en sautant sa suite de tests parce que, bon, on ne va pas attendre aussi longtemps), vous pourriez lancer :
guix shell python python-scipy --with-version=python-numpy=1.22.4
Attention : Comme ils dépende du code source publié à un certain moment sur les serveurs en amont, les déploiements qui utilisent --with-latest et --with-version peuvent ne pas être reproductibles : la source peut disparaître ou être modifiée en place sur les serveurs.
Pour déployer d’anciennes versions sans compromis avec la reproductibilité, voir
guix time-machine
.
Il y a des limites. Déjà, dans les cas où l’outil ne peut pas ou ne sait pas comment authentifier le code source, vous risquez de charger du code malveillant ; un avertissement est émis dans ce cas. Ensuite, cette option change simplement la source utilisée dans les définitions existantes des paquets, ce qui n’est pas toujours suffisant : il peut y avoir des dépendances supplémentaires qui doivent être ajoutées, des correctifs à appliquer, et plus généralement tout le travail d’assurance qualité que les développeurs de Guix font habituellement sera absent.
On vous aura prévenu ! Lorsque vous pouvez accepter ces limitations, c’est une méthode pour rester à la hauteur qui a du punch ! Nous vous encourageons à soumettre des correctifs pour les définitions des paquets quand vous aurez testé une mise à jour avec --with-latest (voir Contribuer).
--without-tests=paquet
Construire paquet sans lancer la suite de tests. Cela peut être utile dans les situations où vous voulez éviter la longue série de tests d’un paquet intermédiaire, ou si une suite de tests de paquet échoue dans un mode non déterministe. Il doit être utilisé avec précaution car l’exécution de la suite de tests est un bon moyen de s’assurer qu’un paquet fonctionne comme prévu.
L’arrêt des tests conduit à un autre élément du dépôt. Par conséquent, lorsque vous utilisez cette option, tout ce qui dépend de paquet doit être reconstruit, comme dans cet exemple :
guix install --without-tests=python python-notebook
La commande ci-dessus installe python-notebook
par dessus
python
, construit sans exécuter sa suite de tests. Pour ce faire,
elle reconstruit également tout ce qui dépend de python
, y compris
python-notebook
lui-même.
En interne, --without-tests repose sur le changement de l’option
#:tests?
de la phase check
d’un paquet (voir Systèmes de construction). Notez que certains paquets utilisent une phase check
personnalisée qui ne respecte pas le paramètre #:tests? #f
. Par
conséquent, --without-tests n’a aucun effet sur ces paquets.
Vous vous demandez comme faire la même chose dans du code Scheme, par exemple dans votre manifeste, ou comme écrire votre propre transformation de paquets ? Voir Définition de variantes de paquets, pour un aperçu des interfaces de programmation disponibles.
Suivant: Débogage des échecs de construction, Précédent: Options de transformation de paquets, Monter: Invoquer guix build
[Table des matières][Index]
Les options de la ligne de commande ci-dessous sont spécifiques à
guix build
.
--quiet
-q
Construire silencieusement, sans afficher les journaux de construction ; c’est équivalent à --verbosity=0. À la fin, le journal de construction est gardé dans /var (ou similaire) et on peut toujours l’y trouver avec l’option --log-file.
--file=fichier
-f fichier
Construit le paquet, la dérivation ou l’objet simili-fichier en lequel le code dans file s’évalue (voir file-like objects).
Par exemple, file peut contenir une définition de paquet comme ceci (voir Définition des paquets) :
(use-modules (guix) (guix build-system gnu) (guix licenses)) (package (name "hello") (version "2.10") (source (origin (method url-fetch) (uri (string-append "mirror://gnu/hello/hello-" version ".tar.gz")) (sha256 (base32 "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i")))) (build-system gnu-build-system) (synopsis "Hello, GNU world: An example GNU package") (description "Guess what GNU Hello prints!") (home-page "http://www.gnu.org/software/hello/") (license gpl3+))
file peut également contenir une représentation JSON d’une ou
plusieurs définitions de paquets. L’exécution de guix build -f
sur
hello.json avec le contenu suivant entraînerait la construction des
paquets myhello
et greeter
:
[ { "name": "myhello", "version": "2.10", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "tests?": false }, "home-page": "https://www.gnu.org/software/hello/", "synopsis": "Hello, GNU world: An example GNU package", "description": "GNU Hello prints a greeting.", "license": "GPL-3.0+", "native-inputs": ["gettext"] }, { "name": "greeter", "version": "1.0", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "arguments": { "test-target": "foo", "parallel-build?": false }, "home-page": "https://example.com/", "synopsis": "Greeter using GNU Hello", "description": "This is a wrapper around GNU Hello.", "license": "GPL-3.0+", "inputs": ["myhello", "hello"] } ]
--manifest=manifest
-m manifest
Construire tous les paquets listés dans un manifest donné (voir --manifest).
--expression=expr
-e expr
Construit le paquet ou la dérivation en lequel expr s’évalue.
Par exemple, expr peut être (@ (gnu packages guile)
guile-1.8)
, qui désigne sans ambiguïté cette variante spécifique de la
version 1.8 de Guile.
Autrement, exp peut être une G-expression, auquel cas elle est
utilisée comme un programme de construction passé à gexp->derivation
(voir G-Expressions).
Enfin, expr peut se référer à une procédure monadique à au moins un
argument (voir La monade du dépôt). La procédure doit renvoyer une
dérivation comme une valeur monadique, qui est ensuite lancée à travers
run-with-store
.
--source
-S
Construit les dérivation source des paquets, plutôt que des paquets eux-mêmes.
Par exemple, guix build -S gcc
renvoie quelque chose comme
/gnu/store/…-gcc-4.7.2.tar.bz2, qui est l’archive des sources
de GCC.
L’archive des sources renvoyée est le résultat de l’application des
correctifs et des extraits de code éventuels spécifiés dans le champ
origin
du paquet (voir Définition des paquets).
Comme avec les autres dérivations, le résultat de la construction des sources peut être vérifié avec l’option --check (voir vérification de la construction). C’est utile pour valider que les source (éventuellement déjà construites ou substituées, donc en cache) correspondent au hash déclaré.
Notez que guix build -S
compile seulement les sources des paquets
spécifiés. Les sources de dépendances statiquement liées ne sont pas
incluses et sont en elles-mêmes insuffisantes pour reproduire les paquets.
--sources
Récupère et renvoie la source de package-or-derivation et toute ses dépendances, récursivement. C’est pratique pour obtenir une copie locale de tous les codes sources requis pour construire packages, ce qui vous permet de les construire plus tard même sans accès au réseau. C’est une extension de l’option --source et elle peut accepter l’un des arguments facultatifs suivants :
paquet
Cette valeur fait que l’option --sources se comporte comme l’option --source.
all
Construit les dérivations des sources de tous les paquets, dont les sources
qui pourraient être listées dans inputs
. C’est la valeur par défaut.
$ guix build --sources tzdata The following derivations will be built: /gnu/store/…-tzdata2015b.tar.gz.drv /gnu/store/…-tzcode2015b.tar.gz.drv
transitive
Construire les dérivations des sources de tous les paquets, ainsi que toutes celles des entrées transitives des paquets. On peut par exemple utiliser cette option pour précharger les sources des paquets pour les construire plus tard hors ligne.
$ guix build --sources=transitive tzdata The following derivations will be built: /gnu/store/…-tzcode2015b.tar.gz.drv /gnu/store/…-findutils-4.4.2.tar.xz.drv /gnu/store/…-grep-2.21.tar.xz.drv /gnu/store/…-coreutils-8.23.tar.xz.drv /gnu/store/…-make-4.1.tar.xz.drv /gnu/store/…-bash-4.3.tar.xz.drv …
--system=système
-s système
Essayer de construire pour system — p. ex. i686-linux
— au
lieu du type de système de l’hôte. La commande guix build
vous
permet de répéter cette option plusieurs fois, auquel cas elle construit
pour tous les systèmes spécifiés ; les autres commandes ignorent les options
-s supplémentaires.
Remarque : Le drapeau --system est utilisé pour une compilation native et ne doit pas être confondu avec une compilation croisée. Voir --target ci-dessous pour des informations sur la compilation croisée.
Un exemple d’utilisation de ceci sur les systèmes Linux, qui peut émuler
différentes personnalités. Par exemple, passer --system=i686-linux
sur un système x86_64-linux
ou --system=armhf-linux sur un
système aarch64-linux
vous permet de construire des paquets dans un
environnement 32-bit complet.
Remarque : La possibilité de construire pour un système
armhf-linux
est activé sans condition sur les machinesaarch64-linux
, bien que certaines puces aarch64 n’en soient pas capables, comme les ThunderX.
De même, lorsque l’émulation transparente avec QEMU et binfnmt_misc
est activée (voir qemu-binfmt-service-type
), vous pouvez construire pour n’importe
quel système pour lequel un gestionnaire QEMU binfmt_misc
est
installé.
Les constructions pour un autre système que celui de la machine que vous utilisez peuvent aussi être déchargées à une machine distante de la bonne architecture. Voir Utiliser le dispositif de déchargement, pour plus d’information sur le déchargement.
--target=triplet
¶Effectuer une compilation croisée pour triplet qui doit être un
triplet GNU valide, comme "aarch64-linux-gnu"
(voir GNU configuration triplets dans Autoconf).
--list-systems
Liste tous les systèmes pris en charge, qui peuvent être passés en argument à --system.
--list-targets
Liste toutes les cibles prises en charge, qui peuvent être passées en argument à --target.
--check
¶Reconstruit les package-or-derivation, qui sont déjà disponibles dans le dépôt et lève une erreur si les résultats des constructions ne sont pas identiques bit-à-bit.
Ce mécanisme vous permet de vérifier si les substituts précédemment
installés sont authentiques (voir Substituts) ou si le résultat de la
construction d’un paquet est déterministe. Voir Invoquer guix challenge
pour plus d’informations et pour les outils.
Lorsqu’utilisé avec --keep-failed, la sortie différente est gardée dans le dépôt sous /gnu/store/…-check. Cela rend plus facile l’étude des différences entre les deux résultats.
--repair
¶Essaye de réparer les éléments du dépôt spécifiés, s’ils sont corrompus, en les téléchargeant ou en les construisant à nouveau.
Cette opération n’est pas atomique et donc restreinte à l’utilisateur
root
.
--derivations
-d
Renvoie les chemins de dérivation, et non les chemins de sortie, des paquets donnés.
--root=fichier
¶-r fichier
Fait de fichier un lien symbolique vers le résultat, et l’enregistre en tant que racine du ramasse-miettes.
En conséquence, les résultats de cette invocation de guix build
sont protégés du ramasse-miettes jusqu’à ce que fichier soit
supprimé. Lorsque cette option est omise, les constructions sont
susceptibles d’être glanées.
--log-file
¶Renvoie les noms des journaux de construction ou les URL des package-or-derivation donnés ou lève une erreur si les journaux de construction sont absents.
Cela fonctionne indépendamment de la manière dont les paquets ou les dérivations sont spécifiées. Par exemple, les invocations suivantes sont équivalentes :
guix build --log-file $(guix build -d guile) guix build --log-file $(guix build guile) guix build --log-file guile guix build --log-file -e '(@ (gnu packages guile) guile-2.0)'
If a log is unavailable locally, and unless --no-substitutes is passed, the command looks for a corresponding log on one of the substitute servers.
Donc par exemple, imaginons que vous souhaitiez voir le journal de
construction de GDB sur aarch64
, mais que vous n’avez qu’une machine
x86_64
:
$ guix build --log-file gdb -s aarch64-linux https://bordeaux.guix.gnu.org/log/…-gdb-7.10
Vous pouvez accéder librement à une vaste bibliothèque de journaux de construction !
Précédent: Options de construction supplémentaires, Monter: Invoquer guix build
[Table des matières][Index]
Lors de la définition d’un nouveau paquet (voir Définition des paquets), vous passerez probablement du temps à déboguer et modifier la construction jusqu’à ce que ça marche. Pour cela, vous devez effectuer les commandes de construction vous-même dans un environnement le plus proche possible de celui qu’utilise le démon de construction.
Pour cela, la première chose à faire est d’utiliser l’option
--keep-failed ou -K de guix build
, qui gardera
la construction échouée de l’arborescence dans /tmp ou le répertoire
spécifié par TMPDIR
(voir --keep-failed).
À partir de là, vous pouvez vous déplacer dans l’arborescence de
construction et sourcer le fichier environment-variables, qui
contient toutes les variables d’environnement qui étaient définies lorsque
la construction a échoué. Disons que vous déboguez un échec de construction
dans le paquet toto
; une session typique ressemblerait à cela :
$ guix build toto -K … build fails $ cd /tmp/guix-build-toto.drv-0 $ source ./environment-variables $ cd toto-1.2
Maintenant, vous pouvez invoquer les commandes comme si vous étiez le démon (presque) et corriger le processus de construction.
Parfois il arrive que, par exemple, les tests d’un paquet réussissent lorsque vous les lancez manuellement mais échouent quand ils sont lancés par le démon. Cela peut arriver parce que le démon tourne dans un conteneur où, contrairement à notre environnement au-dessus, l’accès réseau est indisponible, /bin/sh n’existe pas, etc. (voir Réglages de l’environnement de construction).
Dans ce cas, vous pourriez avoir besoin de lancer le processus de construction dans un conteneur similaire à celui que le démon crée :
$ guix build -K toto … $ cd /tmp/guix-build-toto.drv-0 $ guix shell --no-grafts -C -D toto strace gdb [env]# source ./environment-variables [env]# cd toto-1.2
Ici, guix shell -C
crée un conteneur et démarre un nouveau shell à
l’intérieur (voir Invoquer guix shell
). La partie strace gdb
ajoute les commandes strace
et gdb
dans le conteneur, ce
qui pourrait s’avérer utile pour le débogage. L’option --no-grafts
s’assure qu’on obtienne le même environnement, avec des paquets non greffés
(voir Mises à jour de sécurité, pour plus d’informations sur les greffes).
Pour obtenir un conteneur plus proche de ce qui serait utilisé par le démon de construction, on peut enlever /bin/sh :
[env]# rm /bin/sh
(Ne vous inquiétez pas, c’est sans danger : tout cela se passe dans un
conteneur jetable créé par guix shell
.)
La commande strace
n’est probablement pas dans le chemin de
recherche, mais on peut lancer :
[env]# $GUIX_ENVIRONMENT/bin/strace -f -o log make check
De cette manière, non seulement vous aurez reproduit les variables d’environnement utilisées par le démon, mais vous lancerez aussi le processus de construction dans un conteneur similaire à celui utilisé par le démon.
Suivant: Invoquer guix download
, Précédent: Invoquer guix build
, Monter: Utilitaires [Table des matières][Index]
guix edit
Tant de paquets, tant de fichiers source ! La commande guix edit
facilite la vie des utilisateurs et des empaqueteurs en plaçant leur éditeur
sur le fichier source qui contient la définition des paquets spécifiés. Par
exemple :
guix edit gcc@4.9 vim
lance le programme spécifié dans la variable d’environnement VISUAL
ou
dans la variable d’environnement EDITOR
pour visionner la recette de
GCC 4.9.3 et celle de Vim.
Si vous utilisez une copie du dépôt Git de Guix (voir Construire depuis Git),
ou que vous avez créé vos propres paquets dans GUIX_PACKAGE_PATH
(voir Modules de paquets), vous pourrez modifier les recettes des paquets.
Sinon, vous pourrez examiner les recettes en lecture-seule des paquets
actuellement dans le dépôt.
Au lieu de GUIX_PACKAGE_PATH
, l’option de la ligne de commande
--load-path=directory (ou en bref -L
directory) vous permet d’ajouter directory au début du chemin
de recherche du module de paquet et donc de rendre vos propres paquets
visibles.
Suivant: Invoquer guix hash
, Précédent: Invoquer guix edit
, Monter: Utilitaires [Table des matières][Index]
guix download
Lorsqu’on écrit une définition de paquet, on a généralement besoin de
télécharger une archive des sources, calculer son hash SHA256 et écrire ce
hash dans la définition du paquet (voir Définition des paquets). L’outil
guix download
aide à cette tâche : il télécharge un fichier à
l’URL donné, l’ajoute au dépôt et affiche à la fois son nom dans le dépôt et
son hash SHA56.
Le fait que le fichier téléchargé soit ajouté au dépôt économise la bande
passante : quand on construit ensuite le paquet nouvellement défini avec
guix build
, l’archive des sources n’a pas besoin d’être à nouveau
téléchargée puisqu’elle se trouve déjà dans le dépôt. C’est aussi une
manière pratique de garder des fichiers temporairement, qui pourront ensuite
être supprimés (voir Invoquer guix gc
).
La commande guix download
supporte les mêmes URI que celles
utilisées dans les définitions de paquets. En particulier, elle supporte
les URI mirror://
. Les URI http
(HTTP sur TLS) sont
supportées si les liaisons Guile de GnuTLS sont disponibles dans
l’environnement de l’utilisateur ; si elle ne sont pas disponibles, une
erreur est renvoyée. Voir how to install the GnuTLS
bindings for Guile dans GnuTLS-Guile, pour plus d’informations.
guix download
vérifie les certificats du serveur HTTPS en
chargeant les autorités de certification X.509 depuis le répertoire vers
lequel pointe la variable d’environnement SSL_CERT_DIR
(voir Certificats X.509), à moins que --no-check-certificate ne soit utilisé.
Alternatively, guix download
can also retrieve a Git repository,
possibly a specific commit, tag, or branch.
Les options suivantes sont disponibles :
--hash=algorithme
-H algorithme
Calcule un hash en utilisant l’algorithme spécifié. Voir Invoquer guix hash
, pour plus d’ informations.
--format=fmt
-f fmt
Écrit le hash dans le format spécifié par fmt. Pour plus
d’informations sur les valeurs valides pour fmt, voir Invoquer guix hash
.
--no-check-certificate
Ne pas valider les certificats HTTPS des serveurs.
Lorsque vous utilisez cette option, vous n’avez absolument aucune garanti que vous communiquez avec le serveur authentique responsable de l’URL donnée, ce qui vous rend vulnérable à des attaques de « l’homme du milieu ».
--output=fichier
-o fichier
Enregistre le fichier téléchargé dans fichier plutôt que de l’ajouter au dépôt.
--git
-g
Checkout the Git repository at the latest commit on the default branch.
--commit=commit-or-tag
Checkout the Git repository at commit-or-tag.
commit-or-tag can be either a tag or a commit defined in the Git repository.
--branch=branche
Checkout the Git repository at branch.
The repository will be checked out at the latest commit of branch, which must be a valid branch of the Git repository.
--recursive
-r
Recursively clone the Git repository.
Suivant: Invoquer guix import
, Précédent: Invoquer guix download
, Monter: Utilitaires [Table des matières][Index]
guix hash
La commande guix hash
calcule le hash d’un fichier. C’est surtout
un outil pour simplifier la vie des contributeur·rice·s à la distribution :
elle calcule le hash cryptographique d’un ou plusieurs fichiers, qui peut
être utilisé dans la définition d’ un paquet (voir Définition des paquets).
La syntaxe générale est :
guix hash option fichier …
Lorsque fichier est -
(un tiret), guix hash
calcul le
hash des données lues depuis l’entrée standard. guix hash
a les
options suivantes :
--hash=algorithme
-H algorithme
Calcule un hash en utilisant l’ algorithme spécifié, sha256
par
défaut.
algorithm doit être le nom de l’ algorithme d’un hash cryptographique
supporté par Libgcrypt via Guile-Gcrypt—par exemple, sha512
ou
sha3-256
(voir Hash Functions dans Guile-Gcrypt
Reference Manual).
--format=fmt
-f fmt
Écrit le hash dans le format spécifié par fmt.
Formats supportés : base64
, nix-base32
, base32
,
base16
(hex
et hexadecimal
peuvent être utilisés).
Si l’option --format n’est pas spécifiée, guix hash
affichera le hash en nix-base32
. Cette représentation est utilisée
dans les définitions des paquets.
--recursive
-r
L’option --recursive est obsolète et remplacée par --serializer=nar (voir plus bas) ; -r reste accepté car c’est un raccourci pratique.
--serializer=type
-S type
Calcule le hash sur fichier avec la sérialisation type.
type peut être l’une des valeurs suivantes :
none
C’est la valeur par défaut : elle calcule le hash du contenu d’un fichier.
nar
Calcul le hash d’une « archive normalisée » (ou « nar ») contenant
fichier, dont ses enfants si c’est un répertoire. Certaines
métadonnées de fichier fait partie de l’archive ; par exemple lorsque
fichier est un fichier normal, le hash est différent que le
fichier soit exécutable ou non. Les métadonnées comme un horodatage
n’ont aucun impact sur le hash (voir Invoquer guix archive
pour plus de
détails sur le format nar).
git
Calcule le hash d’un fichier ou d’un répertoire comme une arborescence Git, suivant la même méthode que le système de contrôle de version Git.
--exclude-vcs
-x
Conjointement avec --recursive, exclut les répertoires de système de contrôle de version (.bzr, .git, .hg, etc.).
Par exemple, voici comment calculer le hash d’un dépôt Git, ce qui est utile
avec la méthode git-fetch
(voir Référence de origin
) :
$ git clone http://example.org/toto.git $ cd toto $ guix hash -x --serializer=nar .
Suivant: Invoquer guix refresh
, Précédent: Invoquer guix hash
, Monter: Utilitaires [Table des matières][Index]
guix import
La commande guix import
est utile pour les gens qui voudraient
ajouter un paquet à la distribution avec aussi peu de travail que possible —
une demande légitime. La commande connaît quelques dépôts logiciels d’où
elle peut « importer » des métadonnées de paquets. Le résultat est une
définition de paquet, ou un modèle de définition, dans le format reconnu par
Guix (voir Définition des paquets).
La syntaxe générale est :
guix import [global-options…] importer package [options…]
importer specifies the source from which to import package metadata,
and options specifies a package identifier and other options specific
to importer. guix import
itself has the following
global-options:
--insert=file
-i file
Insert the package definition(s) that the importer generated into the specified file, either in alphabetical order among existing package definitions, or at the end of the file otherwise.
Certains des importeurs s’appuient sur la capacité d’exécuter la commande
gpgv
. Pour ceux-ci, GnuPG doit être installé dans $PATH
;
exécuter guix install gnupg
si nécessaire.
Actuellement, les « importeurs » disponibles sont :
gnu
Importe des métadonnées d’un paquet GNU donné. Cela fournit un modèle pour la dernière version de ce paquet GNU, avec le hash de son archive, le synopsis et la description canonique.
Les informations supplémentaires comme les dépendances du paquet et sa licence doivent être renseignées manuellement.
Par exemple, la commande suivante renvoie une définition de paquets pour GNU Hello :
guix import gnu hello
Les options spécifiques sont :
--key-download=politique
Comme pour guix refresh
, spécifie la politique de gestion des
clefs OpenPGP manquantes lors de la vérification de la signature d’un
paquet. Voir --key-download
.
pypi
¶Importe des métadonnées depuis l’index des
paquets Python. Les informations sont récupérées à partir de la
description en JSON disponible sur pypi.python.org
et inclus
généralement toutes les informations utiles, dont les dépendances des
paquets. Pour une efficacité maximale, il est recommandé d’installer
l’utilitaire unzip
, pour que l’importateur puisse dézipper les
wheels Python et récupérer les informations contenues à l’intérieur.
La commande ci-dessous importe les métadonnées de la dernière version du
paquet Python itsdangerous
:
guix import pypi itsdangerous
Vous pouvez aussi demander une version spécifique :
guix import pypi itsdangerous@1.1.0
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
gem
¶Importe des métadonnées de RubyGems. Les
informations sont récupérées au format JSON disponible sur
rubygems.org
et inclut les informations les plus utiles, comme les
dépendances à l’exécution. Il y a des cependant quelques restrictions. Les
métadonnées ne distinguent pas synopsis et description, donc la même chaîne
est utilisée pour les deux champs. En plus, les détails des dépendances non
Ruby requises pour construire des extensions natives sont indisponibles et
laissé en exercice à l’empaqueteur.
La commande ci-dessous importe les métadonnées pour le paquet Ruby
rails
:
guix import gem rails
Vous pouvez aussi demander une version spécifique :
guix import gem rails@7.0.4
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
minetest
¶Importe des métadonnées de ContentDB. Les informations sont récupérées au format JSON disponible à travers l’API de ContentDB et inclus les informations les plus utiles, dont les dépendances. Il y a cependant quelques limitations. L’information de licence est souvent incomplète. Le hash de commit est parfois oublié. Les descriptions sont au format Markdown mais Guix utilise plutôt Texinfo. Les packs de textures et les jeux ne sont pas pris en charge.
La commande ci-dessous importe les métadonnées pour le mod Mesecons de Jeija :
guix import minetest Jeija/mesecons
Vous pouvez aussi ne pas indiquer le nom de l’auteur :
guix import minetest mesecons
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
cpan
¶Importe des métadonnées de MetaCPAN. Les
informations sont récupérées au format JSON disponible à travers
l’API de MetaCPAN et inclus les
informations les plus utiles, comme les dépendances des modules.
L’information sur les licences doit être vérifiée avec attention. Si Perl
est disponible dans le dépôt, alors l’utilitaire corelist
sera
utiliser pour exclure les modules du cœur de la distribution Perl de la
liste des dépendances.
La commande ci-dessous importe des métadonnées pour le module Acme ::Boolean Perl :
guix import cpan Acme::Boolean
cran
¶Importe des métadonnées de CRAN, le dépôt central de l’environnement statistique et graphique GNU R.
L’ information est extraite du fichier DESCRIPTION du paquet.
La commande ci-dessous importe les métadonnées du paquet Cairo R :
guix import cran Cairo
Vous pouvez aussi demander une version spécifique :
guix import cran rasterVis@0.50.3
Lorsque l’option --recursive est utilisée, l’importateur traversera le graphe des dépendances du paquet en amont récursivement et générera des expressions de paquets pour tous ceux qui ne sont pas déjà dans Guix.
Lorsque vous ajoutez --style=specification, l’importateur générera des définitions de paquets dont les entrées sont les spécifications des paquets au lieu de références au variables des paquets. C’est utile lorsque des définitions de paquets doivent être ajoutées à des modules utilisateurs, comme la liste des modules de paquets n’a pas besoin d’être changée. La valeur par défaut est --style=variable.
Lorsque vous ajoutez --prefix=license:, l’outil d’import ajoutera
license:
au début du nom des licences, ce qui permet d’importer
(guix licenses)
avec un préfixe.
Lorsque --archive=bioconductor est ajoutée, les métadonnées sont importées depuis Bioconductor, un répertoire de paquets R pour l’analyse et la compréhension de données génomiques volumineuses en bioinformatique.
Les informations sont extraites du fichier DESCRIPTION du paquet contenu dans l’archive du paquet.
La commande ci-dessous importe les métadonnées pour le paquet R GenomicRanges :
guix import cran --archive=bioconductor GenomicRanges
Enfin, vous pouvez aussi importer des paquets R qui n’ont pas encore été publiés sur CRAN ou Bioconductor tant qu’ils ne sont pas dans le dépôt Git. Utilisez --archive=git suivi par l’URL du dépôt Git :
guix import cran --archive=git https://github.com/immunogenomics/harmony
texlive
¶Importe les informations de paquets TeX à partir de la base de données TeX Live pour les paquets TeX qui font partie de la distribution TeX Live.
Information about the package is obtained from the TeX Live package
database, a plain text file that is included in the texlive-scripts
package. The source code is downloaded from possibly multiple locations in
the SVN repository of the Tex Live project. Note that therefore SVN must be
installed and in $PATH
; run guix install subversion
if needed.
La commande ci-dessous importe les métadonnées du paquet TeX
fontspec
:
guix import texlive fontspec
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
json
¶Importe des métadonnées d’un fichier JSON local. Considérez l’exemple suivant d’une définition de paquet au format JSON :
{ "name": "hello", "version": "2.10", "source": "mirror://gnu/hello/hello-2.10.tar.gz", "build-system": "gnu", "home-page": "https://www.gnu.org/software/hello/", "synopsis": "Hello, GNU world: An example GNU package", "description": "GNU Hello prints a greeting.", "license": "GPL-3.0+", "native-inputs": ["gettext"] }
Les noms des champs sont les mêmes que pour les enregistrements de
<package>
(Voir Définition des paquets). Les référence à d’autres
paquets sont fournies comme des listes JSON de chaînes de spécifications de
paquets comme guile
ou guile@2.0
.
L’importateur supporte aussi une définition plus explicite des sources avec
les champs habituels pour les enregistrements <origin>
:
{ … "source": { "method": "url-fetch", "uri": "mirror://gnu/hello/hello-2.10.tar.gz", "sha256": { "base32": "0ssi1wpaf7plaswqqjwigppsg5fyh99vdlb9kzl7c9lng89ndq1i" } } … }
La commande ci-dessous lit les métadonnées du fichier JSON hello.json
et renvoie une expression de paquet :
guix import json hello.json
hackage
¶Importe les métadonnées de l’archive de paquets centrale de la communauté Haskell, Hackage. Les informations sont récupérées depuis les fichiers Cabal et incluent toutes les informations utiles, dont les dépendances des paquets.
Les options spécifiques sont :
--stdin
-s
Lit un fichier Cabal depuis l’entrée standard.
--no-test-dependencies
-t
N’inclut pas les dépendances requises uniquement par les suites de tests.
--cabal-environment=alist
-e alist
alist est une alist Scheme qui définie l’environnement dans lequel les
conditions de Cabal sont évaluées. Les clefs acceptées sont : os
,
arch
, impl
et une représentation sous forme de chaîne de
caractères du nom d’un drapeau. La valeur associée à un drapeau doit être
le symbole true
ou false
. La valeur associée aux autres clefs
doivent se conformer avec la définition du format de fichiers Cabal. La
valeur par défaut associée avec les clefs os
, arch
et
impl
sont respectivement ‘linux’, ‘x86_64’ et ‘ghc’.
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
La commande ci-dessous importe les métadonnées pour la dernière version du
paquet HTTP Haskell sans inclure les dépendances de test et en spécifiant la
valeur du drapeau ‘network-uri’ comme false
:
guix import hackage -t -e "'((\"network-uri\" . false))" HTTP
Une version spécifique du paquet peut éventuellement être spécifiée en faisant suivre le nom du paquet par un arobase et un numéro de version comme dans l’exemple suivant :
guix import hackage mtl@2.1.3.1
stackage
¶L’importateur stackage
est une enveloppe autour de l’importateur
hackage
. Il prend un nom de paquet, recherche la version incluse
dans une version au support étendu (LTS) de Stackage et utilise l’importateur hackage
pour récupérer les
métadonnées. Remarquez que c’est à vous de choisir une version LTS
compatible avec le compilateur GHC utilisé par Guix.
Les options spécifiques sont :
--no-test-dependencies
-t
N’inclut pas les dépendances requises uniquement par les suites de tests.
--lts-version=version
-l version
version est la version LTS désirée. Si elle est omise, la dernière version est utilisée.
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
La commande ci-dessous importe les métadonnées pour le paquet HTTP Haskell inclus dans la version 7.18 de LTS Stackage :
guix import stackage --lts-version=7.18 HTTP
elpa
¶Importe les métadonnées du dépôt de paquets ELPA (Emacs Lisp Package Archive) (voir Packages dans The GNU Emacs Manual).
Les options spécifiques sont :
--archive=repo
-a repo
repo identifie le dépôt d’archive depuis lequel récupérer les informations. Actuellement les dépôts supportés et leurs identifiants sont :
gnu
. C’est la valeur par défaut.
Les paquets de elpa.gnu.org
avec l’une des clefs contenues dans le
porte-clef GnuPG share/emacs/25.1/etc/package-keyring.gpg (ou
similaire) dans le paquet emacs
(voir ELPA
package signatures dans The GNU Emacs Manual).
nongnu
.
melpa-stable
.
melpa
.
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
crate
¶Importer les métadonnées du dépôt de paquets Rust crates.io crates.io, comme dans cet exemple :
guix import crate blake2-rfc
L’importeur crate vous permet aussi de spécifier une version de chaînes de caractères :
guix import crate constant-time-eq@0.1.0
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
--recursive-dev-dependencies
If --recursive-dev-dependencies is specified, also the recursively imported packages contain their development dependencies, which are recursively imported as well.
--allow-yanked
If no non-yanked version of a crate is available, use the latest yanked version instead instead of aborting.
elm
¶Importer les métadonnées du dépôt de paquets Elm package.elm-lang.org, comme dans cet exemple :
guix import elm elm-explorations/webgl
L’importeur Elm vous permet aussi de spécifier une version de chaînes de caractères :
guix import elm elm-explorations/webgl@1.1.3
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
npm-binary
¶Import metadata from the npm Registry, as in this example:
guix import npm-binary buffer-crc32
The npm-binary importer also allows you to specify a version string:
guix import npm-binary buffer-crc32@1.0.0
Remarque : Generated package expressions skip the build step of the
node-build-system
. As such, generated package expressions often refer to transpiled or generated files, instead of being built from source.
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
opam
¶Importe les métadonnées du répertoire de paquets OPAM utilisé par la communauté OCaml.
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
composer
¶Import metadata from the Composer package archive used by the PHP community, as in this example:
guix import composer phpunit/phpunit
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
--repo
Par défaut on recherche les paquets dans le dépôt OPAM officiel. Cette option, qui peut être utilisée plusieurs fois en même temps, vous permet d’ajouter d’autres dépôts dans lesquelles on recherchera les paquets. Les arguments valide sont :
opam
,
coq
(équivalent à coq-released
), coq-core-dev
,
coq-extra-dev
ou grew
.
opam repository add
(par exemple, l’URL équivalent au nom
opam
plus haut serait https://opam.ocaml.org).
Les dépôts sont passés à cette commande par ordre de préférence. Les dépôts
supplémentaires ne remplaceront pas le dépôt opam
par défaut, qui est
toujours gardé en dernier recours.
Ainsi, remarquez que les versions ne sont pas comparées entre dépôts. Le premier dépôt (de gauche à droite) qui a au moins une version d’un paquet donné prendra le pas sur les autres, et la version importée sera la plus récente trouvée dans ce dépôt uniquement.
go
¶Importe les métadonnées d’un module Go avec proxy.golang.org.
guix import go gopkg.in/yaml.v2
Il est possible d’utiliser la spécification d’un paquet avec le suffixe
@VERSION
pour importer une version spécifique.
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
--pin-versions
Lorsque vous utilisez cette option, l’importateur préserve les versions exactes des modules Go de dépendance au lieu d’utiliser leur dernière version disponible. C’est utile si vous essayez d’importer un paquet qui dépend récursivement de versions antérieures de lui-même pour la construction. Lorsque vous utilisez ce mode, le symbole du paquet sera créé en ajoutant la version à son nom, pour que plusieurs version du même paquet puissent coexister.
egg
¶Importe les métadonnées pour des « eggs » CHICKEN. L’information est récupérée dans les fichiers PACKAGE.egg trouvés dans le dépôt git eggs-5-all. Toutefois, il ne fournit pas toutes les informations dont vous avez besoin, il n’y a pas de champ “description” et les licences utilisées ne sont pas toujours précises (BSD est souvent employée à la place de BSD-N).
guix import egg sourcehut
Vous pouvez aussi demander une version spécifique :
guix import egg arrays@1.0
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
hexpm
¶Importer les métadonnées du dépôt de paquets Erlang et Elixir hex.pm hex.pm, comme dans cet exemple :
guix import hexpm stun
L’importateur essaye de déterminer le système de construction utilisé par le paquet.
L’importeur hexpm vous permet aussi de spécifier une version de chaînes de caractères :
guix import hexpm cf@0.3.0
Les options supplémentaires comprennent :
--recursive
-r
Traverse le graphe des dépendances du paquet amont donné et génère les expressions de paquets de tous ceux qui ne sont pas déjà dans Guix.
La structure du code de guix import
est modulaire. Il serait
utile d’avoir plus d’importateurs pour d’autres formats de paquets et votre
aide est la bienvenue sur ce sujet (voir Contribuer).
Suivant: Invoquer guix style
, Précédent: Invoquer guix import
, Monter: Utilitaires [Table des matières][Index]
guix refresh
La commande guix refresh
s’adresse avant tout aux personnes qui
écrivent des paquets. En tant qu’utilisateur·rice, vous pourriez être
intéressé·e par l’option --with-latest qui peut vous conférer les
superpouvoirs de mettre à jour les paquets, et qui est construite à partir
de guix refresh
(voir --with-latest). Par défaut, guix refresh
rapporte les
paquets fournis par la distribution qui sont en retard par rapport aux
dernières versions disponibles en amont, comme ceci :
$ guix refresh gnu/packages/gettext.scm :29 :13 : gettext serait mis à jour de 0.18.1.1 à 0.18.2.1 gnu/packages/glib.scm :77:12 : glib serait mis à jour de 2.34.3 à 2.37.0
On peut aussi spécifier des paquets à prendre en compte, auquel cas un avertissement est émis pour les paquets qui ne sont pas mis à jour :
$ guix refresh coreutils guile guile-ssh gnu/packages/ssh.scm:205:2 : avertissement : aucun gestionnaire de mise à jour pour guile-ssh gnu/packages/guile.scm:136:12 : guile serait mis à jour de 2.0.12 à 2.0.13
guix refresh
navigue le dépôt amont de chaque paquet et détermine
le numéro de version le plus élevé parmi les versions publiées. La commande
sait comment mettre à jour certains types de paquets : les paquets GNU, les
paquets ELPA, etc. — voir la documentation pour --type ci-dessous.
Il y a beaucoup de paquet cependant pour lesquels il manque une méthode pour
déterminer si une nouvelle version est disponible en amont. Cependant, le
mécanisme est extensible, alors n’hésitez pas à nous contacter pour ajouter
une nouvelle méthode !
--recursive
Considère les paquets spécifiés et tous les paquets dont ils dépendent.
$ guix refresh --recursive coreutils gnu/packages/acl.scm:40:13: acl would be upgraded from 2.2.53 to 2.3.1 gnu/packages/m4.scm:30:12: 1.4.18 is already the latest version of m4 gnu/packages/xml.scm:68:2: warning: no updater for expat gnu/packages/multiprecision.scm:40:12: 6.1.2 is already the latest version of gmp …
Si pour n’importe quelle raison vous ne voulez pas mettre à jour vers la dernière version, vous pouvez mettre à jour vers une version spécifique en ajoutant un signe égal et le numéro de version désiré à la fin de la spécification du paquet. Remarquez que tous les programmes de mise à jour ne le prennent pas en charge. Une erreur est rapportée quand un programme de mise à jour ne peut pas rafraîchir vers la version spécifiée.
$ guix refresh guile gnu/packages/guile.scm:392:2: guile serait mis à jour de 3.0.3 vers 3.0.5 $ guix refresh -u guile=3.0.4 … gnu/packages/guile.scm:392:2: guile : mise à jour de la version 3.0.3 vers la version 3.0.4... … $ guix refresh -u guile@2.0=2.0.12 … gnu/packages/guile.scm:147:2: guile : mise à jour de la version 2.0.10 vers la version 2.0.12... …
In some specific cases, you may have many packages specified via a manifest or a module selection which should all be updated together; for these cases, the --target-version option can be provided to have them all refreshed to the same version, as shown in the examples below:
$ guix refresh qtbase qtdeclarative --target-version=6.5.2 gnu/packages/qt.scm:1248:13: qtdeclarative would be upgraded from 6.3.2 to 6.5.2 gnu/packages/qt.scm:584:2: qtbase would be upgraded from 6.3.2 to 6.5.2
$ guix refresh --manifest=qt5-manifest.scm --target-version=5.15.10 gnu/packages/qt.scm:1173:13: qtxmlpatterns would be upgraded from 5.15.8 to 5.15.10 gnu/packages/qt.scm:1202:13: qtdeclarative would be upgraded from 5.15.8 to 5.15.10 gnu/packages/qt.scm:1762:13: qtserialbus would be upgraded from 5.15.8 to 5.15.10 gnu/packages/qt.scm:2070:13: qtquickcontrols2 would be upgraded from 5.15.8 to 5.15.10 …
Parfois les noms en amont diffèrent du nom de paquet utilisé par Guix et
guix refresh
a besoin d’un peu d’aide. La plupart des
gestionnaires de mise à jour prennent en compte la propriété
upstream-name
dans les définitions de paquets, ce qui peut être
utilisé à cette fin :
(define-public network-manager
(package
(name "network-manager")
;; …
(properties '((upstream-name . "NetworkManager")))))
When passed --update, it modifies distribution source files to
update the version numbers and source code hashes of those package
definitions, as well as possibly their inputs (voir Définition des paquets).
This is achieved by downloading each package’s latest source tarball and its
associated OpenPGP signature, authenticating the downloaded tarball against
its signature using gpgv
, and finally computing its hash—note
that GnuPG must be installed and in $PATH
; run guix install
gnupg
if needed.
Quand la clé publique utilisée pour signer l’archive est manquante depuis le
trousseau de clés utilisateur·rice, une tentative est faite de la récupérer
automatiquement depuis un serveur de clé publique ; en cas de succès, la clé
est ajoutée au trousseau de l’utilisateur·rice ; sinon, guix
refresh
renvoie une erreur.
Les options suivantes sont supportées :
--expression=expr
-e expr
Considérer le paquet évalué par expr.
C’est utile pour précisément se référer à un paquet, comme dans cet exemple :
guix refresh -l -e '(@@ (gnu packages commencement) glibc-final)'
Cette commande liste les dépendances de la libc « finale » (presque tous les paquets).
--update
-u
Update distribution source files (package definitions) in place. This is usually run from a checkout of the Guix source tree (voir Lancer Guix avant qu’il ne soit installé):
./pre-inst-env guix refresh -s non-core -u
Voir Définition des paquets, for more information on package definitions. You can also run it on packages from a third-party channel:
guix refresh -L /path/to/channel -u package
Voir Écrire de nouveaux de canaux, on how to create a channel.
This command updates the version and source code hash of the package. Depending on the updater being used, it can also update the various ‘inputs’ fields of the package. In some cases, the updater might get inputs wrong—it might not know about an extra input that’s necessary, or it might add an input that should be avoided.
To address that, packagers can add properties stating inputs that should be
added to those found by the updater or inputs that should be ignored: the
updater-extra-inputs
and updater-ignored-inputs
properties
pertain to “regular” inputs, and there are equivalent properties for
‘native’ and ‘propagated’ inputs. In the example below, we tell
the updater that we need ‘openmpi’ as an additional input:
(define-public python-mpi4py
(package
(name "python-mpi4py")
;; …
(inputs (list openmpi))
(properties
'((updater-extra-inputs . ("openmpi"))))))
That way, guix refresh -u python-mpi4py
will leave the
‘openmpi’ input, even if it is not among the inputs it would normally
add.
--select=[subset]
-s subset
Select all the packages in subset, one of core
, non-core
or module:name
.
Le sous-ensemble core
se réfère à tous les paquets du cœur de la
distribution — c.-à-d. les paquets qui sont utilisés pour construire «
tout le reste ». Cela comprend GCC, libc, Binutils, Bash, etc.
Habituellement, changer l’un de ces paquets dans la distribution implique de
reconstruire tous les autres. Ainsi, ces mises à jour sont une nuisance
pour les utilisateurs, en terme de temps de compilation et de bande passante
utilisés pour effectuer la mise à jour.
Le sous-ensemble non-core
se réfère au reste des paquets. C’est
habituellement utile dans les cas où une mise à jour des paquets du cœur
serait dérangeante.
The module:name
subset refers to all the packages in a
specified guile module. The module can be specified as module:guile
or module:(gnu packages guile)
, the former is a shorthand for the
later.
--manifest=fichier
-m fichier
Choisi tous les paquets du manifeste dans file. C’est utile pour vérifier qu’aucun des paquets du manifeste utilisateur ne peut être mis à jour.
--type=updater
-t updater
Chois uniquement les paquets pris en charge par updater (éventuellement une liste de gestionnaires de mise à jour séparés par des virgules). Actuellement, updater peut être l’une des valeurs suivantes :
gnu
le gestionnaire de mise à jour pour les paquets GNU ;
savannah
le gestionnaire de mise à jour pour les paquets hébergés sur Savannah ;
sourceforge
le gestionnaire de mise à jour pour les paquets hébergés sur SourceForge ;
gnome
le gestionnaire de mise à jour pour les paquets GNOME ;
kde
le gestionnaire de mise à jour pour les paquets KDE ;
xorg
le gestionnaire de mise à jour pour les paquets X.org ;
kernel.org
le gestionnaire de mise à jour pour les paquets hébergés sur kernel.org ;
egg
le gestionnaire de mise à jour pour les paquets Egg ;
elpa
le gestionnaire de mise à jour pour les paquets ELPA ;
cran
le gestionnaire de mise à jour pour les paquets CRAN ;
bioconductor
le gestionnaire de mise à jour pour les paquets Bioconductor ;
cpan
le gestionnaire de mise à jour pour les paquets CPAN ;
pypi
le gestionnaire de mise à jour pour les paquets PyPI.
gem
le gestionnaire de mise à jour pour les paquets RubyGems.
github
le gestionnaire de mise à jour pour les paquets GitHub.
hackage
le gestionnaire de mise à jour pour les paquets Hackage.
stackage
le gestionnaire de mise à jour pour les paquets Stackage.
crate
le gestionnaire de mise à jour pour les paquets Crates.
launchpad
le gestionnaire de mise à jour pour les paquets Launchpad.
generic-html
un gestionnaire de mise à jour qui visite la page HTML où l’archive des
sources est hébergée, lorsque c’est possible, ou la page HTML spécifiée par
la propriété release-monitoring-url
du paquet.
generic-git
un gestionnarie de mise à jour générique pour les paquets hébergés sur des dépôts Git. Il essaye d’analyser les noms de tag Git de manière astucieuse, mais s’il ne parvient pas à analyser le nom d’un tag et à comparer les tags correctement, il est possible de définir les propriétés suivantes pour un paquet.
release-tag-prefix
: une expression régulière pour repérer le préfixe dans
le nom d’un tag.
release-tag-suffix
: une expression régulière pour repérer le suffixe dans
le nom d’un tag.
release-tag-version-delimiter
: une chaîne de caractères utilisée comme délimitation dans
le nom d’un tag pour séparer les numéros de version.
accept-pre-releases
: par défaut, le gestionnaire de mise à jour ignorera
les pré-versions ; pour lui faire chercher aussi les pré-versions, assignez
à cette propriété la valeur #t
.
(package
(name "toto")
;; ...
(properties
'((release-tag-prefix . "^release0-")
(release-tag-suffix . "[a-z]?$")
(release-tag-version-delimiter . ":"))))
Par exemple, la commande suivante ne vérifie que les mises à jour des
paquets Emacs hébergés sur elpa.gnu.org
et les paquets CRAN :
$ guix refresh --type=elpa,cran gnu/packages/statistics.scm:819:13 : r-testthat serait mis à jour de 0.10.0 à 0.11.0 gnu/packages/emacs.scm:856:13 : emacs-auctex serait mis à jour de 11.88.6 à 11.88.9
--list-updaters
Liste les gestionnaires de mises à jour disponibles et quitte (voir --type ci-dessus).
Pour chaque gestionnaire, affiche le pourcentage de paquets qu’il couvre ; à la fin, affiche le pourcentage de paquets couverts par tous les gestionnaires.
En plus, on peut passer à guix refresh
un ou plusieurs noms de
paquets, comme dans cet exemple :
$ ./pre-inst-env guix refresh -u emacs idutils gcc@4.8
La commande ci-dessus met à jour spécifiquement les paquets emacs
et
idutils
. L’option --select n’aurait aucun effet dans ce
cas. Vous voudrez aussi sans doute mettre à jour les définitions qui
correspondent aux paquets installés dans votre profil :
$ ./pre-inst-env guix refresh -u \ $(guix package --list-installed | cut -f1)
Pour déterminer s’il faut mettre à jour un paquet, il est parfois pratique
de savoir quels paquets seraient affectés par la mise à jour pour pouvoir
vérifier la compatibilité. Pour cela l’option suivante peut être utilisée
avec un ou plusieurs noms de paquets passés à guix refresh
:
--list-dependent
-l
Liste les paquets de plus haut-niveau qui devraient être reconstruits après la mise à jour d’un ou plusieurs paquets.
Voir le type reverse-package
de guix
graph
, pour des informations sur la manière de visualiser la liste des
paquets dépendant d’un autre.
Sachez que l’option --list-dependent n’a qu’une approche approximative sur les reconstructions qui seraient nécessaires à la suite d’une mise à jour. D’autres reconstructions peuvent être nécessaires dans certaines circonstances.
$ guix refresh --list-dependent flex Construire les 120 paquets suivants s'assure que les 213 paquets dépendants sont reconstruits : hop@2.4.0 emacs-geiser@0.13 notmuch@0.18 mu@0.9.9.5 cflow@1.4 idutils@4.6 …
La commande ci-dessus liste un ensemble de paquets qui peuvent être
construits pour vérifier la compatibilité d’une mise à jour de flex
.
--list-transitive
-T
Lister tous les paquets dont un paquet ou plus dépendent.
$ guix refresh --list-transitive flex flex@2.6.4 depends on the following 25 packages: perl@5.28.0 help2man@1.47.6 bison@3.0.5 indent@2.2.10 tar@1.30 gzip@1.9 bzip2@1.0.6 xz@5.2.4 file@5.33 …
La commande ci-dessus liste un ensemble de paquets qui, lorsqu’ils sont
modifiés, causent la reconstruction de flex
.
Les options suivante peuvent être utilisées pour personnaliser les opérations avec GnuPG :
--gpg=commande
Utilise commande comme la commande de GnuPG 2.x. commande est
recherchée dans PATH
.
--keyring=fichier
Utilise fichier comme porte-clefs pour les clefs amont. fichier
doit être dans le format keybox. Les fichiers Keybox ont d’habitude
un nom qui fini par .kbx et GNU Privacy Guard (GPG) peut
manipuler ces fichiers (voir kbxutil
dans Using the
Privacy Guard, pour plus d’informations sur un outil pour manipuler des
fichiers keybox).
Lorsque cette option est omise, guix refresh
utilise
~/.config/guix/upstream/trustedkeys.kbx comme trousseau pour les clés
de signature en amont. Les signatures OpenPGP sont vérifiées avec ces clés
; les clés manquantes sont aussi téléchargées dans ce trousseau (voir
--key-download plus bas).
Vous pouvez exporter les clefs de votre porte-clef