ワーク ファイル内でのキーワードの使用
キーワードは、テキスト ベースのワーク ファイルに挿入できるプレースホルダです。このプレースホルダは、ワーク ファイル内のテキスト情報を表すために使用される特別な変数 ($Date$、$Author$、$State$ など) ですキーワードは、リビジョンをチェックアウトする際に展開できます (つまり、リテラル値に置き換えることができます)。
キーワードを使用するには、ドル記号で囲んだキーワード ("$Date$" など) をワーク ファイルに含め、そのファイルをアーカイブにチェックインします。
たとえば、担当者が編集中のメンバーに関する情報をファイルのコメントとして確認したいと考えているとします。これはキーワードを使用して実行できます。担当者は $Log$ キーワードを使用することにします。設定を変更してメンバーのチェックアウト時のキーワード拡張を有効にし、メンバーの中にキーワードを配置します。
|
|
管理者は、ユーザーがカスタム キーワードを使用できるように定義できます。カスタムキーワードについては、管理者に問い合わせてください。
|
次にリビジョンをチェックアウトすると、キーワード拡張がオンになっている場合、Windchill RV&S によってキーワードがスキャンされ、該当する情報に置き換えられます。
キーワード拡張は、リビジョンがチェックアウトまたは参照された場合に、キーワード参照に情報が自動的に追加または更新されるプロセスです。
たとえば、$Date$ キーワードが検出された場合、(チェックイン時に割り当てられた) リビジョンの日時がキーワードの一部としてワーク ファイルに追加されます。展開されると、エントリは次のように表示されます。
$Date: 2016/08/23 20:59:27IST $
このようにキーワードに情報を追加または更新する方法はキーワード拡張と呼ばれます。
たとえば、メンバー main.c にキーワード $Author$ と $State$ が埋め込まれている場合、main.c をチェックアウトして、次のコマンドを発行します。
ident main.c
この場合、このコマンドにより次が返されます。
main.c:
$Author: Taherali, Khuzema (ktaherali) $
$State: Exp $
次の Windchill RV&S コマンドにはキーワード拡張オプションが含まれます。
• メンバーの追加
• チェックアウト
• チェックイン
• 再同期
• メンバーを元に戻す
• リビジョンの内容ビュー ( > > )
• si annotate (CLI のみ)
GUI では、キーワード拡張は 「設定」 ダイアログ ボックスを使用して構成されます。GUI のダイアログ ボックスではデフォルト設定を上書きできます。
|
|
• 管理者は、キーワードを無視するように Windchill RV&S のポリシーを設定することができます。このポリシーにより、キーワード設定が上書きされます。このポリシーがプロジェクトに対して設定されているかどうかについて、Windchill RV&S が通知することはありません。キーワードが展開または縮小しない場合は、管理者に問い合わせてください。
• キーワード拡張はテキスト ファイルだけに適用されます。バイナリ ファイルに対しては無効です。
|
キーワードの前後のテキストは保持されるため、式の中 (上記の例) およびコメントの中で使用できます。
キーワード拡張が有効になっていて、チェックアウトしたテキスト ファイルに次の文字列が含まれているとします。
$Revision$
が含まれる場合、Windchill RV&S でこの文字列が検出されると、キーワード $Revision$ に値が次の形式で自動的に追加されます。
$Revision: value $
[値は次のとおりです][2]
"値" はキーワードに該当する値 (この場合、リビジョン番号) です。
たとえば、C のソース ファイルに次のステートメントが含まれているとします。
char revnum[] = "$Revision$";
この場合、ファイルのリビジョン番号を表す revnum という文字列が作成されます。プログラムの起動時にこの文字列を表示して、プログラムのソース ファイルの現在のリビジョンを自動的に示すように構成できます。
$Revision$ キーワードを使用したファイルのリビジョン番号の取得は、キーワードの一般的な応用方法の 1 つです。その他の一般的な応用方法は、次のとおりです。
• $Header$ キーワードは、リビジョンに関する有用な情報を 1 行のサマリーで提供します。この情報をコメントに含めると、メンバーを参照しているすべてのユーザーがその情報を利用できます。
• $Log$ キーワードは、$Header$ と同様の情報に加えて、リビジョンの説明も提供します。$Log$ キーワードには、時間の経過とともにメンバーに対して行われた変更の完全な一覧が含まれます。
|
|
$<keyword>$ という形式のキーワードを使用すると、Windchill RV&S では、最初の $ と次の $ の間が置き換えられます。$<keyword> という形式のキーワードを使用すると、Windchill RV&S では、別の $ が検出されるまで置き換えを続行します。Windchill RV&S では、ファイルをもう一度チェックアウトするまで別の $ が検出されない場合もあります。このタイプのキーワードを使用すると、ログに似た結果が返されます。
|
キーワード拡張の無効化
キーワードをリビジョン内とまったく同じ状態で保持するには、設定によってキーワード拡張を無効にします。
キーワードの検索
コマンド ライン インタフェースで ident コマンドを使用して、1 つ以上のメンバーのキーワード (展開されたキーワードまたは縮小されたキーワード) を検索および表示できます。ident コマンドに関する詳細は、CLI マニュアルページ を参照してください。
このコマンドは、キーワードを含むメンバーごとに名前とキーワードを表示します。これにより、ソース ファイルおよびコンパイル済みオブジェクト ファイルから識別情報を容易に取得できます。
Related Links
