genhtml - On-line na nuvem

PROGRAMA:

NOME

genhtml - Gerar exibição em HTML a partir de arquivos de dados de cobertura LCOV

SINOPSE

genhtml [-h|--Socorro] [-v|--versão]
[-q|--quieto] [-s|--mostrar detalhes] [-f|--quadros]
[-b|--arquivo de linha de base] arquivo-base
[-o|--diretório de saída diretório de saída]
[-t|--título título]
[-d|--arquivo-descrição arquivo de descrição]
[-k|--keep-descrições] [-c|--arquivo-css arquivo css]
[-p|--prefixo prefixo] [- sem prefixo]
[--sem fonte] [--num-espaços Números] [--realçar]
[--lenda] [--html-prólogo arquivo prólogo]
[--html-epílogo arquivo epilog] [--html-extensão extensão]
[--html-gzip] [--ordenar] [--sem classificação]
[- função-cobertura] [- cobertura sem função]
[--branch-cover] [- sem cobertura de filial]
[--demangle-cpp] [--ignore-erros erros]
[--config-arquivo arquivo de configuração] [--rc palavra chave=valor]
[--precisão Números]
tracefile (s)

DESCRIÇÃO

Crie uma visualização HTML dos dados de cobertura encontrados em arquivo de rastreamento. Observe que arquivo de rastreamento Também pode ser
uma lista de nomes de arquivos.

Os arquivos de saída HTML são criados no diretório de trabalho atual, a menos que o
A opção --output-directory é usada. Se arquivo de rastreamento termina com ".gz", presume-se que seja
GZIP compactado e a ferramenta gunzip serão usados ​​para descompactá-lo de forma transparente.

Observe que todos os arquivos de código-fonte devem estar presentes e legíveis no sistema de arquivos exato
local onde foram compilados.

Opção de uso --arquivo-css para modificar o layout e as cores da saída HTML gerada. Arquivos são
marcados em cores diferentes, dependendo da taxa de cobertura associada. Por padrão, o
os limites de cobertura para cobertura baixa, média e alta são definidos como 0-75%, 75-90% e 90-100%
por cento respectivamente. Para alterar esses valores, use as opções do arquivo de configuração
genhtml_hi_limit e genhtml_med_limit.

Observe também que ao exibir porcentagens, 0% e 100% são impressos apenas quando os valores
são exatamente 0% e 100%, respectivamente. Outros valores que convencionalmente seriam arredondados
para 0% ou 100% são impressos como o valor não-limite mais próximo. Este comportamento está em
de acordo com o de gcov(1) ferramenta.

OPÇÕES

-h
--Socorro
Imprima um pequeno texto de ajuda e saia.

-v
--versão
Imprima o número da versão e saia.

-q
--quieto
Não imprima mensagens de progresso.

Suprime toda a saída de progresso informativo. Quando esta chave está habilitada, apenas
mensagens de erro ou aviso são impressas.

-f
--quadros
Use frames HTML para visualização do código-fonte.

