genhtml.1 - lcov翻訳 Wiki - lcov翻訳

Up: man page

Prev: lcov

Next: lcovrc

名前

genhtml - LCOVカバレッジデータファイルからHTMLビューを生成する

書式

    genhtml [-h|--help] [-v|--version]
            [-q|--quiet] [-s|--show-details] [-f|--frames]
            [-b|--baseline-file] baseline-file
            [-o|--output-directory output-directory]
            [-t|--title title]
            [-d|--description-file description-file]
            [-k|--keep-descriptions] [-c|--css-file css-file]
            [-p|--prefix prefix] [--no-prefix]
            [--no-source] [--num-spaces num] [--highlight]
            [--legend] [--html-prolog prolog-file]
            [--html-epilog epilog-file] [--html-extension extension]
            [--html-gzip] [--sort] [--no-sort]
            [--function-coverage] [--no-function-coverage]
            [--branch-coverage] [--no-branch-coverage]
            [--demangle-cpp]
            tracefile(s)

説明

tracefileで検出されたカバレッジデータのHTMLビューを作成します。 tracefileがまた、ファイル名のリストであることに注意してください。

HTML出力ファイルは--output-directoryオプションが使用されている場合を除き、現在の作業ディレクトリで 作成されます。tracefileが".gz"で終わっている場合、それはGZIP圧縮であるとみなされ、 gunzipツールは、透過的にそれを解凍するために使用されます。

すべてのソースコードファイルがそれらがコンパイルされた正確なファイルシステムの場所に存在し、 読み取り可能でなければならないことに注意してください。

レイアウトや生成されたHTML出力の色を変更するには--css-fileオプションを使用してください。 ファイルは、関連するカバレッジ率に応じて異なる色でマークされます。 デフォルトでは、低、中、高カバレッジのカバレッジの限界は、それぞれ 0～15%、15～50%、50～100％に設定されています。これらの値を変更するには、 設定ファイルのオプションのgenhtml_hi_limitとgenhtml_med_limitを使用してください。

オプション

-h
--help

短いヘルプテキストを表示して終了します。

-v
--version

バージョン番号を表示し、終了します。

-q
--quiet

進行状況メッセージを出力しません。

すべての情報の進行状況の出力を抑止します。 このスイッチが有効になっている場合、エラーまたは警告メッセージのみが出力されます。

-f
--frames

ソースコードビュー用のHTMLフレームを使用します。

有効にした場合、フレームセットは、"クリック可能な"画像としてソースコードの概要を提供し、 各ソースコードファイルに対して作成されます。各ソースコードの文字が一度に検査する必要があるため、 このオプションが著しく出力の作成を遅くすることに注意してください。 このオプションが機能するためにはGD.pm Perlモジュール（http://www.cpan.org から得られます）が インストールされている必要があることにも注意してください。

-s
--show-details

詳細なディレクトリビューを生成します。

このオプションが有効になっている場合、genhtmlは、それぞれのファイルのビューの2つの バージョンを生成します。標準的な情報に加えて、"詳細"バージョンへのリンクを含むものです。 後者はさらに、各ソースファイルの行数をカバーするテストケースについての情報が含まれています。

-b baseline-file
--baseline-file baseline-file

カバレッジベースラインとしてbaseline-file内のデータを使用します。

baseline-fileで指定されたトレースファイルが読み取られ、 元のtracefileで見つかったすべてのカウントは、任意の出力を作成する前に baseline-file内の対応するカウントがデクリメントされます。

baseline-file内の特定の行のカウントがtracefileの数より大きい場合、 結果がゼロであることに注意してください。

-o output-directory
--output-directory output-directory

output-directory内にファイルを作成します。

現在のディレクトリ以外のディレクトリに結果ファイルを書き込むことgenhtmlを伝えるために このオプションを使用します。output-directoryが存在しない場合は、作成されます。

それがプロジェクトのサイズ（ファイルとサブディレクトリの多くが作成されることがあります）に依存するので このオプションを使用することをお勧めします。

-t title
--title title

すべてのページのヘッダにtitleを表示します。

titleは、特定の出力が作成されたコンテキストを識別するために生成された各HTMLページのヘッダー部分に 書き込まれます。デフォルトでは、トレースファイルの名前です。

