提出確認書チェックツール:製品技術部に渡すREADMEを追加。

git-svn-id: file:///Users/lillianskinner/Downloads/platinum/twl/TwlIPL/trunk@2681 b08762b0-b915-fc4b-9d8c-17b2551a87ff
This commit is contained in:
nishikawa_takeshi 2008-11-14 06:20:14 +00:00
parent 4bdb18d17c
commit 47d1934068
2 changed files with 200 additions and 0 deletions

View File

@ -0,0 +1,200 @@
=============================================================================
TWL提出確認書チェッカー
=============================================================================
* 目次
- 提出確認書チェッカーとは?
- パッケージ内容
- 動作環境
- 実行方法
- 出力
- エラーコード
- オプション
- 変更履歴
* --------------------------------------------------------------------
* 提出確認書チェッカーとは?
* --------------------------------------------------------------------
マスターROM提出確認書とSRLが一致するかを照合するツールです。
WindowsXPで動作し、オプションによって、
GUIでの操作とコンソール画面(コマンドプロンプト)上での操作を切り替えることができます。
コンソール画面上での操作は、バッチファイルやスクリプトに
組み込むことを考慮して用意しています。
また、提出確認書から提出バージョンを抜き出して表示したり、
リマスターバージョンと提出バージョンからTADバージョンの計算もできます。
* --------------------------------------------------------------------
* パッケージ内容
* --------------------------------------------------------------------
SheetCheckerTWL.exe
実行バイナリです。
extract_sheet.xsl
SheetCheckerTWL.exe の内部で使用されるファイルです。
SheetCheckerTWL.exe と同じフォルダに置いてください。
* --------------------------------------------------------------------
* 動作環境
* --------------------------------------------------------------------
Windows XP SP2 と .NET Framework 2.0が必要です。
MasterEditorTWL(TWL用マスターエディタ)が動作する環境であれば動作可能です。
* --------------------------------------------------------------------
* 実行方法
* --------------------------------------------------------------------
GUIで操作するか、コンソール画面上で操作するかによって、起動方法が異なります。
(1)GUI操作の場合
SheetCheckerTWL.exe のアイコンをダブルクリックするか、
コンソール(コマンドプロンプト)上で引数を指定せずに、
SheetCheckerTWL.exe を実行してください。
GUIが起動したら、ボタンを押して、
SRLファイルと提出確認書ファイルを選択してください。
テキストボックスへのドラッグアンドドロップでも選択可能です。
SRLと提出確認書が選択されたら、判定結果が出力されます。
(2)コンソール画面上での操作の場合
コンソール上で以下の引数をつけて実行してください。
$ SheetCheckerTWL.exe (SRL) (提出確認書) [オプション]
たとえば、SRLのファイル名が TNTRJ01.SRL であり、
提出確認書のファイル名が SHEET.XML の場合、以下の指定となります。
$ SheetCheckerTWL.exe TNTRJ01.SRL SHEET.XML
オプションについては後述します。
(オプションの指定位置は、引数の先頭や途中でもかまいません。)
* --------------------------------------------------------------------
* プログラムの返り値
* --------------------------------------------------------------------
コンソール画面上での操作の場合にのみ、プログラムの返り値があります。
この返り値は、%ERRORLEVEL%環境変数に格納されますので、
バッチファイルなどの分岐に利用することができます。
(GUI操作の場合には格納されません。)
* --------------------------------------------------------------------
* 出力
* --------------------------------------------------------------------
(1)GUIの場合
SRLと提出確認書の両方が選択されたら、両者のファイルから、
本ツールは、以下の情報を抜き出して比較します。
・イニシャルコード
・リマスターバージョン
・ファイルのCRC
これらがすべて一致した場合には「判定結果」の項目に「OK」が表示されます。
一致しない場合には、「NG」とエラーコードが表示されます。
また、比較でエラーとなった箇所が赤色で表示されます。
(ただし、上記の項目で最初に一致しなかった箇所のみが赤色となります。)
エラーコードについては後述します。
また、以下の情報も表示されます。
・提出バージョン
- 提出確認書から抜き出されます。
・TADバージョン
- メジャーバージョンを提出確認書から抜き出されたリマスターバージョンとし
マイナーバージョンを提出バージョンとしたときの16bitのTADバージョンです。
(2)CUIの場合
GUIの場合と同様の情報がコンソール画面に出力されます。
以下に例示します。
SRL: CardRomHeaderChecker.srl
Sheet: card.xml
SRL Sheet
---------------------------------------
InitialCode: 0CZA 0CZA
RemasterVersion: 01 01
File CRC: 4FFE 4FFE
---------------------------------------
SubmitVersion: - 14 (0E)
TAD Version: 270 (010E)
---------------------------------------
Result: OK
NGの場合には、Result の項目に「NG」と表示され、エラーコードが出力されます。
以下に例示します。
Result: NG (-1)
後述のオプションをつけて実行することによって、出力を変えることができます。
* --------------------------------------------------------------------
* エラーコード
* --------------------------------------------------------------------
以下は、「NG」とともに表示されるエラーコードです。
(プログラムの返り値ではありません。)
0 : エラーなし
-1 : イニシャルコードが一致しない
-2 : リマスターバージョンが一致しない
-3 : ファイルCRCが一致しない
-4 -7 : 予約
-8 : SRLの読み込みに失敗した
-9 : 提出確認書の読み込みに失敗した
-10 : 引数、あるいはオプションの指定に間違いがある
* --------------------------------------------------------------------
* オプション
* --------------------------------------------------------------------
コンソール画面上での操作の場合、オプションによって出力を変えることができます。
(1) -r オプション
判定結果のみを出力します。スクリプトなどに組み込む場合にご利用ください。
エラーがない場合には「0」が出力され、エラーの場合には、「-1」が出力されます。
(2) -s オプション
提出バージョンのみを出力します。
エラーがない場合には、提出バージョンが10進数で出力されます。
maketad でマイナーバージョンを指定する場合には、10進数で指定する必要があるためです。
エラーの場合には、エラーコード(-1)が出力されます。
スクリプトなどに組み込む場合にご利用ください。
(3) -t オプション
TADバージョンのみを出力します。
メジャーバージョンを提出確認書から抜き出されたリマスターバージョンとし
マイナーバージョンを提出バージョンとしたときの16bitの値が10進数で出力されます。
(リマスターバージョンが 01h、提出バージョンが 02h の場合には、258 が出力されます。)
エラーの場合には、エラーコード(-1)が出力されます。
CLS処理の場合には、ディレクトリ名を10進数で出力する必要があるためです。
スクリプトなどに組み込む場合にご利用ください。
* --------------------------------------------------------------------
* 変更履歴
* --------------------------------------------------------------------
○ver.1.0 (2008/11/14)
初版