Au-delà de Linux® From Scratch (édition System V) - Version r13.0-112-wip

Chapitre 11. Outils généraux

GTK-Doc-1.36.0

Introduction à GTK-Doc

Le paquet GTK-Doc permet de documenter du code. C'est utile pour extraire des commentaires spécialement formatés du code pour créer des documentations d'API. Ce paquet est facultatif ; si vous ne l'installez pas, les paquets ne construiront pas la documentation. Cela ne veut pas dire que vous n'aurez aucune documentation. Si GTK-Doc n'est pas disponible, le processus d'installation copiera toute la documentation pré-construite sur votre système.

[Note]

Note

Les versions de développement de BLFS peuvent ne pas arriver à contruire ou à exécuter certains paquets correctement si LFS ou des dépendances ont été mises à jour depuis la dernière version stable des livres.

Informations sur le paquet

  • Téléchargement (HTTP) : https://download.gnome.org/sources/gtk-doc/1.36/gtk-doc-1.36.0.tar.xz

  • Téléchargement (FTP) :

  • Somme de contrôle MD5 du téléchargement : 69c1105d8c968cb5303a40bc88685eac

  • Taille du téléchargement : 550 Ko

  • Estimation de l'espace disque requis : 15 Mo (plus 1,9 Mo pour les tests)

  • Estimation du temps de construction : moins de 0,1 SBU (avec les tests)

Dépendances de GTK-Doc

Requises

docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.86.4, itstool-2.0.7, libxslt-1.1.45 et Pygments-2.19.2

Facultatives

Pour les tests : dblatex ou fop-2.11 (prise en charge du PDF par XML), Which-2.23 et les modules Python lxml-6.0.2, paramerterized et yelp-tools

[Note]

Note

Les modules python facultatifs ci-dessus peuvent être facilement installés avec la commande pip3.

Installation de GTK-Doc

Installez GTK-Doc en exécutant les commandes suivantes : 

mkdir -p build &&
cd       build &&

meson setup --prefix=/usr --buildtype=release .. &&
ninja

La suite de tests freezera si le paquet (ou une version précédente) n'est pas déjà installé.

Maintenant, en tant qu'utilisateur root : 

ninja install

To test the results, issue: ninja test. Some tests will fail depending on optionally installed packages.

Contenu

Programmes installés: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan et gtkdoc-scangobj
Bibliothèques installées: Aucune
Répertoires installés: /usr/share/gtk-doc and /usr/lib/cmake/GtkDoc

Descriptions courtes

gtkdoc*

ce sont tous des scripts shell ou Python utilisés par les scripts Makefile du paquet pour générer la documentation du paquet qui va être construit