genhtml - En ligne dans le Cloud

PROGRAMME:

Nom

genhtml - Générer une vue HTML à partir des fichiers de données de couverture LCOV

SYNOPSIS

genhtml [-h|--Aidez-moi] [-v|--version]
[-q|--silencieux] [-s|--afficher les détails] [-f|--cadres]
[-b|--baseline-fichier] fichier-baseline
[-o|--répertoire de sortie répertoire de sortie]
[-t|--Titre titre]
[-d|--fichier-description fichier-description]
[-k|--keep-descriptions] [-c|--css-fichier fichier css]
[-p|--préfixe préfixe] [--pas de préfixe]
[--Aucune source] [--num-espaces num] [--surligner]
[--Légende] [--html-prologue fichier-prologue]
[--html-épilogue fichier-épilogue] [--extension-html extension]
[--html-gzip] [--sorte] [--pas de tri]
[--fonction-couverture] [--no-function-couverture]
[--branche-couverture] [--no-branche-couverture]
[--demangle-cpp] [--ignore-erreurs erreurs]
[--config-fichier fichier de configuration] [--rc mot-clé=Plus-value]
[--précision num]
fichier(s) de trace

DESCRIPTION

Créer une vue HTML des données de couverture trouvées dans fichier de trace. Noter que fichier de trace peut aussi être
une liste de noms de fichiers.

Les fichiers de sortie HTML sont créés dans le répertoire de travail actuel à moins que le
L'option --output-directory est utilisée. Si fichier de trace se termine par ".gz", il est supposé être
GZIP-compressé et l'outil gunzip seront utilisés pour le décompresser de manière transparente.

Notez que tous les fichiers de code source doivent être présents et lisibles dans le système de fichiers exact
endroit où ils ont été compilés.

Utiliser l'option --css-fichier pour modifier la mise en page et les couleurs de la sortie HTML générée. Les fichiers sont
marqués de différentes couleurs selon le taux de couverture associé. Par défaut, le
les limites de couverture pour une couverture faible, moyenne et élevée sont fixées à 0-75 %, 75-90 % et 90-100 %
pour cent respectivement. Pour modifier ces valeurs, utilisez les options du fichier de configuration
genhtml_hi_limit ainsi que genhtml_med_limit.

Notez également que lors de l'affichage des pourcentages, 0% et 100% ne sont imprimés que lorsque les valeurs
sont exactement de 0 % et 100 % respectivement. Autres valeurs qui seraient conventionnellement arrondies
à 0 % ou 100 % sont à la place imprimés en tant que valeur non-limite la plus proche. Ce comportement est en
conforme à celui de la gcov(1) outil.

OPTIONS

-h
--Aidez-moi
Imprimez un court texte d'aide, puis quittez.

-v
--version
Imprimer le numéro de version, puis quitter.

-q
--silencieux
N'imprimez pas les messages de progression.

Supprime toutes les sorties de progression d'informations. Lorsque ce commutateur est activé, seul
les messages d'erreur ou d'avertissement sont imprimés.

-f
--cadres
Utilisez des cadres HTML pour la vue du code source.