Se ativado, um conjunto de quadros é criado para cada arquivo de código-fonte, fornecendo uma visão geral
do código-fonte como uma imagem "clicável". Observe que esta opção irá desacelerar
criação de saída visivelmente porque cada caractere do código-fonte deve ser inspecionado
uma vez. Observe também que o módulo GD.pm Perl deve ser instalado para esta opção para
trabalho (pode ser obtido em http://www.cpan.org).

-s
--mostrar detalhes
Gere uma visão detalhada do diretório.

Quando esta opção está habilitada, genhtml gera duas versões de cada visualização de arquivo. XNUMX
contendo as informações padrão mais um link para uma versão "detalhada". O último
adicionalmente contém informações sobre qual caso de teste cobriu quantas linhas de
cada arquivo de origem.

-b arquivo-base
--arquivo de linha de base arquivo-base
Use dados em arquivo-base como linha de base de cobertura.

O arquivo de rastreamento especificado por arquivo-base é lido e todas as contagens encontradas no
original arquivo de rastreamento são diminuídos pelas contagens correspondentes em arquivo-base
antes de criar qualquer saída.

Observe que quando uma contagem para uma linha específica em arquivo-base é maior que o
conte no arquivo de rastreamento, o resultado é zero.

-o diretório de saída
--diretório de saída diretório de saída
Crie arquivos em diretório de saída.

Use esta opção para dizer genhtml para gravar os arquivos resultantes em um diretório outro
do que o atual. Se diretório de saída não existe, será criado.

É aconselhável usar esta opção, pois dependendo do tamanho do projeto, muitos
arquivos e subdiretórios podem ser criados.

-t título
--título título
Ecrã título no cabeçalho de todas as páginas.

título é escrito na parte do cabeçalho de cada página HTML gerada para identificar o
contexto no qual uma determinada saída foi criada. Por padrão, este é o nome de
o arquivo de rastreamento.

-d arquivo de descrição
--arquivo-descrição arquivo de descrição
Leia as descrições dos casos de teste de arquivo de descrição.

Todas as descrições de caso de teste encontradas em arquivo de descrição e referenciado na entrada
arquivo de dados são lidos e gravados em uma página extra que é então incorporada ao
Saída HTML.

O formato do arquivo de arquivo de descrição é:

para cada caso de teste:
TN:
TD:

Os nomes de caso de teste válidos podem consistir em letras, números e o caractere de sublinhado
('_').
-k
--keep-descrições
Não remova as descrições de teste não utilizadas.

Mantenha as descrições encontradas no arquivo de descrição, mesmo se os dados de cobertura indicarem
que o caso de teste associado não cobriu nenhuma linha de código.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_keep_descrições.

-c arquivo css
--arquivo-css arquivo css
Usar arquivo de folha de estilo externo arquivo css.

Usando esta opção, um arquivo .css extra pode ser especificado para substituir o
padrão um. Isso pode ser útil se as cores padrão fazem seus olhos quererem pular
fora de suas órbitas :)

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
arquivo_genhtml_css.

-p prefixo
--prefixo prefixo
Eliminar prefixo de todos os nomes de diretório.

Como as listas que contêm nomes de arquivos longos são difíceis de ler, existe um mecanismo
implementado que tentará encurtar automaticamente todos os nomes de diretório no
página de visão geral começando com um prefixo comum. Por padrão, isso é feito usando um
algoritmo que tenta encontrar o prefixo que, quando aplicado, irá minimizar o
soma resultante de caracteres de todos os nomes de diretório.

Use esta opção para especificar o prefixo a ser removido por você.

- sem prefixo
Não remova o prefixo dos nomes dos diretórios.

Esta opção irá desativar completamente o mecanismo de prefixo descrito na seção anterior
seção.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_no_prefix.

--sem fonte
Não crie a visualização do código-fonte.

Use essa opção se não quiser obter uma visualização do código-fonte para cada arquivo.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_no_source.

--num-espaços espaços
Substitua as guias na visualização da fonte por Números espaços.

O valor padrão é 8.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_num_spaces.

--realçar
Destaque as linhas com dados de cobertura somente convertidos.

Use esta opção em conjunto com a opção --diff de lcov para destacar aqueles
linhas que foram cobertas apenas em conjuntos de dados que foram convertidos de anteriores
versões do código-fonte.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_highlight.

--lenda
Inclui legenda colorida na saída HTML.

Use esta opção para incluir uma legenda explicando o significado do código de cores no
saída HTML resultante.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_legend.

--html-prólogo arquivo prólogo
Leia o prólogo HTML personalizado de arquivo prólogo.

Use esta opção para substituir o prólogo HTML padrão (a parte inicial do HTML
código-fonte que leva até e incluindo o tag) com o conteúdo de
arquivo prólogo. Dentro do texto do prólogo, as seguintes palavras serão substituídas quando um
a página é gerada:

@título da página@
O título da página.

@basedir @
Um caminho relativo que leva ao diretório base (por exemplo, para localizar arquivos css).

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_html_prolog.

--html-epílogo arquivo epilog
Leia o epílogo HTML personalizado de arquivo epilog.

Use esta opção para substituir o epílogo HTML padrão (a parte final do HTML
fonte incluindo ) com o conteúdo de arquivo epilog.

No texto do epílogo, as seguintes palavras serão substituídas quando uma página for
gerado:

@basedir @
Um caminho relativo que leva ao diretório base (por exemplo, para localizar arquivos css).

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_html_epilog.

--html-extensão extensão
Use extensão de nome de arquivo personalizada para páginas HTML geradas.

Esta opção é útil em situações onde diferentes extensões de nome de arquivo são
necessário para processar as páginas resultantes corretamente (por exemplo, php). Observe que um '.' vai
ser inserido entre o nome do arquivo e a extensão especificada por esta opção.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_html_extensão.