-d description-file
--description-file description-file

description-fileからテストケースの説明を読み取ります。

入力データファイルで参照され、description-file内で発見されたすべてのテストケースの説明が 読み取られ、臨時のページ（後でHTML出力へ結合される）に出力されます。

description-fileのファイル形式は、次のとおりです:

各テストケースに対しては:

TN:<testname>
TD:<test description>

有効なテストケースの名前は、英字、数字およびアンダースコア文字('_')で構成することができます。

-k
--keep-descriptions

未使用のテストの説明を削除しません。

カバレッジデータが関連するテストケースがコードの任意の行をカバーしていないことを示していても 説明ファイル内の記述をします。

このオプションは、構成ファイルのオプションのgenhtml_keep_descriptionsを使用して 恒久的に設定することができます。

-c css-file
--css-file css-file

外部スタイルシートファイルcss-fileを使用します。

このオプションを使用して、外部.cssファイルは、デフォルトのものと置き換えるかを指定することができます。 デフォルトの色があなたの目が彼らのソケットから飛び出すと思わせる場合に便利かもしれません。:）

このオプションは、構成ファイルのオプションのgenhtml_css_fileを使用して恒久的に設定することができます。

-p prefix
--prefix prefix

すべてのディレクトリ名から接頭辞(prefix)を削除します。

長いファイル名を含むリストは読みにくいので、自動的に共通の接頭辞を使って概要ページの最初にある すべてのディレクトリ名を短くしようと実装されたメカニズムがあります。デフォルトでは、これが適用された場合、 すべてのディレクトリの名前の文字の、その和を最小化する、プレフィックスを見つけようとする アルゴリズムを使用して行われます。

自分で削除するプレフィックスを指定するには、このオプションを使用してください。

--no-prefix

ディレクトリの名前からプレフィックスを削除しません。

このスイッチは完全に前のセクションで説明されている接頭辞のメカニズムを無効にします。

このオプションは、構成ファイルのオプションのgenhtml_no_prefixを使用して恒久的に 設定することができます。

--no-source

ソースコードのビューを作成しません。

各ファイルのソースコードのビューを取得しない場合は、このスイッチを使用してください。

このオプションは、構成ファイルのオプションのgenhtml_no_sourceを使用して恒久的に設定することができます。

--num-spaces spaces

num個のスペースでソースビューでタブを置き換えます。

デフォルト値は8です。

このオプションは、構成ファイルのオプションのgenhtml_num_spacesを使用して恒久的に設定することができます。

--highlight

変換のみのカバレッジデータがある行を強調表示します。

前のソースコードのバージョンから変換されたデータセットでカバーされていたこれらの行のみ ハイライトするためにlcovの--diffオプションと一緒にこのオプションを使用してください。

このオプションは、構成ファイルのオプションのgenhtml_highlightを使用して恒久的に設定することができます。

--legend

HTML出力での色の凡例を含めます。

結果のHTML出力で色分けの意味を説明する凡例を含めるには、このオプションを使用してください。

このオプションは、構成ファイルのオプションのgenhtml_legendを使用して恒久的に設定することができます。

--html-prolog prolog-file

prolog-fileからカスタマイズされたHTMLプロローグを読み取ります。

prolog-fileの内容でデフォルトのHTMLのプロローグ （HTMLソースコードの最初の部分がに至るまでと<body>タグを含む）に置き換えるには、 このオプションを使用します。プロローグのテキスト内で、以下の単語は、 ページが生成されるときに置換されます:

@pagetitle@
ページのタイトル。

@basedir@
ベースディレクトリ（cssファイルを見つけるに対してのなど）に至る相対パス。

このオプションは、構成ファイルのオプションのgenhtml_html_prologを使用して 恒久的に設定することができます。

--html-epilog epilog-file

epilog-fileからカスタマイズされたHTMLエピローグを読み取ります。

epilog-fileの内容でデフォルトのHTMLエピローグ（</ BODY>を含むHTMLソースの最後の部分）を置き換えるには、 このオプションを使用します。

エピローグのテキスト内で、以下の単語は、ページが生成されるときに置換されます:

