From: j8takagi Date: Tue, 21 Dec 2010 03:12:51 +0000 (+0900) Subject: ドキュメントの更新 X-Git-Tag: 0.2p3~38 X-Git-Url: https://j8takagi.net/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=106990bde86bcc374c0ac9295f854c6a2eda9937;p=autotest_mk.git ドキュメントの更新 --- diff --git a/doc/Makefile b/doc/Makefile index 86e9b4d..0e659b5 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,5 +1,5 @@ DOCNAME = autotest_mk -TEXBIN = /usr/local/texlive/p2009/bin/i386-apple-darwin10.3.0 +TEXBIN = /usr/local/texlive/2010/bin/x86_64-linux/ SRC = $(DOCNAME).texi CSS = style.css PTEX = $(TEXBIN)/ptex @@ -11,10 +11,10 @@ MAKEINFO = makeinfo .INTERMEDIATE: yacasl2.dvi -htmlnosplit: $(DOCNAME).html - all: info htmlnosplit html pdf +htmlnosplit: $(DOCNAME).html + info: $(DOCNAME).info html: $(SRC) $(CSS) diff --git a/doc/autotest_mk.dvi b/doc/autotest_mk.dvi deleted file mode 100644 index 8367390..0000000 Binary files a/doc/autotest_mk.dvi and /dev/null differ diff --git a/doc/autotest_mk.html b/doc/autotest_mk.html deleted file mode 100644 index ab761d6..0000000 --- a/doc/autotest_mk.html +++ /dev/null @@ -1,401 +0,0 @@ - - -autotest_mk - Linux上のCASL II処理系 - - - - - - - - - - -

autotest_mk - Linux上のCASL II処理系

- - -
-

Table of Contents

- -
- -

- -

1 Autotest.mkの概要

- -

Autotest.mkは、GNU Makeを利用したテスト自動化ツールです。何回かmakeコマンドを実行し、プログラムのテスト結果を表す実行ファイルを作成すれば、テストの準備は完了です。あとはmakeコマンドを1回実行すれば、いつでもテストを実行できます。テストの実行結果は、ログに出力されます。 - -

Autotest.mkでは、次の3つの概念を使います。 - -

-
テンプレート
テストグループとテストのテンプレートです。 - -
テストグループ
複数のテストを含むグループです。 - -
テスト
テスト個々の内容と結果を表します。 -
- -

要件

- -

Autotest.mkは、LinuxやMac OS Xなどで動作します。現在動作を確認しているのは、次のディストリビューションです。 - -

- -

Mac OS Xでは、GNU Findutilsをインストールしてください。 - -

- -

2 Autotest.mkのインストール

- -

Autotest.mkをインストールするには、次の作業をします。 - -

    -
  1. Autotest.mkファイルのダウンロード - -
  2. Autotest.mkファイルの検証 - -
  3. Autotest.mkファイルの展開 -
- -

- -

2.1 ダウンロード

- -

GitHub/j8takagi/autotest_mkのダウンロードページから最新版のtgzファイルをダウンロードします。 - -

続けて、対応する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 ファイルの展開

- -

autotest_mkファイルをダウンロードしたら、次のコマンドで展開します。 - -

  $ tar xvzf autotest_mk.tar.gz
-
-

展開したら、Autotest.mkは使える状態です。多くのプログラムをインストールするときに必要なコンパイルやビルド、システムディレクトリーへのインストール（./configureやmake、make install）は必要ありません。 - -

- -

3 Autotest.mkチュートリアル

- -

Autotest.mkを使ったテストの手順は、次のとおりです。 - -

    -
  1. グループディレクトリーの作成 - -
  2. テストディレクトリーの作成 - -
  3. テスト用コマンドファイルの作成 - -
  4. テスト想定結果の作成と検証 - -
  5. テストの実行とログの確認 -
- -

ここでは、簡易電卓プログラムcalcをテストする手順を取り上げます。 - -

- -

3.1 サンプルプログラムの準備

- -

まず、Autotest.mkのパッケージに含まれているsample/calcを任意のフォルダーへコピーします。 - -

  $ cd ~/autotest.mk
-  $ cp ~r ~/sample/calc ~/calc
-
-

