Kwcodereview

kwcodereview コマンドで、チェックイン前のコードレビューを作成します。チェックイン前のコードレビューでは、Code Review はローカルで修正されたソースコードとベース SCM バージョンを比較します。

kwcodereview は、ネイティブ SCM クライアントの機能を模倣するように設計されています。以下に特に断りのない限り、お使いの SCM と同じように機能すると想定して構いません。

前提条件

  • パス (Git や SVN など) に SCM ツールを格納しているディレクトリが含まれている必要があります。ClearCase、CVS、および Team Foundation の場合は、パスに SCM 実行可能ファイルが含まれている必要があります。
  • 検出された指摘をコードレビューの一部として表示および更新するには、デスクトップにローカル Klocwork プロジェクト (.kwlp) が設定されており、そのプロジェクトが統合プロジェクトに接続されている必要があります。connected desktop (コネクテッドデスクトップ) を既に使用している場合、この手順は自動的に実行されます。それ以外の場合は、Klocwork Desktop Analysis を使用したチェックイン前の指摘の修正で開発環境を選択してください。

    Tip: コードレビューには、コードで検出された指摘が表示されるため、デスクトップ解析を常に最新の状態にしておき、修正可能な指摘を修正し、チェックイン前のレビューを起動する前に残りの指摘を更新しておくと役立ちます。

使用方法

kwcodereview [--project-dir <local_project_dir>] [--message <message>] [--reviewer <user1>,<user2>...]<scm> [<file1>|<directory1> <file2>|<directory2>...]|<scm_path>

フィールド

  • <local_project_dir> は、ローカル Klocwork プロジェクト (.kwlp) の場所です。ローカルプロジェクトディレクトリの名前が .kwlp であり、しかもこのディレクトリが変更がないかスキャンしているフォルダーまたはその親フォルダーの 1 つにある場合、--project-dir オプションを設定する必要はありません。
  • <message> は、Code Review のコードレビューで表示されるメッセージです。キーワード ref: とメッセージのコードレビューの revisionID を指定すると、別のコードレビューにリンクできます。これは、レビューが拒否された場合に、新しいバージョンのコードを送信してレビューする際に便利です。コードレビューの revisionID を取得するには、Code Review フィードのリビジョンにカーソルを合わせて URL を表示します。URL は、IDE 内または kwcodereview によってアクセスすることもできます。たとえば、次の URL から ref:4 を使用します: http://jlee.example.com:8080/codereview/CodeReview.htm#revision_goto:revisionId=4。--message が指定されない場合、メッセージを入力するよう促されます。メッセージを終了するには、新しい行に移動し、Ctrl+D (Unix) または Ctrl+Z の後に <Enter> (Windows) を押します。
  • <scm> は、ソースコード管理システムです。
  • <file>|<directory> は、バージョンコントロールのチェックアウト以降に加えられた変更がないかをスキャンする 1 つ以上のファイルまたはディレクトリです。パスに '.' を指定し、お使いの SCM がこの使用法をサポートしている場合、現在のディレクトリがスキャンされます。レビュー対象ファイルを 1 行に 1 つずつ記載したリストを含むテキストファイルを指定することもできます。
  • <scm_path> は、お使いの SCM リポジトリまたはローカルパスへのパスです。

例 

kwcodereview  --project-dir e:\myproj\.kwlp --message "Fix for PR55555" --reviewer fbrown,jblack svn e:\myproj\sources\engine

Tip: ローカルに検出された指摘を表示しないチェックイン前のコードレビューを設定することもできます。これは、Klocwork プロジェクトの一部ではないファイルに便利です。この状況では、--project-dir オプションではなく --url オプションを使用してください。依然として、Klocwork サーバーのホスト、ポート、およびプロジェクトをポイントする必要はありますが、お使いのファイルはこのプロジェクトの一部である必要はありません。

kwcodereview --url http://<klocwork_server_host>:<klocwork_server_port>/<project> [--message <message>] [--reviewer <user1>,<user2>...]<scm> [<files>|<directories>]|<scm_path>

例 

kwcodereview --url http://server01:8080/myproject --message "Fix for PR55555" --reviewer fbrown,jblack cvs /path/to/project

この例では、

  • server01 は Klocwork サーバーのホストです。
  • 8080 は Klocwork サーバーのポートです。
  • myproject は、Klocwork サーバー上の統合プロジェクトです。
  • "Fix for PR55555" は、Code Review のコードレビューで表示されるメッセージです。
  • fbrown,jblack は、コードレビューに招待するレビュー担当者です。
  • /path/to/project は、CVS ソースへのパスです。

トラブルシューティング

kwcodereview の実行に失敗すると、使用されたコマンド、コマンドの出力、および戻り値コードが表示されます。詳細情報が必要な場合は、元のコマンドラインに --verbose オプションを追加してください。エラーメッセージに、トラブルシューティングできない問題が示された場合は、カスタマーサポートにお問い合わせください。

すべてのサブコマンドに適用されるオプション