@basedir@
ベースディレクトリ（cssファイルを見つけるに対してのなど）に至る相対パス。

このオプションは、構成ファイルのオプションのgenhtml_html_epilogを使用して 恒久的に設定することができます。

--html-extension extension

生成されたHTMLページに対してのカスタマイズされたファイル名の拡張子を使用します。

このオプションは、異なるファイル名の拡張子（例：PHP）を正しく 結果のページをレンダリングするために必要とされる状況で有用です。 ファイル名とこのオプションで指定した拡張子の間に"."が挿入されることに注意してください。

このオプションは、コンフィギュレーションファイルオプションgenhtml_html_extensionを 使用して恒久的に設定することができます。

--html-gzip

gzipですべての生成されたHTMLファイルを圧縮し、 ルート出力ディレクトリにgzipエンコードを指定する.htaccessファイルを追加します。

あなたがあなたのウェブサーバ上のスペースを節約したい場合は、このオプションを使用してください。 .htaccessファイルをサポートするウェブサーバとgzipで圧縮されたHTMLをサポートしているブラウザが必要です。

このオプションは、構成ファイルのオプションのgenhtml_html_gzipを使用して恒久的に設定することができます。

--sort
--no-sort

ファイルとディレクトリの概要のソートされたビューを含めるかどうかを指定します。

ソートされたビューを含めるには--sortを、含めない場合は--no-sortを使用してください。 ソートされたビューはデフォルトでは有効になっています。

ソートされたビューが有効になっている場合、各概要ページには、 カバレッジ率によってソートされたそのページのビューへのリンクが含まれます。

このオプションは、構成ファイルのオプションのgenhtml_sortを使用して 恒久的に設定することができます。

--function-coverage
--no-function-coverage

HTML出力で関数カバレッジの要約を表示するかどうかを指定します。

関数カバレッジの要約を有効にするには--function-coverageを、 無効にするには--no-function-coverageを使用してください。 関数カバレッジの要約は、デフォルトで有効になっています。

関数カバレッジの要約が有効になっている場合、各概要ページには、 見つかった関数の数と結果カバレッジと一緒にファイルもしくはディレクトリごとの ヒット数が含まれます。

さらに、各ソースコードビューは、これらの関数のそのファイルに加えて、 それぞれの呼び出し回数で見つかった全ての関数をリストするページへのリンクが含まれることになります。

このオプションは、構成ファイルのオプションのgenhtml_function_coverageを 使用して恒久的に設定することができます。

--branch-coverage
--no-branch-coverage

HTML出力に分岐カバレッジデータを表示するかどうかを指定します。

分岐カバレッジ表示を有効にする場合は--branch-coverageを、 無効にするには--no-branch-coverageを使用してください。 分岐カバレッジデータの表示はデフォルトで有効になっています。

分岐カバレッジの表示が有効になっている場合、各概要ページには、結果としてカバレッジ率と共に、 ファイルもしくはディレクトリごとに見つかったブランチとヒット数が含まれます。 さらに、各ソースコードビューは、分岐がされたかどうかの表示を含む行のすべてのブランチを 一覧表示する追加の列が含まれます。分岐は、次の形式で表示されます

' + ': ブランチは、少なくとも1回は通った ' - ': ブランチは、通ってない ' # ': 分岐を含む基本ブロックが実行されなかった

このオプションは、構成ファイルのオプションのgenhtml_branch_coverageを使用して 恒久的に設定することができます。

--demangle-cpp

C++関数名をデマングルするかどうかを指定します。

あなたがHTML関数の概要ページに表示するためにC++の内部関数名を 人間が読める形式に変換したい場合は、このオプションを使用します。

このオプションを使用する場合はc++filtツールがインストールされている必要があります （c++filt(1)を参照してください）。

ファイル

/etc/lcovrc

システム全体の設定ファイル。

~/.lcovrc

ユーザごとの設定ファイル。

著者

Peter Oberparleiter <[e-mail]>

関連項目

lcov(1), geninfo(1), genpng(1), gendesc(1), gcov(1)

このドキュメントはlcov(英)のサイトを元に作成しました

Up: man page

Prev: lcov

Next: lcovrc