Beyond Linux® From Scratch (Edição systemd ) - Versão 13.0

Capítulo 11. Utilitários Gerais

GTK-Doc-1.35.1

Introdução ao GTK-Doc

O pacote GTK-Doc contém um documentador de código. Isso é útil para extrair comentários especialmente formatados a partir do código para criar a documentação da API. Esse pacote é opcional; se não estiver instalado, [então] os pacotes não construirão a documentação. Isso não significa que você não terá nenhuma documentação. Se GTK-Doc não estiver disponível, [então] o processo de instalação copiará qualquer documentação pré-construída para seu sistema.

[Nota]

Nota

Esse pacote é conhecido por construir e funcionar adequadamente usando-se uma plataforma LFS 13.0.

Informação do Pacote

Dependências do GTK-Doc

Exigidas

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

Opcionais

Para testes: dblatex ou fop-2.11 (suporte a PDF XML), Which-2.23 e módulos Python lxml-6.0.2, parameterized e yelp-tools

[Nota]

Nota

Os módulos opcionais "Python" acima podem ser facilmente instalados com o comando pip3.

Instalação do GTK-Doc

Instale GTK-Doc executando os seguintes comandos: 

mkdir -p build &&
cd       build &&

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

A suíte de teste travará se o pacote (ou uma versão anterior) ainda não estiver instalado.

Agora, como o(a) usuário(a) root: 

ninja install

Para testar os resultados, emita: ninja test. Alguns testes falharão dependendo dos pacotes instalados opcionalmente. Um teste, test-gobject-mkhtml, é conhecido por falhar devido a problemas com versões mais recentes da libxml2.

Conteúdo

Aplicativos Instalados: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan e gtkdoc-scangobj
Bibliotecas Instaladas: Nenhum(a)
Diretórios Instalados: /usr/share/gtk-doc e /usr/share/cmake/GtkDoc

Descrições Curtas

gtkdoc*

esses são todos shell, ou scripts Python usados pelos scripts do pacote Makefile para gerar documentação para o pacote sendo construído