DH_INSTALLDOCS(1) | Debhelper | DH_INSTALLDOCS(1) |
dh_installdocs - instala documentação em directórios de compilação de pacotes
dh_installdocs [debhelper opções] [-A] [-Xitem] [ficheiro ...]
dh_installdocs é um programa debhelper que é responsável por instalar documentação em usr/share/doc/package nos directórios de compilação de pacotes.
Em compatibilidade 10 e anterior, dh_install(1) pode ser a melhor ferramenta para lidar com a documentação do autor, quando o sistema de compilação próprio do autor instala toda a documentação desejada correctamente Neste caso, o dh_installdocs ainda é útil para instalar documentação relacionada com o empacotamento (ex. o ficheiro debian/copyright).
From debhelper compatibility level 11 on, dh_install will fall back to looking in debian/tmp for files, if it does not find them in the current directory (or wherever you've told it to look using --sourcedir).
In compat 11 and later, dh_installdocs offers many of the features that dh_install(1) also has. Furthermore, dh_installdocs also supports the nodoc build profile to exclude documentation (regardless of compat level).
Note que os ficheiros README.debian são também instalados como README.Debian, e os ficheiro TODO serão instalados como TODO.Debian em pacotes não nativos.
Note que isto não é o mesmo que a opção --sourcedirectory usada pelos comandos dh_auto_*. Você raramente vai precisar de usar esta opção, pois o dh_installman procura automaticamente por ficheiros em debian/tmp no nível de compatibilidade 11 e superiores do debhelper.
Em compatibilidade 11 (ou posterior), esta opção apenas é útil se a auto-detecção do debhelper do pacote principal está errada. A opção também pode ser usada para silenciar um aviso do debhelper quando a auto-detecção falha mas acontece a predefinição estar correcta.
Esta opção não pode ser usada quando o dh_installdocs é instruído a actuar em múltiplos pacotes. Se precisar desta opção, você irá geralmente precisar de combiná-la com -p para assegurar exactamente que um pacote é actuado.
Por favor tenha em mente que alguma documentação (o ficheiro de copyright, README.Debian, etc.) não serão afectados por esta opção.
O debhelper irá tentar evitar instalar ficheiros em directórios de documentação "linkados" que poderão causar conflitos com o pacotes "linkado". A opção -A não terá nenhum efeito em pacotes com directórios de documentação "linkados", e os ficheiros copyright, changelog, README.Debian, e TODO não serão instalados.
(Um outro método de consegui o mesmo, o qual ainda é suportado, é tornar o directório de documentação de um pacote num link simbólico pendente, antes de chamar o dh_installdocs.)
Por favor note que esta opção apenas é aplicada ao directório de documentação para o próprio pacote. Quando o pacote embarca documentação para outro pacote (ex. veja --doc-main-package), não irá usar um link simbólico para a documentação do outro pacote.
CAVEAT 1: Se uma versão anterior do pacote foi compilada sem esta opção e for agora compilada com ela (ou vice-versa), precisa de uma migração de dir para symlink" (ou de "symlink para dir"). Como o debhelper não tem conhecimento das versões anteriores, você terá que ser o próprio a activar esta migração.
Isto pode ser feito ao fornecer um ficheiro "debian/pacote.maintscript" e usar o dh_installdeb(1) para fornecer os fragmentos relevantes do script do mantenedor.
CAVEAT 2: The use of --link-doc should only be done when the packages have same "architecture" type. A link from an architecture independent package to an architecture dependent package (or vice versa) will not work. Since compat 10, debhelper will actively reject unsupported combinations.
Este é um exemplo de um ficheiro debian/package.docs:
README TODO debian/notes-for-maintainers.txt docs/manual.txt docs/manual.pdf docs/manual-html/
Note que dh_installdocs irá alegremente copiar as hierarquias completas dos directórios se você lhe pedir (semelhante a cp -a). Se lhe for pedido para instalar um directório, irá instalar o conteúdo completo desse directório.
Este programa é parte do debhelper.
Joey Hess <joeyh@debian.org>
Américo Monteiro
Se encontrar algum erro na tradução deste documento, por favor comunique para Américo Monteiro a_monteiro@gmx.com ou Equipa Debian de Tradução Portuguesa traduz@debianpt.org.
2019-02-23 | 12.1.1 |