名前 短い名前 説明
--dry-run   ローカルに変更/追加/削除されたファイルのリストを表示します。このリストを確認してから、コードレビューを提出することができます。
--encoding <string>   プロジェクトで使用するソースファイルのエンコードを指定します。デフォルトは、お使いのシステムのエンコーディングです。許容される値のリストを検索するには、kwconv の --list オプションを使用します。詳細については、kwbuildproject の --encoding オプションを参照してください。
--fix <code_review_ID>   修正されたコードレビューの ID を指定します。これにより、以前に拒否されたコードレビューを再送信でき、レビュー担当者が修正内容を承認または拒否できます。
--force -f コマンドラインツールがゼロ以外の終了コードで終了しても、実行を強制します。何かに失敗したらそれをバイパスする場合、強制実行を指定するとエラーが無視されコマンドが実行されます。
--help   コマンドラインヘルプを表示します。このオプションは、kwcodereview とSCM サブコマンドで使用することができます。
--message <message> -m Code Review でこのコードレビューとともに表示するメッセージ。
--project-dir <Klocwork_local_project_dir> -pd ローカルプロジェクトの場所を指定します。これは、チェックイン前コードで検出された指摘をアップロードするためです。レビュー担当者が、検出された指摘を表示し評価と更新を実行することができます。ローカルプロジェクトディレクトリの名前が .kwlp であり、しかもこのディレクトリが変更がないかスキャンしているフォルダーまたはその親フォルダーの 1 つにある場合、--project-dir オプションを設定する必要はありません。このオプションは --url オプションと組み合わせて使用できないことに注意してください。
--reviewer <string> -r レビューに招待する参加者のリストを指定します。このレビューは、Code Review で各参加者の「実行予定」フィードに表示され、参加者はレビューを承認または除外することができます。このオプションは、参加者ごとに 1 回指定するか、ユーザー名のカンマ区切りリストを指定することができます。ユーザー名にスペースが含まれる場合、二重引用符 (") で囲んでください。このオプションで参加者を招待するには、その参加者が Code Review に既にログインしている必要があります。
--tags <string> -t コードレビューに割り当てるタグを指定します。これらのタグを指定すると、他のユーザーが特定のタグを持つコードレビューを表示できるかどうかをフィードおよび制御できます。
--url http://<host>:<port>/<project>   Klocwork サーバー上のプロジェクトの URLであり、書式は http://<server_host>:<server_port>/<project> です。Klocwork サーバーセキュア接続が構成されている場合は、https:// を使用してください。このオプションは、コードレビューで検出された指摘を表示しない場合に使用します。このオプションは --project-dir オプションと組み合わせて使用できないことに注意してください。
--verbose   プログラム実行についての詳細情報を表示します。これは、エラーのトラブルシューティングに役立ちます。
--version   show version

kwcodereview cc

前提条件

  • 実行可能な cleartool を、パスに指定する必要があります。

例 

kwcodereview --url http://server01:8080 --message "Fix for PR55555" --reviewer fbrown,jblack --tags myTag1,myTag2 cc -R .

オプション

名前 短い名前 説明
--base   チェックイン前のコードレビューのベースリビジョンまたはラベルを指定します。
--cview   リスト内容を現在のビューで行われたチェックアウトに制限します。
--recurse -R 現在のビューで遭遇したディレクトリの下にあるサブツリー全体の要素のチェックアウトをリストします。

Restriction: ClearCase リモートクライアントビューおよび ClearCase スナップショットビューはサポートされていません。

kwcodereview cvs

前提条件

  • 実行可能な cvs を、パスに指定する必要があります。

例 

kwcodereview --url http://server01:8080 --message "Fix for PR55555" --reviewer fbrown,jblack --tags myTag1,myTag2 cvs .

オプション

名前 短い名前 説明
-d <cvs_root>   CVS ツリーのルートとして $CVSROOT を指定します。

kwcodereview git

例 

kwcodereview --url http://server01:8080 --message "Fix for PR55555" --reviewer fbrown,jblack --tags myTag1,myTag2 git .

オプション

名前 短い名前 説明
--git-dir <path>   リポジトリへのパスを設定します。
--revision <string> -r リビジョンを指定します。
--work-tree <path>   ワーキングツリーへのパスを設定します。

kwcodereview p4

例 

kwcodereview --url http://server01:8080 --message "Fix for PR55555" --reviewer fbrown,jblack --tags myTag1,myTag2 p4 e:\myproject\sources\engine

オプション

名前 短い名前 説明
--changelist <integer> -C 非デフォルトの changelist# を指定します。
--charset <string>   Perforce 文字セットを指定します (環境内で $P4CHARSET の値を上書きします)。
--client <string> -c Perforce クライアントワークスペースを指定します ($P4CLIENT の値を上書きします)。デフォルトはマシンのホスト名 (Windows では COMPUTERNAME 環境変数)、または設定されている場合は $P4CLIENT になります。
--password <password> -P パスワードを指定します (環境内で $P4PASSWD の値を上書きします)。
--server <string>   Perforce サーバー [protocol (tcp または sll)]:<host>:<port> の場所を指定します。これは $P4PORT 値を上書きします。デフォルトは 'perforce: 1666'、または設定されている場合は $P4PORT の値になります。
--user <string> -u ユーザー名を指定します (環境内で $P4USER、$USER、および $USERNAME の値を上書きします)。

kwcodereview svn

例 

kwcodereview --url http://server01:8080 --message "Fix for PR55555" --reviewer fbrown,jblack --tags myTag1,myTag2 svn .

kwcodereview tf

前提条件

  • Visual Studio コマンドプロンプトから kwcodereview を使用してください。

例 

kwcodereview --url http://server01:8080 --message "Fix for PR55555" --reviewer fbrown,jblack --tags myTag1,myTag2 tf .

オプション

名前 短い名前 説明
--server <server>   チーム設立サーバーを特定します。ワークスペースにマッピングされていないディレクトリからコマンドを呼び出す場合は必要です。