History: lcovrc.5 - lcov翻訳 - lcov翻訳

名前

lcovrc - lcovのコンフィグレーションファイル

説明

lcovrcファイルはlcovコードカバレッジツール（lcov(1)参照）に対する構成情報を含みます。

システム全体の設定ファイルは/etc/lcovrcに位置しています。 単一ユーザー用の設定を変更するには、~/.lcovrcにこのファイルのコピーをカスタマイズしたものを置いてください。 設定ファイルが利用可能な場合、コマンドラインオプションはコンフィグレーションファイルの設定よりも優先されます。

構成ファイル内の行は次のいずれかになります:

• 空白文字のみで構成される空の行または行。これらの行は無視されます。

• ハッシュ記号('#')で始まるコメント行。これらは、空の行と同じように扱われ、無視されます。

• 'key = value'形式の文。有効な文とその説明のリストは下記のセクション"オプション"で見つけることができます。

コンフィグレーションの例:

        #
        # Example LCOV configuration file
        #

        # External style sheet file
        #genhtml_css_file = gcov.css

        # Coverage rate limits
        genhtml_hi_limit = 90
        genhtml_med_limit = 75

        # Width of line coverage field in source code view
        genhtml_line_field_width = 12

        # Width of branch coverage field in source code view
        genhtml_branch_field_width = 16

        # Width of overview image
        genhtml_overview_width = 80

        # Resolution of overview navigation
        genhtml_nav_resolution = 4

        # Offset for source code navigation
        genhtml_nav_offset = 10

        # Do not remove unused test descriptions if non-zero
        genhtml_keep_descriptions = 0

        # Do not remove prefix from directory names if non-zero
        genhtml_no_prefix = 0

        # Do not create source code view if non-zero
        genhtml_no_source = 0

        # Specify size of tabs
        genhtml_num_spaces = 8

        # Highlight lines with converted-only data if non-zero
        genhtml_highlight = 0

        # Include color legend in HTML output if non-zero
        genhtml_legend = 0

        # Include HTML file at start of HTML output
        #genhtml_html_prolog = prolog.php

        # Include HTML file at end of HTML output
        #genhtml_html_epilog = epilog.php

        # Use custom HTML file extension
        #genhtml_html_extension = html

        # Compress all generated html files with gzip.
        #genhtml_html_gzip = 1

        # Include sorted overview pages
        genhtml_sort = 1

        # Include function coverage data display
        genhtml_function_coverage = 1

        # Include branch coverage data display
        genhtml_branch_coverage = 1

        # Location of the gcov tool
        #geninfo_gcov_tool = gcov

        # Adjust test names if non-zero
        #geninfo_adjust_testname = 0

        # Calculate a checksum for each line if non-zero
        geninfo_checksum = 0

        # Enable libtool compatibility mode if non-zero
        geninfo_compat_libtool = 0

        # Directory containing gcov kernel files
        lcov_gcov_dir = /proc/gcov

        # Location for temporary directories
        lcov_tmp_dir = /tmp

        # Show full paths during list operation if non-zero
        lcov_list_full_path = 0

        # Specify the maximum width for list output. This value is
        # ignored when lcov_list_full_path is non-zero.
        lcov_list_width = 80

        # Specify the maximum percentage of file names which may be
        # truncated when choosing a directory prefix in list output.
        # This value is ignored when lcov_list_full_path is non-zero.

        lcov_list_truncate_max = 20

オプション

genhtml_css_file = filename

外部スタイルシートファイルを指定します。 genhtmlによって生成されるHTML出力の外観を変更するには、このオプションを使用します。 出力の生成中に、このファイルのコピーが出力ディレクトリに配置されます。

このオプションはgenhtmlの--css-fileコマンドラインオプションに相当します。

デフォルトでは、標準のCSSファイルが生成されます。

genhtml_hi_limit = hi_limit
genhtml_med_limit = med_limit

ファイルのエントリを分類するためのカバレッジ率の限界を指定します。 結果が高、中、低のカバレッジとして分類されている行、関数とブランチカバレッジのカバレッジ率を （パーセントで）変更するには、このオプションを使用します。 この分類は、HTML出力の概要ページ上の、対応するエントリの色に影響を及ぼします:

High: hi_limit <= rate <= 100 デフォルトの色:緑
Medium: med_limit <= rate < hi_limit デフォルトの色:オレンジ
Low: 0 <= rate < med_limit デフォルトの色:赤

デフォルト値は90と75パーセントです。

genhtml_line_field_width = number_of_characters

行のカバレッジ情報を含むソースコードのビューの列の幅（文字数）を指定します。

デフォルトは12です。

genhtml_branch_field_width = number_of_characters

分岐カバレッジ情報を含むソースコードのビューの列の幅（文字数）を指定します。

デフォルトは16です。

genhtml_overview_width = pixel_size

genhtmlの--framesオプションを使用してHTML出力を生成するときに作成した 概要画像の幅（ピクセル単位）を指定します。

デフォルトは80です。

genhtml_nav_resolution = lines

genhtmlの--framesオプションを使用してHTML出力を生成する際に概観ナビゲーションの解像度を指定します。 この数字は、位置のソースコードのウィンドウがにスクロールされる概要と 位置から選択したユーザーの間の行の最大差を指定します。

デフォルトは4です。

genhtml_nav_offset = lines

genhtmlの--framesオプションを使用してHTML出力を生成する際に適用される 概要ナビゲーションの行のオフセットを指定します。 概要イメージで行をクリックすると、要求された行がウィンドウの最初の行ではないので、 少しさらに上の位置にあるソースコードビューを表示する必要があります。 この数値は、そのオフセットを指定します。

デフォルトは10です。

