はじめに
本ドキュメントで解説されている手順を実行するためには、ターゲットマシンでPerforce QACソフトウェアのインストールおよびライセンスの設定が正しく行われている必要があります。 Perforce QACソフトウェアは、初回の起動時にライセンスサーバの詳細を要求します。
デスクトップユーザ(GUI、qacli、 IDE plugins)には「ユーザ」ライセンスが必要です。ライセンスの設定が正しくないと解析、レポート、Validateへのアップロードが無効化される結果になります。さらに、診断結果の場所が非表示になるため、解析結果を見ることができなくなります。
サーバユーザ(build または、 CI build ユーザ)には「ビルド」ライセンスが必要です。ライセンスの設定が正しくないと qacli validate build または、qacli validate cibuild 処理が停止します。
ライセンスサーバの詳細は、[管理]メニューで[ライセンスサーバ]をクリックすることで設定できます。 ライセンスサーバの設定 に関してサポートが必要な場合は東陽テクニカまでご連絡ください。
Microsoft Visual Studio、Microsoft Visual Studio Code および EclipseをベースとしたIDE(統合開発環境)のユーザには、Perforce QACはこれらのアプリケーションに対するプラグインを用意しています。 プラグインはPerforce QACソフトウェアのインストールディレクトリのide_pluginsディレクトリ下にあります。例:
プラグインの使用説明は、該当するサブデレクトリの関連する言語フォルダ内にあります。
本ドキュメントでは、コマンド、ファイル名およびディレクトリ構造を等幅フォントで表します。例:
Perforce QACソフトウェアを利用することで、ソースコードファイルの解析を簡単に開始できるようになるほか、解析結果の精査も簡単に行えるようになります。
また、Perforce QACのプログラムは、既存のビルド環境の情報を利用してPerforce QACのプログラム自身にコードの情報を取り込み、審査中のコードとは別個単独で実行されます。
Perforce QACは、ユーザがPerforce QACから解析結果を取得し、それらの解析結果に基づき既存のコード開発環境においてソースコードを変更することができるように作られています。
ビルドサーバ上で、予め決まった解析手順をコードのセットに対して実行するなど、Perforce QACを自動化された環境で作動することもできます。 しかし、このような操作については本ドキュメントの説明範囲外になります。
Perforce QACソフトウェアは既存のコードプロジェクトと統合することができます。統合に必要な情報は、コードビルド構成に関する情報(ソースファイル、インクルードパス、環境設定など)を読み込むことで収集します。 Perforce QACは、単一のソースファイルを「指定」して解析を行うことはできませんが、単一のソースファイルを含んだプロジェクトを作成することは可能です(サンプルプロジェクトのsample_inspect_c
は、このようなプロジェクトの例です)。