From: j8takagi Date: Wed, 12 Jan 2011 14:44:02 +0000 (+0900) Subject: ドキュメントを更新 X-Git-Tag: 0.2p3~30 X-Git-Url: https://j8takagi.net/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b4985a15a1dfbb0dcb9b52f32496ccb427999e56;p=autotest_mk.git ドキュメントを更新 --- diff --git a/doc/autotest_mk.html b/doc/autotest_mk.html index 86e583e..aed60e5 100644 --- a/doc/autotest_mk.html +++ b/doc/autotest_mk.html @@ -1,8 +1,8 @@ -Autotest_mk - GNU Makeを利用したテスト自動化ツール +Autotest.mk - GNU Makeを利用したテスト自動化ツール - + @@ -109,7 +109,7 @@ dt { }--> -

Autotest_mk - GNU Makeを利用したテスト自動化ツール

+

Autotest.mk - GNU Makeを利用したテスト自動化ツール

@@ -122,13 +122,16 @@ dt {
  • 2 Autotest.mkのインストール
  • 3 Autotest.mkチュートリアル
      -
    • 三角形判定プログラムの準備 -
    • バグを含む三角形判定プログラムの準備 +
    • 準備 +
    • 3.1 グループディレクトリーの作成
    • 3.2 テストディレクトリーの作成
    • 3.3 テスト説明ファイルの作成 @@ -228,8 +231,6 @@ dt {
      1. Autotest.mkファイルのダウンロード -
      2. Autotest.mkファイルの検証 -
      3. Autotest.mkファイルの展開
      @@ -241,20 +242,9 @@ dt {

      続けて、対応するmd5sumファイルをダウンロードします。 -

      +

      -

      2.2 ファイルの検証

      - -

      (準備中) - -

      ダウンロードが完了したら、md5sumとdiffで正しくファイルがダウンロードができているかを検証します。 - -

        $ md5sum autotest_mk.tar.gz | diff -s autotest_mk.tar.gz.md5sum -
-  Files autotest_mk.tar.gz.md5sum and - are identical
-
      -

      - -

      2.3 ファイルの展開

      +

      2.2 ファイルの展開

      autotest_mkファイルをダウンロードしたら、展開先のディレクトリーに移動してから、展開します。 次のコマンドでは、現在ログインしているユーザーのホームディレクトリーに展開します。 @@ -332,7 +322,9 @@ dt {

      -

      三角形判定プログラムの準備

      +

      準備

      + +

      作業用フォルダの作成

      まず、Autotest.mkのパッケージに含まれているsample/triangle以下のファイルを、任意の作業用ディレクトリーにコピーします。ここでは、~/triangle（~は、現在ログインしているユーザーのホームディレクトリー）を作業用ディレクトリーにします。また、autotest.mkは、~に展開されているものとします。 @@ -341,13 +333,15 @@ dt { $ cd autotest.mk/sample/triangle $ cp triangle.c triangle_bug.c Makefile ~/triangle -

      作業用ディレクトリーに移動します。 +

      作業用ディレクトリーに移動し、中のファイルを確認します。 

        $ cd ~/triangle
   $ ls
   Makefile  triangle.c  triangle_bug.c
      -

      三角形判定プログラムをビルドします。 +

      三角形判定プログラムのビルド

      + +

      三角形判定プログラムをビルドします。 

        $ make
   rm -f triangle
@@ -362,7 +356,7 @@ dt {
   $ ./triangle 2 4 4
   isosceles triangle
      -

      バグを含む三角形判定プログラムの準備

      +

      バグを含む三角形判定プログラムのビルド

      バグを含み一部のテストに失敗する三角形判定プログラムをビルドする場合は、次のコマンドを実行します。 @@ -424,7 +418,9 @@ dt {

      3.4 テストコマンドファイルの作成

      テストコマンドファイルcmdは、テストの時に実行されるコマンドをあらわします。 -cmdをテキストエディターを使って次の内容で作成します。 +このコマンドは、標準出力とエラー出力にテストの結果を出力します。 + +

      ここでは、cmdをテキストエディターを使って次の内容で作成します。 

        ../../triangle 3 4 5
      @@ -462,7 +458,7 @@ dt { 
        $ make set
   futohen sankakukei
      -

      また、0.txtがすでに存在する場合はmake setを実行するとエラーになり、0.txtは更新されません。 +

      0.txtがすでに存在する場合はmake setを実行するとエラーになり、0.txtは更新されません。

      3.5.3 make reset

      @@ -924,7 +920,7 @@ dt {
      -

      脚注

      [1] 『ソフトウェア・テストの技法』では「カードから3つの整数を読む」となっているのを、「3つの引数をとる」に変更しています。

      +

      Footnotes

      [1] 『ソフトウェア・テストの技法』では「カードから3つの整数を読む」となっているのを、「3つの引数をとる」に変更しています。

      [2] 『ソフトウェア・テストの技法』では下記の13個に加え、「それぞれのテスト・ケースについて、入力の値に対して予想される値をしめしたか」というテスト・ケースが記載されています。このテスト・ケースは、Autotest.mkを実行している場合は自動的に満たされると考えています。

      diff --git a/doc/autotest_mk.texi b/doc/autotest_mk.texi index 60d9005..1ab4592 100644 --- a/doc/autotest_mk.texi +++ b/doc/autotest_mk.texi @@ -5,7 +5,7 @@ Check Log\input texinfo @c -*-texinfo-*- @end ifnottex @setfilename autotest_mk.info @documentencoding UTF-8 -@settitle Autotest_mk - GNU Makeを利用したテスト自動化ツール +@settitle Autotest.mk - GNU Makeを利用したテスト自動化ツール @firstparagraphindent none @paragraphindent 1 @c %**end of header @@ -33,10 +33,10 @@ Copyright @copyright{} 2010 j8takagi @end ifnottex @menu -* About:: -* Install:: -* Tutorial:: -* Manual:: +* Autotest.mkの概要: About. +* Autotest.mkのインストール: Install. +* Autotest.mkチュートリアル: Tutorial. +* Autotest.mkマニュアル: Manual. @detailmenu --- The Detailed Node Listing --- @@ -44,7 +44,6 @@ Copyright @copyright{} 2010 j8takagi Autotest.mkのインストール * Download:: -* Verify:: * Expand:: Autotest.mkチュートリアル @@ -56,7 +55,9 @@ Autotest.mkチュートリアル * Edit cmd:: * Test Setting:: * Test Execute:: +* Check Test Log:: * Group Execute:: +* Check Group Log:: Autotest.mkマニュアル @@ -134,7 +135,6 @@ Mac OS Xでは、@uref{http://www.gnu.org/software/findutils/, GNU Findutils}を @menu * Download:: -* Verify:: * Expand:: @end menu @@ -145,32 +145,18 @@ Autotest.mkをインストールするには、次の作業をします。 @item Autotest.mkファイルのダウンロード -@item -Autotest.mkファイルの検証 - @item Autotest.mkファイルの展開 @end enumerate -@node Download, Verify, Install, Install +@node Download, Expand, Install, Install @section ダウンロード @uref{https://github.com/j8takagi/Autotest.mk/, GitHub/j8takagi/Autotest.mk}の@uref{https://github.com/j8takagi/Autotest.mk/downloads, ダウンロードページ}から最新版の@file{tar.gz}ファイルをダウンロードします。 続けて、対応する@file{md5sum}ファイルをダウンロードします。 -@node Verify, Expand, Download, Install -@section ファイルの検証 -(準備中) - -ダウンロードが完了したら、@kbd{md5sum}と@kbd{diff}で正しくファイルがダウンロードができているかを検証します。 - -@example -$ @kbd{md5sum autotest_mk.tar.gz | diff -s autotest_mk.tar.gz.md5sum -} -Files autotest_mk.tar.gz.md5sum and - are identical -@end example - -@node Expand, , Verify, Install +@node Expand, , Download, Install @section ファイルの展開 @file{autotest_mk}ファイルをダウンロードしたら、展開先のディレクトリーに移動してから、展開します。 @@ -284,7 +270,9 @@ Autotest.mkを使ったテストの手順は、次のとおりです。 @end menu @node Prepare, Create Group, Tutorial, Tutorial -@unnumberedsec 三角形判定プログラムの準備 +@unnumberedsec 準備 + +@unnumberedsubsec 作業用フォルダの作成 まず、Autotest.mkのパッケージに含まれている@file{sample/triangle}以下のファイルを、任意の作業用ディレクトリーにコピーします。ここでは、@file{~/triangle}（@file{~}は、現在ログインしているユーザーのホームディレクトリー）を作業用ディレクトリーにします。また、@file{autotest.mk}は、@file{~}に展開されているものとします。 @@ -295,7 +283,7 @@ $ @kbd{cd autotest.mk/sample/triangle} $ @kbd{cp triangle.c triangle_bug.c Makefile ~/triangle} @end example -作業用ディレクトリーに移動します。 +作業用ディレクトリーに移動し、中のファイルを確認します。 @example $ @kbd{cd ~/triangle} @@ -303,6 +291,8 @@ $ @kbd{ls} Makefile triangle.c triangle_bug.c @end example +@unnumberedsubsec 三角形判定プログラムのビルド + 三角形判定プログラムをビルドします。 @example @@ -322,7 +312,7 @@ $ @kbd{./triangle 2 4 4} isosceles triangle @end example -@unnumberedsec バグを含む三角形判定プログラムの準備 +@unnumberedsubsec バグを含む三角形判定プログラムのビルド バグを含み一部のテストに失敗する三角形判定プログラムをビルドする場合は、次のコマンドを実行します。 @@ -393,7 +383,9 @@ Makefile @section テストコマンドファイルの作成 テストコマンドファイル@file{cmd}は、テストの時に実行されるコマンドをあらわします。 -@file{cmd}をテキストエディターを使って次の内容で作成します。 +このコマンドは、標準出力とエラー出力にテストの結果を出力します。 + +ここでは、@file{cmd}をテキストエディターを使って次の内容で作成します。 @example @kbd{../../triangle 3 4 5} @@ -439,7 +431,7 @@ $ @kbd{make set} futohen sankakukei @end example -また、@file{0.txt}がすでに存在する場合は@kbd{make set}を実行するとエラーになり、@file{0.txt}は更新されません。 +@file{0.txt}がすでに存在する場合は@kbd{make set}を実行するとエラーになり、@file{0.txt}は更新されません。 @subsection @kbd{make reset} @file{0.txt}がすでに存在する場合は、@kbd{make reset}で更新できます。 @@ -675,7 +667,7 @@ test: All tests are succeded. test: 11 / 13 tests passed. Detail in /home/foo/triangle/test/TEST.log @end example -@node Check Group Log, , Group Execute, Tutorial +@node Check Group Log, , Group Execute, Tutorial @section テストグループログファイルの確認 テストグループを実行すると作成されるファイルは、次のとおりです。