Beyond Linux® From Scratch (System V Utgave) - Versjon 12.1

Chapter 11. Generelle verktøy

GTK-Doc-1.33.2

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.

Denne pakken er kjent for å bygge og fungere riktig ved å bruke en LFS 12.1 plattform.

Pakkeinformasjon

GTK-Doc Avhengigheter

Påkrevd

docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7, og libxslt-1.1.39

Anbefalt

Pygments-2.17.2 ved kjøretid

Valgfri

For tester: dblatex eller fop-2.9 (XML PDF støtte), GLib-2.78.4, Which-2.21, og Python moduler lxml-4.9.4, parameterized, og yelp-tools

[Note]

Note

De valgfrie pythonmodulene ovenfor kan enkelt installeres med pip3 kommando.

Installasjon av GTK-Doc

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

autoreconf -fiv           &&
./configure --prefix=/usr &&
make

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

Nå, som root bruker: 

make install

For å teste resultatene, kjør: make check. Noen tester vil mislykkes avhengig av valgfritt installerte pakker.

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/share/gtk-doc og /usr/share/cmake/GtkDoc

Korte Beskrivelser

gtkdoc*

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