Kwscm

kwscm コマンドで、SCM システムから Klocwork Code Review に改訂版をロードし、チェックイン後のコードレビューを可能にします。kwscm は Klocwork サーバーパッケージの一部としてインストールされます。

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

前提条件

ClearCase、CVS、および Team Foundation の場合は、パスに SCM 実行可能ファイルが含まれている必要があります。
TFS の場合、Visual Studio コマンドプロンプトから kwscm を使用してください。

最初の使用法

kwscm --url http(s)://<klocwork_server_host>:<klocwork_server_port>/<project> <scm> [scm_options] <scm_path>

フィールド

<project> は Klocwork サーバーのプロジェクトです
<scm> は SCM です
[scm_options] は設定できる追加オプションです (以下の SCM ごとのリストを参照)
<scm_path> は以下のとおりです。
- SCM リポジトリへのパス、または
- ローカルパス (コマンドがローカル SCM リポジトリから実行される場合)

次のようにして、kwscm 用の引数ファイルも指定できます。例:

kwscm --url http://server01:8080/myproject/ svn http://devserver/svn/myproject

トラブルシューティング

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

その後の使用

SCM との統合後、システムに新しいリビジョンを定期的にロードして、連続する履歴を維持する必要があります。このプロセスは一般に、連続する統合システムを使用してスクリプトを作成するか、crond などの Unix コマンドを使用して自動的に実行されるように設定できます。

必要なリビジョンオプションを指定した場合、kwscm では自動的に、履歴にロードしようとしている新しいリビジョンに関連するすべてのファイルの適切なバージョンを特定し、ロードします。

日付またはリビジョン範囲が指定されていない場合、kwscm では履歴全体をロードするのではなく、定義済みの日付/リビジョン範囲 (選択した SCM によって異なる) を保持します。データベース全体を毎回ロードすると、ロードに時間がかかる場合があります。

スクリプトコマンドは次のようになります。

kwscm --url http://<klocwork_server_host>:<klocwork_server_port>/<project> <scm> [scm_options] <revision_options> <scm_path>

フィールド

<revision_options> は、履歴にロードする新しいリビジョンを指定します。

SCM に必要なオプションと構文を使用してリビジョンを指定してください。

例:

kwscm --url http://server01:8080/myproject/ svn --revision rev4:rev8 http://devserver/svn/myproject

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

名前	短い名前	説明
--encoding <string>		プロジェクトで使用するソースファイルのエンコードを指定します。デフォルトは、お使いのシステムのエンコーディングです。許容される値のリストを検索するには、kwconv の `--list` オプションを使用します。詳細については、kwbuildproject の `--encoding` オプションを参照してください。
--force	-f	コマンドラインツールがゼロ以外の終了コードで終了しても、実行を強制します。何かに失敗したらそれをバイパスする場合、強制実行を指定するとエラーが無視されコマンドが実行されます。
--help	-h	このヘルプを表示して終了します
--tags	-t	コードレビューに割り当てるタグを指定します。これらのタグを指定すると、他のユーザーが特定のタグを持つコードレビューを表示できるかどうかをフィードし、制御することもできます。
--url http://<host>:<port>/<project>		Klocwork サーバー上のプロジェクトの URLであり、書式は http://<server_host>:<server_port>/<project> です。Klocwork サーバーセキュア接続が構成されている場合は、https:// を使用してください。
--verbose	-v	プログラム実行についての詳細情報を表示します。これは、エラーのトラブルシューティングに役立ちます。
--version		バージョンを表示します。

kwscm cc

前提条件

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

例

kwscm --url http://server01:8080/myproject cc --since 22-November-2010 -R .

オプション

名前	短い名前	説明
--all	-a	pname を含む VOB のすべてのチェックアウトをリストします
--avobs		`--all` と似ていますが、ローカルホスト上でアクティブな (実装された) すべての VOB のチェックアウトを含みます
--branch <branch>	-b	ブランチを指定します
--recurse	-R	現在のビューで遭遇したディレクトリの下にあるサブツリー全体の要素のチェックアウトをリストします。
--since <date-time>		指定された日時以降 (その時点以後) に記録されたイベントをリストします。例: 14-March-2011.11:21:33 ClearCase に必要な日時構文を使用します。このオプションを指定しなかった場合、kwscm は警告を発行し、過去 2 週間分のロードを続行します。