genhtml_keep_descriptions = 0|1

ゼロ以外の場合、genhtmlを使用してHTML出力を生成する際に、未使用のテストが保持されます。

このオプションはgenhtmlの--keep-descriptionsオプションに相当します。

デフォルトは0です。

genhtml_no_prefix = 0|1

ゼロ以外の場合、ディレクトリ名から、共通の接頭辞を検索して削除しようとしません。

このオプションはgenhtmlの--no-prefixオプションに相当します。

デフォルトは0です。

genhtml_no_source = 0|1

ゼロ以外の場合genhtmlを使用してHTML出力を生成するときに、ソースコードのビューを作成しません。

このオプションはgenhtmlの--no-sourceオプションに相当します。

デフォルトは0です。

genhtml_num_spaces = num

genhtmlによって生成されたHTMLソースコードビューのタブ文字の代わりとして使用するスペースの数を指定します。

このオプションはgenthmlの--num-spacesオプションに相当します。

デフォルトは8です。

genhtml_highlight = 0|1

ゼロ以外の場合、genhtmlによって生成されたHTML出力に変換されたデータのみを持つ行を強調表示します。

このオプションはgenhtmlの--highlightオプションに相当します。

デフォルトは0です。

genhtml_legend = 0|1

ゼロ以外の場合、genhtmlによって生成されるHTML出力で、色分けの意味を説明する凡例を含めます。

このオプションはgenhtmlの--legendオプションに相当します。

デフォルトは0です。

genhtml_html_prolog = filename

セットされた場合、HTML出力の先頭で指定されたファイルの内容が含まれます。

このオプションはgenhtmlの--html-prologオプションに相当します。

デフォルトでは、余分なプロローグは使用しません。

genhtml_html_epilog = filename

セットされた場合、HTML出力の最後に指定されたファイルの内容が含まれます。

このオプションはgenhtmlの--html-epilogオプションに相当します。

デフォルトでは、余分なエピローグを使用しません。

genhtml_html_extension = extension

セットされた場合、生成されたHTMLファイルのファイル名の拡張子として指定された文字列を使用します。

このオプションはgenhtmlの--html-extensionオプションに相当します。

デフォルトの拡張子は"html"です。

genhtml_html_gzip = 0|1

セットされた場合、gzipを使用してすべてのHTMLファイルを圧縮します。

このオプションはgenhtmlの--html-gzipオプションに相当します。

デフォルトでは0です。

genhtml_sort = 0|1

ゼロ以外の場合、genhtmlを使用してHTML出力を生成するときに カバレッジ率でソート済された概要ページを作成します。

このオプションはgenhtmlの--no-sortオプションを使用することによって0に設定することができます。

デフォルトは1です。

genhtml_function_coverage = 0|1

ゼロ以外の場合、genhtmlを使用してHTML出力を生成するとき、関数カバレッジデータが含まれます。

このオプションはgenhtmlの--no-function-coverageオプションを使用することによって0に設定することができます。

デフォルトは1です。

genhtml_branch_coverage = 0|1

ゼロ以外の場合、genhtmlを使用してHTML出力を生成するときに、ブランチカバレッジデータが含まれます。

このオプションはgenhtmlの--no-branch-coverageを使用することによって0に設定することができます。

デフォルトは1です。

geninfo_gcov_tool = path_to_gcov

データファイルからカバレッジ情報を生成するために使用される gcovのツール（gcovは（1）参照）の位置を指定します。

デフォルトは'gcov'です。

geninfo_adjust_testname = 0|1

ゼロ以外の場合、カバレッジデータをキャプチャするときにテスト名に オペレーティングシステムの情報を含むように調整します。

デフォルトは0です。

geninfo_checksum = 0|1

ゼロ以外場合、カバレッジデータをキャプチャする際、ソースコードのチェックサムを生成します。

チェックサムは、互換性のないソースコードのバージョンからカバレッジデータのマージ防止に有用です。 しかし、チェックサムの生成は、カバレッジファイルのサイズとそのファイルを生成するためにかかる時間を増大させます。 このオプションはgeninfoの--checksumと--no-checksum コマンドラインオプションに相当します。

デフォルトは0です。

geninfo_compat_libtool = 0|1

ゼロ以外の場合、libtoolの互換モードを有効にします。 libtoolの互換モードが有効になっている場合、lcovは".libs"という名前のディレクトリにある.daファイルに関連する ソースコードがその親ディレクトリで見つかると想定します。

このオプションはgeninfoの--compat-libtoolと--no-compat-libtoolオプションに相当します。

デフォルトは1です。

lcov_gcov_dir = path_to_kernel_coverage_data

カーネルのカバレッジデータが存在するディレクトリへのパスの指定するか、 または自動検出のため未定義のままにしておきます。

デフォルトでは自動検出です。

lcov_tmp_dir = temp

一時ファイルのため使用されるディレクトリの場所を指定します。

デフォルトは'/tmp'です。

lcov_list_full_path = 0|1

ゼロ以外の場合、リスト操作中にソースコードファイルへのフルパスを出力します。

このオプションはlcovの--list-full-pathオプションに相当します。

デフォルトは0です。

lcov_list_max_width = width

リスト出力の最大幅を指定します。lcov_list_full_pathがゼロでない場合、この値は無視されます。

デフォルトは80です。

lcov_list_truncate_max = percentage

リスト出力で、ディレクトリの接頭辞を選択する際に切り捨てられる可能性のある ファイル名の最大パーセンテージを指定します。 lcov_list_full_pathがゼロでない場合、この値は無視されます。

デフォルトは20です。

ファイル

/etc/lcovrc

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

~/.lcovrc

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

関連項目

lcov(1), genhtml(1), geninfo(1), gcov(1)