Si activé, un jeu de cadres est créé pour chaque fichier de code source, offrant une vue d'ensemble
du code source sous forme d'image « cliquable ». Notez que cette option ralentira
création de sortie sensiblement parce que chaque caractère du code source doit être inspecté
une fois que. Notez également que le module GD.pm Perl doit être installé pour que cette option
travail (il peut être obtenu auprès de http://www.cpan.org).

-s
--afficher les détails
Générer une vue détaillée du répertoire.

Lorsque cette option est activée, genhtml génère deux versions de chaque vue de fichier. Une
contenant les informations standard plus un lien vers une version "détaillée". Le dernier
contient en plus des informations sur quel cas de test a couvert combien de lignes de
chaque fichier source.

-b fichier-baseline
--baseline-fichier fichier-baseline
Utiliser les données dans fichier-baseline comme référence de couverture.

Le fichier de trace spécifié par fichier-baseline est lu et tous les comptes trouvés dans le
original fichier de trace sont décrémentés des comptes correspondants dans fichier-baseline
avant de créer une sortie.

Notez que lorsqu'un compte pour une ligne particulière dans fichier-baseline est supérieur à la
compter dans le fichier de trace, le résultat est nul.

-o répertoire de sortie
--répertoire de sortie répertoire de sortie
Créer des fichiers dans répertoire de sortie.

Utilisez cette option pour dire genhtml pour écrire les fichiers résultants dans un autre répertoire
que l'actuel. Si répertoire de sortie n'existe pas, il sera créé.

Il est conseillé d'utiliser cette option car selon la taille du projet, beaucoup de
des fichiers et des sous-répertoires peuvent être créés.

-t titre
--Titre titre
Commande titre en en-tête de toutes les pages.

titre est écrit dans la partie en-tête de chaque page HTML générée pour identifier le
contexte dans lequel une sortie particulière a été créée. Par défaut c'est le nom de
le fichier de trace.

-d fichier-description
--fichier-description fichier-description
Lire les descriptions de cas de test de fichier-description.

Toutes les descriptions de cas de test trouvées dans fichier-description et référencé en entrée
fichier de données sont lus et écrits sur une page supplémentaire qui est ensuite incorporée dans le
Sortie HTML.

Le format de fichier de fichier-description est:

pour chaque cas de test :
TN :
TD :

Les noms de cas de test valides peuvent être constitués de lettres, de chiffres et du caractère de soulignement
('_').
-k
--keep-descriptions
Ne supprimez pas les descriptions de test inutilisées.

Conserver les descriptions trouvées dans le fichier de description même si les données de couverture indiquent
que le cas de test associé ne couvrait aucune ligne de code.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_keep_descriptions.

-c fichier css
--css-fichier fichier css
Utiliser un fichier de feuille de style externe fichier css.

En utilisant cette option, un fichier .css supplémentaire peut être spécifié qui remplacera le
un par défaut. Cela peut être utile si les couleurs par défaut donnent envie à vos yeux de sauter
hors de leurs prises :)

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_css_file.

-p préfixe
--préfixe préfixe
Effacer préfixe de tous les noms de répertoire.

Les listes contenant des noms de fichiers longs étant difficiles à lire, il existe un mécanisme
implémenté qui essaiera automatiquement de raccourcir tous les noms de répertoire sur le
page de présentation commençant par un préfixe commun. Par défaut, cela se fait à l'aide d'un
algorithme qui essaie de trouver le préfixe qui, une fois appliqué, minimisera le
somme résultante des caractères de tous les noms de répertoire.

Utilisez cette option pour spécifier le préfixe à supprimer par vous-même.

--pas de préfixe
Ne supprimez pas le préfixe des noms de répertoire.

Ce commutateur désactivera complètement le mécanisme de préfixe décrit dans le précédent
.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_no_prefix.

--Aucune source
Ne créez pas de vue de code source.

Utilisez ce commutateur si vous ne souhaitez pas obtenir une vue du code source pour chaque fichier.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_no_source.

--num-espaces espaces
Remplacer les onglets dans la vue source par num les espaces.

La valeur par défaut est 8.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_num_spaces.

--surligner
Mettez en surbrillance les lignes avec des données de couverture converties uniquement.

Utilisez cette option en conjonction avec l'option --diff de lcov pour mettre en évidence ceux
lignes qui n'étaient couvertes que dans des ensembles de données qui ont été convertis à partir des précédents
versions du code source.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_highlight.

--Légende
Inclure la légende des couleurs dans la sortie HTML.

Utilisez cette option pour inclure une légende expliquant la signification du codage couleur dans le
sortie HTML résultante.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_légende.

--html-prologue fichier-prologue
Lire le prologue HTML personnalisé à partir de fichier-prologue.

Utilisez cette option pour remplacer le prologue HTML par défaut (la partie initiale du code HTML
code source menant à et y compris le tag) avec le contenu de
fichier-prologue. Dans le texte du prologue, les mots suivants seront remplacés lorsqu'un
la page est générée :

@titre de la page@
Le titre de la page.

@basedir@
Un chemin relatif menant au répertoire de base (par exemple pour localiser les fichiers css).

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_html_prolog.

--html-épilogue fichier-épilogue
Lire l'épilogue HTML personnalisé à partir de fichier-épilogue.

Utilisez cette option pour remplacer l'épilogue HTML par défaut (la dernière partie du code HTML
source comprenant ) avec le contenu de fichier-épilogue.

Dans le texte de l'épilogue, les mots suivants seront remplacés lorsqu'une page est
généré par:

@basedir@
Un chemin relatif menant au répertoire de base (par exemple pour localiser les fichiers css).

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_html_epilog.

--extension-html extension
Utilisez une extension de nom de fichier personnalisée pour les pages HTML générées.

Cette option est utile dans les situations où différentes extensions de nom de fichier sont
requis pour rendre les pages résultantes correctement (par exemple php). Notez qu'un '.' volonté
être inséré entre le nom du fichier et l'extension spécifiée par cette option.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_html_extension.