kwscm cvs

前提条件

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

例

kwscm --url http://server01:8080/myproject cvs -d :pserver:dev01@workserver:/home/cvs -r rev1:rev2 zlib

オプション

名前	短い名前	説明
-d <cvs_root>		CVS ツリーのルートとして $CVSROOT を指定します。
-dates <date_range>		日付範囲を指定します。CVS で使用れる適切な構文に従います。
--revision <revision_number(s)>	-r	リビジョンを指定します。CVS で使用される適切な構文に従います。 `--dates` または `--revision` が指定されていない場合、kwscm は警告を発行し、過去 2 週間分のリビジョンのロードを続行します。

kwscm git

例

kwscm --url http://server01:8080/myproject git --last=10 .

オプション

名前	説明
--git-dir <path>	リポジトリへのパスを設定します。
--last <last>	リビジョンの最後の N 個をロードします。たとえば、N を 3 に設定した場合、最後の 3 個のリビジョンが履歴にロードされます。リビジョン範囲がサポートされている場合は、`git <since>..<until>` を指定します。`--last` またはリビジョン範囲が指定されていない場合、kwscm は警告を発行し、`--last=100` を使用して処理を続行します。
--work-tree <path>	ワーキングツリーへのパスを設定します。

kwscm p4

例

kwscm --url http://server01:8080/myproject p4 --last 5 //pyunit/...

オプション

名前	短い名前	説明
--last <last>		リビジョンの最後の N 個をロードします。たとえば、N を 3 に設定した場合、最後の 3 個のリビジョンが履歴にロードされます。バージョン指定子を使用することもできます。`--last` またはリビジョン範囲が指定されていない場合、kwscm は警告を発行し、過去 2 週間分のリビジョンのロードを続行します。
--password <password>	-P	パスワードを指定します (環境で $P4PASSWD の値をオーバーライドします)。
--user <user>		ユーザー名を指定します (環境の $P4USER、$USER、および $USERNAME の値をオーバーライドします)。

名前

短い名前

説明

--last <last>

リビジョンの最後の N 個をロードします。たとえば、N を 3 に設定した場合、最後の 3 個のリビジョンが履歴にロードされます。

バージョン指定子を使用することもできます。--last またはリビジョン範囲が指定されていない場合、kwscm は警告を発行し、過去 2 週間分のリビジョンのロードを続行します。

--password <password>

-P

パスワードを指定します (環境で $P4PASSWD の値をオーバーライドします)。

--user <user>

ユーザー名を指定します (環境の $P4USER、$USER、および $USERNAME の値をオーバーライドします)。

Important: ソース制御のファイルサイズが 20 MB を超える場合は、Kwscmにバイナリとして扱われます。つまり、ファイルサイズが 20 MB を超えるファイルでは、リビジョンの差分を表示することはできません。

kwscm svn

例

kwscm --url http://server01:8080/myproject/ svn -r BASE:rev2659 http://devserver/svn/myproject

オプション

名前	短い名前	説明
--limit <integer>	-l	ロードする最後のリビジョンの数を指定します。
--revision <revision_number(s)>	-r	リビジョンを指定します。単一のリビジョン (rev1) または範囲 (rev1:rev5) を指定できます。リビジョン範囲を指定する場合、'HEAD' を使用することもできます。 `--revision` または `--limit` が指定されていない場合、kwscm は警告を発行し、過去 2 週間分のリビジョンのロードを続行します。

kwscm tf

前提条件

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

例

kwscm --url http://server01:8080/myproject tf --vspec C23~C62 $/zlib

オプション

名前	説明
--server <server>	チーム設立サーバーを特定します。ワークスペースにマッピングされていないディレクトリから kwscm を呼び出す場合は必要です。
--stopafter <integer>	指定した最新の変更セット数の履歴をロードします
--vspec <version>	バージョンスペックを指定します。変更セットの範囲を指定するには、チーム設立アイテムスペックを使用します。 `--stopafter`、`--vspec`、またはリビジョン範囲が指定されていない場合、kwscm は警告を発行し、`--stopafter=100` を使用して処理を続行します。