--html-gzip
Compacte todos os arquivos html gerados com gzip e adicione um arquivo .htaccess especificando
codificação gzip no diretório de saída raiz.

Use esta opção se quiser economizar espaço em seu servidor web. Requer um servidor web
com suporte .htaccess e um navegador com suporte para html compactado gzip.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_html_gzip.

--ordenar
--sem classificação
Especifique se deseja incluir visualizações classificadas de visões gerais de arquivo e diretório.

Use --sort para incluir visualizações classificadas ou --no-sort para não incluí-las. Visualizações ordenadas
e guarante que os mesmos estão habilitado por padrão.

Quando as visualizações classificadas estão ativadas, cada página de visão geral conterá links para visualizações de
essa página classificada por taxa de cobertura.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_sort.

- função-cobertura
- cobertura sem função
Especifique se deseja exibir resumos de cobertura de função na saída HTML.

Use --função-cobertura para habilitar resumos de cobertura de função ou
- cobertura sem função para desabilitá-la. Os resumos de cobertura de funções são habilitado by
omissão

Quando os resumos de cobertura de função estão ativados, cada página de visão geral conterá o
número de funções encontradas e acessadas por arquivo ou diretório, junto com o
taxa de cobertura resultante. Além disso, cada visualização do código-fonte conterá um link para
uma página que lista todas as funções encontradas naquele arquivo mais a contagem de chamadas respectiva
para essas funções.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_function_coverage.

--branch-cover
- sem cobertura de filial
Especifique se deseja exibir dados de cobertura de filial na saída HTML.

Use --branch-cobertura para habilitar a exibição de cobertura de agência ou --no-branch-cobertura para
desative-o. A exibição de dados de cobertura de filial é habilitado por padrão

Quando a exibição de cobertura de filial está habilitada, cada página de visão geral conterá o número
de ramos encontrados e acessados ​​por arquivo ou diretório, junto com o resultado
taxa de cobertura. Além disso, cada visualização do código-fonte conterá uma coluna extra
que lista todas as ramificações de uma linha com indicações de se a ramificação foi tomada
ou não. Ramificações são mostradas no seguinte formato:

'+': A ramificação foi tomada pelo menos uma vez
'-': A ramificação não foi tomada
'#': O bloco básico contendo a ramificação nunca foi executado

Observe que nem sempre é possível relacionar ramos aos correspondentes
declarações do código-fonte: durante a compilação, o GCC pode embaralhar ramos ou
elimine alguns deles para gerar um código melhor.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_branch_coverage.

--demangle-cpp
Especifique se deseja desmontar os nomes das funções C ++.

Use esta opção se você deseja converter nomes de funções internas C ++ para humanos
formato legível para exibição na página de visão geral da função HTML. Esta opção
requer que a ferramenta c ++ filt esteja instalada (ver c ++filtro(1)).

--ignore-erros erros
Especifique uma lista de erros após a qual continuar o processamento.

Use esta opção para especificar uma lista de uma ou mais classes de erros após a qual
geninfo deve continuar processando em vez de abortar.

erros pode ser uma lista separada por vírgulas das seguintes palavras-chave:

fonte: o arquivo de código-fonte de um conjunto de dados não foi encontrado.

--config-arquivo arquivo de configuração
Especifique um arquivo de configuração a ser usado.

Quando esta opção é especificada, nem o arquivo de configuração de todo o sistema
/ etc / lcovrc, nem o arquivo de configuração por usuário ~ / .lcovrc está lido.

Esta opção pode ser útil quando há necessidade de executar várias instâncias de genhtml
com diferentes opções de arquivo de configuração em paralelo.

--rc palavra chave=valor
Substitua uma diretiva de configuração.

Use esta opção para especificar um palavra chave=valor declaração que substitui o
declaração de configuração correspondente no arquivo de configuração lcovrc. Você pode
especifique esta opção mais de uma vez para substituir várias instruções de configuração.
See lcvrc(5) para obter uma lista de palavras-chave disponíveis e seu significado.

--precisão Números
Mostrar taxas de cobertura com Números número de dígitos após a vírgula decimal.

O valor padrão é 1.

Esta opção também pode ser configurada permanentemente usando a opção do arquivo de configuração
genhtml_precision.

Use genhtml online usando serviços onworks.net