--html-gzip
Compressez tous les fichiers html générés avec gzip et ajoutez un fichier .htaccess en spécifiant
gzip-encoding dans le répertoire de sortie racine.

Utilisez cette option si vous souhaitez économiser de l'espace sur votre serveur Web. Nécessite un serveur Web
avec prise en charge .htaccess et un navigateur prenant en charge le html compressé gzip.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_html_gzip.

--sorte
--pas de tri
Indiquez s'il faut inclure des vues triées des aperçus de fichiers et de répertoires.

Utilisez --sort pour inclure les vues triées ou --no-sort pour ne pas les inclure. Vues triées
activé par défaut.

Lorsque les vues triées sont activées, chaque page de présentation contiendra des liens vers des vues de
cette page triée par taux de couverture.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_sort.

--fonction-couverture
--no-function-couverture
Spécifiez s'il faut afficher les résumés de couverture des fonctions dans la sortie HTML.

Utilisez --function-coverage pour activer les résumés de couverture de fonction ou
--no-function-coverage pour le désactiver. Les résumés de couverture des fonctions sont activé by
défaut

Lorsque les résumés de couverture des fonctions sont activés, chaque page d'aperçu contiendra les
nombre de fonctions trouvées et frappées par fichier ou répertoire, ainsi que le
taux de couverture qui en résulte. De plus, chaque vue de code source contiendra un lien vers
une page qui répertorie toutes les fonctions trouvées dans ce fichier ainsi que le nombre d'appels correspondant
pour ces fonctions.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_function_coverage.

--branche-couverture
--no-branche-couverture
Indiquez s'il faut afficher les données de couverture de branche dans la sortie HTML.

Utilisez --branch-coverage pour activer l'affichage de la couverture des branches ou --no-branch-coverage pour
le désactiver. L'affichage des données de couverture de la branche est activé par défaut

Lorsque l'affichage de la couverture des succursales est activé, chaque page d'aperçu contiendra le numéro
de branches trouvées et touchées par fichier ou répertoire, ainsi que le résultat
taux de couverture. De plus, chaque vue de code source contiendra une colonne supplémentaire
qui répertorie toutes les branches d'une ligne avec des indications si la branche a été prise
ou pas. Les succursales sont affichées dans le format suivant :

' + ' : La branche a été prise au moins une fois
' - ' : la branche n'a pas été prise
' # ' : Le bloc de base contenant la branche n'a jamais été exécuté

Notez qu'il n'est pas toujours possible de relier les branches aux
instructions du code source : lors de la compilation, GCC peut mélanger les branches ou
éliminer certains d'entre eux pour générer un meilleur code.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_branch_coverage.

--demangle-cpp
Spécifiez s'il faut démêler les noms de fonction C++.

Utilisez cette option si vous souhaitez convertir les noms de fonctions internes C++ en nom humain
format lisible pour l'affichage sur la page de présentation des fonctions HTML. Cette option
nécessite l'installation de l'outil c++filt (voir c ++filtrer(1)).

--ignore-erreurs erreurs
Spécifiez une liste d'erreurs après laquelle poursuivre le traitement.

Utilisez cette option pour spécifier une liste d'une ou plusieurs classes d'erreurs après quoi
geninfo devrait continuer le traitement au lieu d'abandonner.

erreurs peut être une liste séparée par des virgules des mots-clés suivants :

la source: le fichier de code source d'un ensemble de données est introuvable.

--config-fichier fichier de configuration
Spécifiez un fichier de configuration à utiliser.

Lorsque cette option est spécifiée, ni le fichier de configuration à l'échelle du système
/etc/lcovrc, ni le fichier de configuration par utilisateur ~/.lcovrc est lu.

Cette option peut être utile lorsqu'il est nécessaire d'exécuter plusieurs instances de genhtml
avec différentes options de fichier de configuration en parallèle.

--rc mot-clé=Plus-value
Remplacer une directive de configuration.

Utilisez cette option pour spécifier un mot-clé=Plus-value déclaration qui remplace la
déclaration de configuration correspondante dans le fichier de configuration lcovrc. Vous pouvez
spécifiez cette option plusieurs fois pour remplacer plusieurs instructions de configuration.
See lcovrc(5) pour une liste des mots-clés disponibles et leur signification.

--précision num
Afficher les taux de couverture avec num nombre de chiffres après la virgule.

La valeur par défaut est 1.

Cette option peut également être configurée en permanence à l'aide de l'option fichier de configuration
genhtml_precision.

Utiliser genhtml en ligne à l'aide des services onworks.net