Capítulo 8. Prácticas Avançadas de pkg-plist

Alguns ports, particularmente os p5- ports, precisam mudar seus pkg-plist dependendo de quais opções eles são configurados com (ou versão de perl, no caso de p5- ports). Para tornar isso fácil, todas as instâncias pkg-plist de %%OSREL%%, %%PERL_VER%% e %%PERL_VERSION%% serão substituídas apropriadamente. O valor de %%OSREL%% é a revisão numérica do sistema operacional (por exemplo,4.9). %%PERL_VERSION%% e %%PERL_VER%% é o número completo da versão perl (por exemplo,5.8.9). Muitos outros %%VARS%% relacionados aos arquivos de documentação do port são descritos na seção relevante.

Para fazer outras substituições, defina PLIST_SUB com uma lista de pares VAR=VALOR e as instâncias de %%VAR%% serão substituídas por VALOR no pkg-plist.

Por exemplo, se um port instalar muitos arquivos em um subdiretório específico da versão, use um placeholder para a versão de modo que o pkg-plist não precise ser gerado novamente toda vez que o port é atualizado. Por exemplo:

no Makefile e use %%OCTAVE_VERSION%% onde quer que a versão apareça em pkg-plist. Quando o port é atualizado, não será necessário editar dezenas (ou em alguns casos, centenas) de linhas no pkg-plist.

Se os arquivos são instalados condicionalmente pelas opções definidas no port, a maneira usual de lidar com isso é prefixando as linhas pkg-plist com %%OPT%% para linhas necessárias quando a opção está ativada ou %%NO_OPT%% quando a opção está desativada e adicionando OPTIONS_SUB=yes ao Makefile. Veja OPTIONS_SUB para mais informações.

Por exemplo, se houver arquivos que são instalados apenas quando a opção X11 está ativada, e o Makefile tem:

No pkg-plist, insira %%X11%% no início das linhas que serão instaladas apenas quando a opção estiver habilitada, assim:

Esta substituição será feita entre os targets pre-install e do-install, lendo a partir do PLIST e escrevendo em TMPPLIST (padrão:WRKDIR/.PLIST.mktmp). Então, se o port gera o PLIST na hora da compilação, faça isso em ou antes do pre-install. Além disso, se o port precisar editar o arquivo resultante, faça-o em post-install em um arquivo chamado TMPPLIST.

Outra maneira de modificar a lista de empacotamento de um port é baseada na configuração das variáveis PLIST_FILES e PLIST_DIRS. O valor de cada variável é considerado como uma lista de nomes de caminho para gravar no TMPPLIST junto com conteúdo do PLIST. Enquanto os nomes listados no PLIST_FILES e PLIST_DIRS estão sujeitos a substituição do %%VAR%% conforme descrito acima, é melhor usar o ${VAR} diretamente. Exceto por isso, os nomes contidos no PLIST_FILES aparecerão inalterados na lista final de packing, enquanto o @dir será anexado aos nomes do PLIST_DIRS. Para fazer efeito, o PLIST_FILES e o PLIST_DIRS devem ser definidos antes que o TMPPLIST seja escrito, isto é, no pre-install ou antes.

De vez em quando, usar OPTIONS_SUB não é o suficiente. Nesses casos, adicionar uma TAG para PLIST_SUB dentro do Makefile com um valor especial @comment, faz as ferramentas de pacote ignorar a linha. Por exemplo, se alguns arquivos são instalados apenas quando a opção X11 está habilitada e a arquitetura é i386:

Se o port instalar arquivos de configuração em PREFIX/etc (ou em outro lugar) não liste-os em pkg-plist. Isso fará com que pkg delete remova os arquivos que foram cuidadosamente editados pelo usuário, e uma reinstalação irá eliminá-los.

Em vez disso, instale arquivos de exemplo com uma extensão filename.sample. A macro @sample automatiza isso, consulte @sample file[file] para entender o que ela faz exatamente. Para cada arquivo de exemplo, adicione uma entrada no pkg-plist:

Se houver uma boa razão para não instalar um arquivo de configuração por padrão, liste apenas o nome do arquivo de exemplo em pkg-plist, sem o @sample seguido por um espaço e adicione uma mensagem ressaltando que o usuário deve copiar e editar o arquivo antes que o software seja executado.

Uma lista de pacotes estáticos é uma lista de pacotes que está disponível na Coleção de Ports ou como pkg-plist (com ou sem substituição de variável), ou embutido no Makefile através do PLIST_FILES e do PLIST_DIRS. Mesmo se o conteúdo for gerado automaticamente por uma ferramenta ou um taget no Makefile antes da inclusão na Coleção de Ports por um committer (por exemplo, usando make makeplist), isso ainda é considerado uma lista estática, já que é possível examiná-la sem ter que baixar ou compilar o distfile.

Uma lista de pacotes dinâmicos é uma lista de pacotes que é gerada no momento em que o port é compilado com base nos arquivos e diretórios que estão instalados. Não é possível examiná-lo antes que o código-fonte do aplicativo portado seja baixado e compilado, ou após executar um make clean.

Embora o uso de listas de pacotes dinâmicos não seja proibido, os mantenedores devem usar listas de pacotes estáticos sempre que possível, já que isso permite aos usuários utilizar grep(1) nos de ports disponíveis para descobrir, por exemplo, qual port instala um determinado arquivo. Listas dinâmicas devem ser usadas principalmente para ports complexos onde a lista de pacotes muda drasticamente com base nos recursos opcionais do port (e assim manter uma lista de pacotes estática é impraticável), ou ports que alteram a lista de pacotes com base na versão do software dependente usado. Por exemplo, ports que geram documentos com Javadoc.

Primeiro, verifique se o port está quase completo, faltando apenas o pkg-plist. Executar o comando make makeplist irá mostrar um exemplo para o pkg-plist. A saída do makeplist deve ser checada duas vezes quanto à correção, pois ela tenta adivinhar automaticamente algumas coisas e pode errar.

Os arquivos de configuração do usuário devem ser instalados como filename.sample, como é descrito em Arquivos de Configuração. O info/dir não deve ser listado e entradas apropriadas install-info devem ser adicionadas conforme a seção arquivos de informação. Quaisquer bibliotecas instaladas pelo port devem ser listadas conforme especificado na seção bibliotecas compartilhadas.

Todas as keywords também podem ter argumentos opcionais entre parênteses. Os argumentos são owner, group e mode. Esse argumento é usado no arquivo ou diretório referenciado. Para alterar o dono, o grupo e o modo de um arquivo de configuração, use:

Os argumentos são opcionais. Se apenas o grupo e o modo precisarem ser alterados, use: