Beyond Linux® From Scratch (systemd Utgave) - Versjon r13.0-1377

Kapittel 11. Generelle verktøy

GTK-Doc-1.36.1

Introduksjon til GTK-Doc

GTK-Doc pakken inneholder en kode dokumentar. Dette er nyttig for å trekke ut spesielt formaterte kommentarer fra koden for å lage API dokumentasjon. Denne pakken er valgfri; hvis den ikke er installert, vil pakker ikke bygge dokumentasjonen. Dette betyr ikke at du ikke vil ha eventuell dokumentasjon. Hvis GTK-Doc ikke er tilgjengelig, vil installasjonsprosessen kopiere all forhåndsbygd dokumentasjon til systemet ditt.

[Notat]

Notat

Denne pakken er kjent for å bygge og fungere skikkelig med en LFS 13.1 plattform.

Pakkeinformasjon

GTK-Doc Avhengigheter

Påkrevd

docbook-xml-4.5, docbook-xsl-nons-1.79.2, GLib-2.88.3, itstool-2.0.7, libxslt-1.1.45, og Pygments-2.20.0

Valgfri

For tester: dblatex eller fop-2.11 (XML PDF støtte), Which-2.25, og Python moduler lxml-6.1.1, parameterized, og yelp-tools

[Notat]

Notat

De valgfrie pythonmodulene ovenfor kan enkelt installeres med pip3 kommando.

Installasjon av GTK-Doc

Installer GTK-Doc ved å kjøre følgende kommandoer: 

mkdir -p build &&
cd       build &&

meson setup ..            \
      --prefix=/usr       \
      --buildtype=release \
      -D tests=false      &&
ninja

Testpakken vil henge hvis pakken (eller en tidligere versjon) ikke allerede er installert.

Nå, som root bruker: 

ninja install

For å teste resultatene, sørg for at du har Python modulen parameterized er installert, og utsted: 

meson configure -D tests=true &&
ninja test

Noen tester vil mislykkes avhengig av valgfritt installerte pakker.

Parameterforklaringer

-D tests=false: forhindrer bygging av tester. Standardverdien er true, men krever parameterized python modulen.

Innhold

Installerte Programmer: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, og gtkdoc-scangobj
Installerte Biblioteker: Ingen
Installerte Mapper: /usr/lib/cmake/GtkDoc, /usr/share/gtk-doc, og /usr/share/help/*/gtk-doc-manual

Korte Beskrivelser

gtkdoc*

disse er alle skall, eller Python skript brukt av pakken Makefile skriptet for å generere dokumentasjon for pakken som bygges