polyspace_report

Polyspace 解析結果のレポートを生成

ページ内をすべて折りたたむ

構文

polyspace_report('-template', template, '-results-dir', resultsFolder, options)
polyspace_report('-generate-results-list-file', '-results-dir', resultsFolder, options)
polyspace_report('-generate-variable-access-file', '-results-dir', resultsFolder, options)

説明

polyspace_report('-template', template, '-results-dir', resultsFolder, options) は、template が指定する事前定義されたテンプレートを使用してレポートを生成します。既定では、レポートにはフォルダー resultsFolder 内の結果ファイルに由来した名前が付けられ、Polyspace-Doc サブフォルダーに保存されます。この既定の動作は、追加オプションを使用して変更できます。

例

polyspace_report('-generate-results-list-file', '-results-dir', resultsFolder, options) は Polyspace® 結果のリストをタブ区切りのテキスト ファイルにエクスポートします。

polyspace_report('-generate-variable-access-file', '-results-dir', resultsFolder, options) はグローバル変数のリストをタブ区切りのテキスト ファイルにエクスポートします。

メモ

例

すべて折りたたむ

サンプルの Polyspace Code Prover™ の結果から PDF レポートを生成します。

template = fullfile(polyspaceroot,'toolbox','polyspace','psrptgen','templates',...
    'Developer.rpt');
resPath = fullfile(polyspaceroot,'polyspace','examples','cxx','Code_Prover_Example',...
    'Module_1','CP_Result');
polyspace_report('-template', template, '-results-dir', resPath, '-format', 'PDF');

入力引数

すべて折りたたむ

レポート テンプレート ファイルへのパス。文字ベクトルとして指定します。複数のレポートを生成するには、レポート テンプレート パスのコンマ区切りのリストを文字ベクトルで指定します (コンマの後にはスペースを配置しません)。テンプレートは .rpt ファイルとして polyspaceroot\toolbox\polyspace\psrptgen\templates\ にあります。ここで、polyspaceroot は Polyspace インストール フォルダーです。使用可能なテンプレートの詳細は、Bug Finder と Code Prover のレポート (-report-template) を参照してください。

例: fullfile(polyspaceroot,'toolbox','polyspace','psrptgen','templates', 'Developer.rpt');

解析結果を含むフォルダー。文字ベクトルとして指定します。このフォルダーには、Polyspace Bug Finder™ の結果を含む .psbf ファイル、または Polyspace Code Prover の結果を含む .pscp ファイルが含まれていなければなりません。

複数の解析のレポートを生成するには、フォルダー パスのコンマ区切りのリストを指定します (コンマの後にはスペースを配置しません)。

例: 'C:\Polyspace_Workspace\My_project\Module_1\results'

出力形式や出力名など、レポート生成を制御するオプション。

各オプションを文字ベクトルとして指定します。それに続けて、オプションの値を個別の文字ベクトルとして指定します。たとえば、構文 polyspace_report(..., '-format','PDF') を使用して、PDF 形式を指定できます。

オプション値説明
'-format''PDF'、 'HTML'、または 'WORD'

生成されるレポートのファイル形式。既定では、このコマンドは Word ドキュメントを生成します。

複数の形式でレポートを生成するには、形式のコンマ区切りのリストを指定します (コンマの後にはスペースを配置しません)。たとえば、polyspace_report(..., '-format', 'PDF,HTML') です。

このオプションは -generate-variable-access-file および -generate-results-list-file とは互換性がありません。

'-output-name'

レポート名 (PolyspaceReport など)。

生成されるレポート名、または複数のレポートを生成する場合はフォルダー名。

レポートへの絶対パスは、名前を現在の作業フォルダーに追加することによって作成されます。レポートを異なるパスで保存するには、絶対パスをこのオプションの値として指定します。

'-noview' 

生成されるレポートのオープンを無効にします。このオプションを指定しない場合、生成されたレポートはレポート タイプに対する既定のアプリケーション (例: PDF レポートの場合 PDF ビューアー) で開きます。

'-set-language-english' 

英語でレポートを生成。表示オプションが別の言語に設定されている場合、このオプションを使用します。

ヒント

非常に多数の欠陥やコーディング ルール違反が含まれている結果セットでは、レポートの生成に時間がかかることがあります。場合によっては、メモリ不足に起因する問題が発生することがあります。これが発生した場合は、Java® ヒープ サイズを増やすか、またはオプションと値のペア '-wysiwyg', 'scopeName' を使用して、すべての結果を含む 1 つのファイルではなく、フィルター済みの複数のレポートを生成することができます。ここで、scopeName は、報告対象の結果のリストを絞り込むレビュー スコープの名前です。このようなレビュー スコープの作成方法の詳細については、Polyspace レポート生成時のメモリ不足エラーの修正を参照してください。

バージョン履歴

R2013b で導入