Tutorial Definitivo do GNU Autotools para Iniciantes

Tutorial Definitivo de Como Usar o GNU AutoTools

Apesar de existirem algumas outras alternativas às ferramentas automáticas do GNU, o GNU Autotools ainda é o mais utilizado no mundo por motivos de confiança em relação à resultados finais. Ou seja, a experiência levou à essa estabilidade.

Infelizmente, há muita documentação obsoleta na internet sobre o Autotools e muitas reclamações sobre ferramentas automáticas, por esse motivo decidi documentar um teste moderno e bem simplista que eu criei e vou compartilhar com vocês essa experiência que fiz questão de torná-la o mais básico possível para poder alcançar o entendimento.

Mas ainda assim, não deixe de exibir exemplos que funcionem em projetos maiores, que por sinal a ideia é a mesma, só precisa ter um pouco mais de atenção nas configurações.

Esse artigo se resumirá em:

Todos os tópicos foram separados com Passo à Passo e Listas ordenadas para facilitar a compreensão.

1. Introdução

2. Preparação do Ambiente

3. Utilização das ferramentas automáticas

4. Explicações teóricas de cada comando e arquivo

5. Recursos prontos no Git (meus exemplos)

6. Scripts em Bash (facilitam notar os passos)

7. Resumo (Mini mapa mental)

8. Referências bibliográficas

Introdução

O GNU Autotools , também conhecido como GNU Build System , é um conjunto de ferramentas de programação projetadas para ajudar a tornar os pacotes de código-fonte portáteis para muitos sistemas Unix .

Pode ser difícil tornar um programa de software portátil: o compilador C difere de sistema para sistema; algumas funções da biblioteca estão ausentes em alguns sistemas; arquivos de cabeçalho podem ter nomes diferentes. Uma maneira de lidar com isso é escrever código condicional, com blocos de código selecionados por meio de diretivas de pré-processador (#ifdef); mas devido à grande variedade de ambientes de construção, essa abordagem rapidamente se torna incontrolável. O Autotools foi projetado para solucionar esse problema de maneira mais fácil.

O Autotools faz parte da cadeia de ferramentas GNU e é amplamente utilizado em muitos pacotes de software livre e de código aberto . Suas ferramentas componentes são licenciadas por software livre sob a Licença Pública Geral GNU, com exceções especiais de licença permitindo seu uso com software proprietário .

O GNU Build System possibilita a criação de muitos programas usando um processo de duas etapas: configure seguido por make .

O Autotools consiste nos programas utilitários GNU Autoconf , Automake e Libtool . Outras ferramentas relacionadas frequentemente usadas ao lado dele incluem o programa GNU make, o GNU gettext , o pkg-config e o GNU Compiler Collection , também chamada GCC/G++.

1º Parte: Configurando os arquivos para testes

1 → Criar os diretórios para os testes:

mkdir testes && cd testes
mkdir doc examples man scripts src

2 → Criar os arquivos para os teste

touch doc/README.md examples/my-example-teste.dat man/teste.1 scripts/script-teste.sh src/teste.c

3 → Popular os arquivos

# Conteúdo para o arquivo em doc/
echo "Documentação para o teste" >> doc/README.md

# Conteúdo para o arquivo em examples/
echo -e '#!/bin/bash\necho "Teste em Bash"\nexit 0' >> examples/my-example-teste.dat

# Conteúdo para o arquivo em man/
echo -e '.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH teste "1" "October 2019" "teste 1.1" "User Commands"
.SH NAME
teste \- Only teste for Autotools.' > man/teste.1

# Conteúdo para o arquivo em scripts/
echo -e '#!/bin/sh\nprintf "Only a teste\\n" "%s"\nexit 0' > scripts/script-teste.sh

# Conteúdo para o arquivo em src/
echo -e '#include <stdio.h>

int main(){
	printf("Somente um teste para o Autotools\\n");
	return 0;
}' > src/teste.c

4 → Resultado final dos arquivos:

testes/
├── doc
│   └── README.md
├── examples
│   └── my-example-teste.dat
├── man
│   └── teste.1
├── scripts
│   └── script-teste.sh
└── src
    └── teste.c
5 directories, 5 files

5 → Opcional: hash do diretório:

ls ../testes/ | md5sum
ac0bacadc6861ab22a44af572b255ff1  -

2º Parte: Utilizando as ferramentas do GNU Autotools

1 → Gerar o arquivo configure.ac, execute:

autoscan

Foram criados os arquivos: autoscan-2.69.log e configure.scan . Onde o conteúdo de autoscan-2.69.log está vazio e o conteúdo de configure.ac é:

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
AC_CONFIG_SRCDIR([src/teste.c])
AC_CONFIG_HEADERS([config.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT

2 → Renomear o arquivo configure.scan para configure.ac:

mv configure.scan configure.ac

3 → Alterar a linha do arquivo configure.ac que possui as informações: AC_INIT(FULL-PACKAGE-NAME, VERSION, BUG-REPORT-ADDRESS) para os nomes do seu projeto, ex.: AC_INIT(teste, 1.0, teste@terminalroot.com.br) . Caso deseje, use o Sed para isso, assim:

sed -i 's/FULL-PACKAGE-NAME\],/teste],/g' configure.ac
sed -i 's/VERSION\],/1.0],/g' configure.ac
sed -i 's/BUG-REPORT-ADDRESS\]/teste@terminalroot.com.br]/g' configure.ac

Ou use um editor de texto de preferência, exemplo: Vim .

Ao final meu arquivo ficou assim:

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT([teste], [1.0], [teste@terminalroot.com.br])
AC_CONFIG_SRCDIR([src/teste.c])
AC_CONFIG_HEADERS([config.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT

4 → Gerando um script configure inicial:

autoconf

Foram criados: 1 novo diretório e 1 novo arquivo: autom4te.cache/ e o configure . O conteúdo dos mesmos são extensos, o configure por exemplo possui 3549 linhas.

5 → Criando o arquivo Makefile.am:

vim Makefile.am