- -

3.2 グループディレクトリーの作成

- -

テンプレートディレクトリーで、makeを実行します。このとき、テストグループのディレクトリーを変数GROUPDIRで指定します。 - -

指定したディレクトリーが作成されます。 - -

  $ cd ~/autotest.mk/template
-  $ make GROUPDIR=~/calc/calc_test
-
-

次のコマンドでグループディレクトリーに移動し、その中を確認します。 - -

テストを実行するためのMakefileが作成されます。 - -

  $ cd ~/autotest.mk/template
-  $ make GROUPDIR=~/calc/calc_test
-
-

- -

3.3 テストディレクトリーの作成

- -

- -

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

- -

- -

3.5 テスト想定結果の作成と検証

- -

- -

3.6 テストの実行とログの確認

- -

- -

4 Autotest.mkマニュアル

- -

- -

4.1 テンプレートディレクトリー

- -

テンプレートディレクトリーは、Autotest.mkをインストールするときに展開により作成されたtemplateディレクトリーです。このディレクトリーに移動すると次の操作ができます。 - -

- -

4.1.1 makeまたはmake group グループの作成

- -

変数GROUPDIRで指定されたディレクトリーをテストグループディレクトリーとして作成し、必要な次のファイルをコピーします。 - -

- -

4.1.2 テンプレートのファイル

- -

- -

4.2 グループディレクトリー

- -

- -

4.2.1 make create テストの作成

- -

- -

4.2.2 テスト名の変更

- -

- -

4.2.3 テストの削除

- -

- -

4.2.4 makeまたはmake check グループ内にあるすべてのテストの実行

- -

- -

4.2.5 make checkall グループ内にあるすべてのテストの実行、計時

- -

- -

4.2.6 make clean グループ内にあるすべてのテストで、実行結果をクリア

- -

- -

4.2.7 make time グループ内にあるすべてのテストを計時

- -

- -

4.2.8 make cleantime グループ内にあるすべてのテストで、計時結果をクリア

- -

- -

4.2.9 グループのファイル

- -

- -

4.3 テストディレクトリー

- -

- -

4.3.1 make set テスト想定の作成

- -

- -

4.3.2 make set テスト想定の再作成

- -

- -

4.3.3 makeまたはmake check テストの実行

- -

- -

4.3.4 make time テストの計時

- -

- -

4.3.5 make cleantime テスト計時結果のクリア

- -

- -

4.3.6 make cleantime テスト結果のクリア

- -

- -

4.3.7 make cleanall テストの想定と結果をクリア

- -

- -

4.3.8 テストのファイル

