license-reconcilep - Online na nuvem

PROGRAMA:

NOME

licença-reconciliar - reconciliar debian / copyright contra a fonte

SINOPSE

licença-reconciliar --Socorro|--cara

licença-reconciliar [--copyright-file =lima] [--no-check-copyright] [--suggest-estrofes]
[--sem especificação de formato] [--quieto] [--display-mapping] [--directory =anuário]
[--filters =módulo 1 módulo 2 ...] [--config-file =lima] [--changelog-file =lima] [arquivos...]

DESCRIÇÃO

licença-reconciliar tenta combinar informações de licença e direitos autorais em um diretório com
a informação disponível em "debian / copyright". Ele obtém a maior parte de seus dados de
"licensecheck", portanto, deve produzir algo que valha a pena olhar fora da caixa. No entanto, para um
dado pacote, ele pode ser configurado para ter sucesso em um estado bom conhecido, de modo que se
atualizações upstream subsequentes ele falha, ele aponta o que precisa ser examinado. Por padrão, o
os testes executados são os seguintes:

- O arquivo de copyright tem uma especificação de formato aprovada como sua primeira linha?
- O arquivo de copyright pode ser analisado?
- Cada arquivo na fonte corresponde a pelo menos uma cláusula no arquivo de copyright?
- Todos os arquivos, licenças e dados de direitos autorais extraídos da fonte podem estar contidos em
o parágrafo correspondente correspondente do arquivo de copyright? Os dados para esta comparação
vem de um número de objetos de filtro. Consulte "Filtros" para obter mais informações.
- Todos os arquivos da fonte têm direitos autorais atribuídos e uma licença de alguma parte do
Arquivo "debian / copyright".

OBTENDO COMEÇADO

Fora of que o caixa
No nível superior do diretório de origem do pacote de software Debian, basta executar
"licença-reconciliar".

contexto a configuração lima
Normalmente, para fazer qualquer progresso, será necessário ter um arquivo de configuração. O padrão
o arquivo é "debian / license-reconcile.yml". Um arquivo de configuração diferente pode ser definido com o
--config-file =lima. O arquivo de configuração é interpretado usando Config :: Any, mas para os propósitos
desta documentação # assumimos que o formato é YAML.

predominante incorreto resultados
Suponha que você tenha muita sorte. Para apenas um arquivo, "a / b", os filtros padrão que são
wrappers em torno de "licensecheck", entendi errado. Por algum motivo, eles decidiram que
o arquivo tem uma licença GPL-3, quando a inspeção mostrar que é de domínio público. Isto é
causando uma falha de falso positivo em seu arquivo "debian / copyright" cuidadosamente elaborado. Vocês
pode corrigir isso com o seguinte fragmento de configuração:

Regras:
regras:
-
Glob: a / b
Licença: domínio público
Direitos autorais: 1556, Nostrodamus

Consulte Debian :: LicenseReconcile :: Filter :: Rules para obter mais informações sobre como configurar isso
filtro.

fornecendo a captura todos os licença e direitos autorais
Você pode fazer com que os filtros forneçam uma licença padrão, mas fornecendo uma regra adequada no
Seção padrão do arquivo de configuração:

Padrão:
regras:
-
Licença: Todo software é propriedade da licença do proletariado
Copyright: 1984, Ministério de Algoritmos

O filtro Padrão usa exatamente o mesmo código que o filtro Regras, mas por padrão é executado
último. Portanto, tem todas as mesmas funcionalidades, mas a precedência mais baixa.

controle que o seqüência of filtros.
Por padrão, os filtros executados são: Rules, Std, Shebang, ChangeLog e Default. Você pode variar
os filtros usando o --filters =módulo opção. Definir "Regras --filters" significaria que
apenas o filtro Debian :: LicenseReconcile :: Filter :: Rules seria usado. Depois de especificar
um filtro você deve especificar todos eles.