- - - - diff --git a/doc/autotest_mk.info b/doc/autotest_mk.info deleted file mode 100644 index d30907c..0000000 --- a/doc/autotest_mk.info +++ /dev/null @@ -1,428 +0,0 @@ -This is autotest_mk.info, produced by makeinfo version 4.13 from -autotest_mk.texi. - -Copyright (C) 2010 j8takagi - -INFO-DIR-SECTION Basics -START-INFO-DIR-ENTRY -* Autotest.mk: (autotest_mk). -END-INFO-DIR-ENTRY - - -File: autotest_mk.info, Node: Top, Next: About, Prev: (dir), Up: (dir) - -* Menu: - -* About:: -* Install:: -* Tutorial:: -* Manual:: - - --- The Detailed Node Listing --- - -Autotest.mkのインストール - -* Download:: -* Verify:: -* Expand:: - -Autotest.mkチュートリアル - -* Preapre:: -* Create Group:: - - -File: autotest_mk.info, Node: About, Next: Install, Prev: Top, Up: Top - -1 Autotest.mkの概要 -********************** - -Autotest.mkは、GNU -Makeを利用したテスト自動化ツールです。何回か`make'コマンドを実行し、プログラムのテスト結果を表す実行ファイルを作成すれば、テストの準備は完了です。あとは`make'コマンドを1回実行すれば、いつでもテストを実行できます。テストの実行結果は、ログに出力されます。 - - Autotest.mkでは、次の3つの概念を使います。 - -`テンプレート' - テストグループとテストのテンプレートです。 - -`テストグループ' - 複数のテストを含むグループです。 - -`テスト' - テスト個々の内容と結果を表します。 - -要件 -====== - -Autotest.mkは、LinuxやMac OS -Xなどで動作します。現在動作を確認しているのは、次のディストリビューションです。 - - * Ubuntu Linux 10.10 - - * Mac OS X バージョン 10.6.5 - - Mac OS Xでは、GNU Findutils -(http://www.gnu.org/software/findutils/)をインストールしてください。 - - -File: autotest_mk.info, Node: Install, Next: Tutorial, Prev: About, Up: Top - -2 Autotest.mkのインストール -********************************** - -* Menu: - -* Download:: -* Verify:: -* Expand:: - - Autotest.mkをインストールするには、次の作業をします。 - - 1. Autotest.mkファイルのダウンロード - - 2. Autotest.mkファイルの検証 - - 3. Autotest.mkファイルの展開 - - -File: autotest_mk.info, Node: Download, Next: Verify, Prev: Install, Up: Install - -2.1 ダウンロード -====================== - -GitHub/j8takagi/autotest_mk -(http://github.com/j8takagi/autotest_mk)のダウンロードページ -(http://github.com/j8takagi/autotest_mk/downloads)から最新版のtgzファイルをダウンロードします。 - - 続けて、対応する`md5sum'フィルをダウンロードします。 - - -File: autotest_mk.info, Node: Verify, Next: Expand, Prev: Download, Up: Install - -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 - - -File: autotest_mk.info, Node: Expand, Prev: Verify, Up: Install - -2.3 ファイルの展開 -========================= - -`autotest_mk'ファイルをダウンロードしたら、次のコマンドで展開します。 - - $ tar xvzf autotest_mk.tar.gz - - 展開したら、Autotest.mkは使える状態です。多くのプログラムをインストールするときに必要なコンパイルやビルド、システムディレクトリーへのインストール（`./configure'や`make'、`make -install'）は必要ありません。 - - -File: autotest_mk.info, Node: Tutorial, Next: Manual, Prev: Install, Up: Top - -3 Autotest.mkチュートリアル -********************************** - -Autotest.mkを使ったテストの手順は、次のとおりです。 - - 1. グループディレクトリーの作成 - - 2. テストディレクトリーの作成 - - 3. テスト用コマンドファイルの作成 - - 4. テスト想定結果の作成と検証 - - 5. テストの実行とログの確認 - - ここでは、簡易電卓プログラムcalcをテストする手順を取り上げます。 - -* Menu: - -* Preapre:: -* Create Group:: -* Create Test:: -* Edit cmd:: -* Test Set:: -* Test Execute:: - - -File: autotest_mk.info, Node: Preapre, Next: Create Group, Prev: Tutorial, Up: Tutorial - -3.1 サンプルプログラムの準備 -======================================== - -まず、Autotest.mkのパッケージに含まれている`sample/calc'を任意のフォルダーへコピーします。 - - $ cd ~/autotest.mk - $ cp ~r ~/sample/calc ~/calc - - -File: autotest_mk.info, Node: Create Group, Next: Create Test, Prev: Preapre, Up: Tutorial - -3.2 グループディレクトリーの作成 -============================================== - -テンプレートディレクトリーで、`make'を実行します。このとき、テストグループのディレクトリーを変数`GROUPDIR'で指定します。 - - 指定したディレクトリーが作成されます。 - - $ cd ~/autotest.mk/template - $ make GROUPDIR=~/calc/calc_test - - 次のコマンドでグループディレクトリーに移動し、その中を確認します。 - - テストを実行するためのMakefileが作成されます。 - - $ cd ~/autotest.mk/template - $ make GROUPDIR=~/calc/calc_test - - -File: autotest_mk.info, Node: Create Test, Next: Edit cmd, Prev: Create Group, Up: Tutorial - -3.3 テストディレクトリーの作成 -=========================================== - - -File: autotest_mk.info, Node: Edit cmd, Next: Test Set, Prev: Create Test, Up: Tutorial - -3.4 テスト用コマンドファイルの作成 -================================================= - - -File: autotest_mk.info, Node: Test Set, Next: Test Execute, Prev: Edit cmd, Up: Tutorial - -3.5 テスト想定結果の作成と検証 -=========================================== - - -File: autotest_mk.info, Node: Test Execute, Prev: Test Set, Up: Tutorial - -3.6 テストの実行とログの確認 -======================================== - - -File: autotest_mk.info, Node: Manual, Prev: Tutorial, Up: Top - -4 Autotest.mkマニュアル -**************************** - -* Menu: - -* Template Dir:: -* Group Dir:: -* Test Dir:: - - -File: autotest_mk.info, Node: Template Dir, Next: Group Dir, Prev: Manual, Up: Manual - -4.1 テンプレートディレクトリー -=========================================== - -テンプレートディレクトリーは、Autotest.mkをインストールするときに展開により作成された`template'ディレクトリーです。このディレクトリーに移動すると次の操作ができます。 - -* Menu: - -* make group:: -* Template Files:: - - -File: autotest_mk.info, Node: make group, Next: Template Files, Prev: Template Dir, Up: Template Dir - -4.1.1 `make'または`make group' グループの作成 -------------------------------------------------------- - -変数`GROUPDIR'で指定されたディレクトリーをテストグループディレクトリーとして作成し、必要な次のファイルをコピーします。 - - -File: autotest_mk.info, Node: Template Files, Prev: make group, Up: Template Dir - -4.1.2 テンプレートのファイル ---------------------------------------- - - -File: autotest_mk.info, Node: Group Dir, Next: Test Dir, Prev: Template Dir, Up: Manual - -4.2 グループディレクトリー -===================================== - -* Menu: - -* make create:: -* Rename:: -* Delete:: -* make check at group:: -* make checkall:: -* make clean at group:: -* make time at group:: -* make cleantime at group:: -* Group Files:: - - -File: autotest_mk.info, Node: make create, Next: Rename, Prev: Group Dir, Up: Group Dir - -4.2.1 `make create' テストの作成 --------------------------------------- - - -File: autotest_mk.info, Node: Rename, Next: Delete, Prev: make create, Up: Group Dir - -4.2.2 テスト名の変更 ---------------------------- - - -File: autotest_mk.info, Node: Delete, Next: make check at group, Prev: Rename, Up: Group Dir - -4.2.3 テストの削除 ------------------------- - - -File: autotest_mk.info, Node: make check at group, Next: make checkall, Prev: Delete, Up: Group Dir - -4.2.4 `make'または`make check' グループ内にあるすべてのテストの実行 ----------------------------------------------------------------------------------------- - - -File: autotest_mk.info, Node: make checkall, Next: make clean at group, Prev: make check at group, Up: Group Dir - -4.2.5 `make checkall' グループ内にあるすべてのテストの実行、計時 -------------------------------------------------------------------------------------- - - -File: autotest_mk.info, Node: make clean at group, Next: make time at group, Prev: make checkall, Up: Group Dir - -4.2.6 `make clean' グループ内にあるすべてのテストで、実行結果をクリア ----------------------------------------------------------------------------------------------- - - -File: autotest_mk.info, Node: make time at group, Next: make cleantime at group, Prev: make clean at group, Up: Group Dir - -4.2.7 `make time' グループ内にあるすべてのテストを計時 ------------------------------------------------------------------------- - - -File: autotest_mk.info, Node: make cleantime at group, Next: Group Files, Prev: make time at group, Up: Group Dir - -4.2.8 `make cleantime' グループ内にあるすべてのテストで、計時結果をクリア --------------------------------------------------------------------------------------------------- - - -File: autotest_mk.info, Node: Group Files, Prev: make cleantime at group, Up: Group Dir - -4.2.9 グループのファイル ---------------------------------- - - -File: autotest_mk.info, Node: Test Dir, Prev: Group Dir, Up: Manual - -4.3 テストディレクトリー -================================== - -* Menu: - -* make set:: -* make reset:: -* make check at test:: -* make time at test:: -* make cleantime at test:: -* make clean at test:: -* make cleanall at test:: -* Test Files:: - - -File: autotest_mk.info, Node: make set, Next: make reset, Prev: Test Dir, Up: Test Dir - -4.3.1 `make set' テスト想定の作成 ------------------------------------------ - - -File: autotest_mk.info, Node: make reset, Next: make check at test, Prev: make set, Up: Test Dir - -4.3.2 `make set' テスト想定の再作成 --------------------------------------------- - - -File: autotest_mk.info, Node: make check at test, Next: make time at test, Prev: make reset, Up: Test Dir - -4.3.3 `make'または`make check' テストの実行 ----------------------------------------------------- - - -File: autotest_mk.info, Node: make time at test, Next: make cleantime at test, Prev: make check at test, Up: Test Dir - -4.3.4 `make time' テストの計時 ------------------------------------- - - -File: autotest_mk.info, Node: make cleantime at test, Next: make clean at test, Prev: make time at test, Up: Test Dir - -4.3.5 `make cleantime' テスト計時結果のクリア --------------------------------------------------------- - - -File: autotest_mk.info, Node: make clean at test, Next: make cleanall at test, Prev: make cleantime at test, Up: Test Dir - -4.3.6 `make cleantime' テスト結果のクリア --------------------------------------------------- - - -File: autotest_mk.info, Node: make cleanall at test, Next: Test Files, Prev: make clean at test, Up: Test Dir - -4.3.7 `make cleanall' テストの想定と結果をクリア -------------------------------------------------------------- - - -File: autotest_mk.info, Node: Test Files, Prev: make cleanall at test, Up: Test Dir - -4.3.8 テストのファイル ------------------------------- - - - -Tag Table: -Node: Top208 -Node: About512 -Node: Install1677 -Node: Download2082 -Node: Verify2511 -Node: Expand2919 -Node: Tutorial3461 -Node: Preapre4120 -Node: Create Group4476 -Node: Create Test5205 -Node: Edit cmd5393 -Node: Test Set5589 -Node: Test Execute5774 -Node: Manual5936 -Node: Template Dir6117 -Node: make group6582 -Node: Template Files6977 -Node: Group Dir7145 -Node: make create7498 -Node: Rename7672 -Node: Delete7821 -Node: make check at group7972 -Node: make checkall8258 -Node: make clean at group8551 -Node: make time at group8861 -Node: make cleantime at group9137 -Node: Group Files9457 -Node: Test Dir9620 -Node: make set9939 -Node: make reset10118 -Node: make check at test10313 -Node: make time at test10533 -Node: make cleantime at test10733 -Node: make clean at test10973 -Node: make cleanall at test11205 -Node: Test Files11447 - -End Tag Table - - -Local Variables: -coding: utf-8 -End: diff --git a/doc/autotest_mk.pdf b/doc/autotest_mk.pdf deleted file mode 100644 index 1b24f8a..0000000 Binary files a/doc/autotest_mk.pdf and /dev/null differ diff --git a/doc/autotest_mk.texi b/doc/autotest_mk.texi index 6b7afd3..961a0b1 100644 --- a/doc/autotest_mk.texi +++ b/doc/autotest_mk.texi @@ -162,7 +162,12 @@ Autotest.mkを使ったテストの手順は、次のとおりです。 テストの実行とログの確認 @end enumerate -ここでは、簡易電卓プログラムcalcをテストする手順を取り上げます。 +ここでは、次のような三角形判定プログラムをテストする手順を取り上げます。 + +@quotation +プログラムtriangleは3つの引数をとり、それぞれ三角形の3辺の長さをあらわすものとする。プログラムは、三角形が不等辺三角形の場合は`isosceles triangle'、二等辺三角形の場合は`isosceles triangle'、正三角形は`equilateral triangle'を印字する。 +@end quotation + @menu * Preapre:: @@ -180,7 +185,7 @@ Autotest.mkを使ったテストの手順は、次のとおりです。 @example $ @kbd{cd ~/autotest.mk} -$ @kbd{cp ~r ~/sample/calc ~/calc} +$ @kbd{cp -r ~/sample/calc ~/calc} @end example @node Create Group diff --git a/doc/style.css b/doc/style.css index 82ecca8..3201236 100644 --- a/doc/style.css +++ b/doc/style.css @@ -54,6 +54,10 @@ a { text-decoration: none; } +blockquote { + border: 1px solid #00F; +} + blockquote.p { margin-top:0; padding-top:0;