filtro aliasing
O filtro padrão é um alias para regras. Isso significa que ele executa o mesmo código, mas tem um
configuração separada. O padrão é definido como "Regras ~ padrão". Em geral, "X ~ Y" significa usar o
código de Y, mas obtenha a configuração de X.

escrita os próprio filtro.
Você pode escrever seus próprios filtros herdando de Debian :: LicenseReconcile :: Filter. Vocês
precisa definir o método "get_info".

OPÇÕES

--copyright-file =lima
Especifique um arquivo de copyright alternativo. O padrão é "debian / copyright".

--sem especificação de formato
Não verifique a primeira linha do arquivo de copyright em relação às especificações de formato permitidas.

--no-check-copyright
Não verifique as cláusulas de direitos autorais.

--quieto
Não dê nenhuma explicação, simplesmente um sucesso ou uma falha por meio do status de saída.

--display-mapping
Exibir o mapeamento do diretório nas cláusulas de direitos autorais.

--directory =anuário
O diretório cujos direitos autorais e licenças serão verificados. O padrão é ".".

--filters =módulo 1 --filters =módulo 2 ....
Uma sequência de filtros que irá inspecionar o pacote de origem e devolver a licença e
Informações sobre direitos autorais. Cada nome de módulo deve ficar abaixo do
Debian :: LicenseReconcile :: Filtre e herde dele. O valor padrão é "Regras Padrão
Shebang ChangeLog Default ".

--config-file =lima
Um arquivo usado para fornecer dados de configuração específicos do filtro. O arquivo é lido por Config :: Any
e a seção relevante é passada para cada construtor de filtro por meio do parâmetro "config".

<- arquivo changelog =>lima
O arquivo de changelog do Debian cujo padrão é "debian / changelog". O filtro de regras usa este
para obter a versão atual e o filtro ChangeLog obtém seus dados a partir dela.

--suggest-estrofes
Se configurado, imprima a licença e os dados de copyright no formato DEP-5.

Filtros

Por padrão, os filtros são processados ​​na ordem abaixo. Assim que um arquivo for devolvido por
um filtro, os filtros subsequentes irão ignorá-lo.

- Regras
- Registro de alterações
- Padrão
- Shebang
- Predefinição

Cada construtor de filtro receberá os seguintes parâmetros:

- diretório - o diretório a partir do qual os dados de licença e copyright serão encontrados.
- files_remaining - um array ref de arquivos que não foram analisados.
- config - uma estrutura de dados que representa a parte do arquivo de configuração relevante para este
filtro.
- changelog - um objeto Parse :: DebianChangelog.
- licensecheck - um objeto Debian :: LicenseReconcile :: LicenseCheck.

ARQUIVO ARGUMENTOS

Quaisquer argumentos após os argumentos são considerados arquivos. Se especificado apenas esses arquivos
serão reconciliados.

LIMITAÇÕES

A especificação DEP-5 é sutilmente diferente da especificação do arquivo glob. Desde o
O módulo File :: FnMatch é a única implementação prática, há pouco que pode ser
feito. A consequência é que a tentativa de especificar que um nome de arquivo deve conter '['
e mais tarde um ']' em "debian / copyright" provavelmente não funcionará corretamente.

Na análise de direitos autorais, os anos não podem ser expressos na forma abreviada de dois dígitos. Isto é
provavelmente uma coisa boa, mas certamente causará um problema em algum momento.

EXEMPLOS

Dois projetos Debian estão usando a reconciliação de licença, para verificar o
Arquivo "debian / copyright".

license-reconcile | https: //anonscm.debian.org/cgit/pkg-perl/packages/license-reconcile.git/tree/debian/license-reconcile.yml
deve, obviamente, ser limpo de acordo com seus próprios padrões. Em algum momento, esta verificação será adicionada a
os testes de construção.
ksh |http://anonscm.debian.org/cgit/collab-maint/ksh.git/tree/debian/license-reconcile.yml
está usando a reconciliação de licença desde a versão 93u + 20120801-2.

Use licença-reconciliar online usando serviços onworks.net