Menu
▾
▴
[cutter-commit 02779] SF.net SVN: cutter:[2785] cutter/trunk
|
From: <kt...@us...> - 2009-03-21 05:39:09
|
Revision: 2785
http://cutter.svn.sourceforge.net/cutter/?rev=2785&view=rev
Author: ktou
Date: 2009-03-21 05:39:00 +0000 (Sat, 21 Mar 2009)
Log Message:
-----------
* README*: move cutter command documents to ...
* doc/cutter.rd*: ... here.
* doc/Makefile.am: generate man from RD.
Modified Paths:
--------------
cutter/trunk/ChangeLog
cutter/trunk/README
cutter/trunk/README.ja
cutter/trunk/doc/Makefile.am
Added Paths:
-----------
cutter/trunk/doc/cutter.rd
cutter/trunk/doc/cutter.rd.ja
Property Changed:
----------------
cutter/trunk/doc/
Modified: cutter/trunk/ChangeLog
===================================================================
--- cutter/trunk/ChangeLog 2009-03-21 05:06:16 UTC (rev 2784)
+++ cutter/trunk/ChangeLog 2009-03-21 05:39:00 UTC (rev 2785)
@@ -1,5 +1,10 @@
2009-03-21 Kouhei Sutou <ko...@co...>
+ * README*: move cutter command documents to ...
+ * doc/cutter.rd*: ... here.
+
+ * doc/Makefile.am: generate man from RD.
+
* cutter/cut-stream-factory-builder.c, test/cutter/test-cutter.c:
re-enable --stream-log-directory but it's obsoleted.
Modified: cutter/trunk/README
===================================================================
--- cutter/trunk/README 2009-03-21 05:06:16 UTC (rev 2784)
+++ cutter/trunk/README 2009-03-21 05:39:00 UTC (rev 2785)
@@ -32,8 +32,10 @@
== Get
-((<URL:http://sourceforge.net/project/showfiles.php?group_id=208375>))
+tar.gz:
+ % wget http://downloads.sourceforge.net/cutter/cutter-1.0.6.tar.gz
+Subversion:
% svn co https://cutter.svn.sourceforge.net/svnroot/cutter/cutter/trunk cutter
== Install
@@ -44,87 +46,13 @@
== Usage
- % cutter [Options] [Directory which has test_*.so]
+ % cutter [OPTION ...] TEST_DIRECTORY
-Note: test_*.so are searched recursively.
+TEST_DIRECTORY should have test_*.so. test_*.so are searched
+recursively.
-=== Options
+See ((<cutter|"doc/cutter.rd">)) for more details.
-: --version
-
- Cutter shows its own version and exits.
-
-: -s DIRECTORY, --source-directory=DIRECTORY
-
- Cutter prepends DIRECTORY to file name when test fails. This
- is for tolls (like Emacs) which have function jumping to
- error line.
-
-: -t TEST_CASE_NAME, --test-case=TEST_CASE_NAME
-
- Cutter runs test cases that are matched with
- TEST_CASE_NAME. If TEST_CASE_NAME is surrounded by "/"
- (e.g. /test_/), TEST_CASE_NAME is handled as regular
- expression.
-
- This option can be specified n times. In the case, Cutter
- runs test cases that are matched with any
- TEST_CASE_NAME. (OR)
-
-: -n TEST_NAME, --name=TEST_NAME
-
- Cutter runs tests that are matched with TEST_NAME. If
- TEST_NAME is surrounded by "/" (e.g. /test_/), TEST_NAME
- is handled as regular expression.
-
- This option can be specified n times. In the case, Cutter
- runs test that are matched with any TEST_NAME. (OR)
-
-: -m, --multi-thread
-
- Cutter runs a test case in a new thread.
-
-: --test-case-order=[none|name|name-desc]
-
- It specifies test case order. Cutter doesn't sort by
- default. (none)
-
- If 'name' is specified, Cutter sorts test cases by name in
- ascending order. If 'name-desc' is specified, Cutter
- sorts test cases by name in descending order.
-
-: -u[console|gtk], --ui=[console|gtk]
-
- It specifies UI. The default is console UI.
-
-: -v[s|silent|n|normal|v|verbose], --verbose=[s|silent|n|normal|v|verbose]
-
- It specifies verbose level.
-
- This option is only for console UI.
-
-: -c[yes|true|no|false|auto], --color=[yes|true|no|false|auto]
-
- If 'yes' or 'true' is specified, Cutter uses colorized
- output by escape sequence. If 'no' or 'false' is
- specified, Cutter never use colorized output. If 'auto'
- or the option is omitted, Cutter uses colorized output if
- available.
-
- This option is only for console UI.
-
-: --xml-report=FILE
-
- Cutter outputs a test report to FILE as XML format.
-
-: -?, --help
-
- Cutter shows common options.
-
-: --help-all
-
- Cutter shows all options.
-
== How to test
Executing flow of test is the following.
Modified: cutter/trunk/README.ja
===================================================================
--- cutter/trunk/README.ja 2009-03-21 05:06:16 UTC (rev 2784)
+++ cutter/trunk/README.ja 2009-03-21 05:39:00 UTC (rev 2785)
@@ -62,84 +62,14 @@
== 使い方
- % cutter [オプション] [test_*.soがあるディレクトリ]
+ % cutter [オプション ...] テストディレクトリ
-注: test_*.soはディレクトリを再帰的にたどって検索されます。
+テストディレクトリにはtest_*.soがあるディレクトリを指定しま
+す。cutterはテストディレクトリ以下にあるtest_*.soを再帰的に
+検索します。
-=== オプション
+詳細は((<cutter|"doc/cutter.rd.ja">))を見てください。
-: --version
-
- バージョンを表示して終了します。
-
-: -s DIRECTORY, --source-directory=DIRECTORY
-
- テストが失敗した場合にファイル名の前にDIRECTORYを付加しま
- す。Cutterの出力からテストが失敗した箇所にジャンプするツー
- ル（Emacsなど）と連携するための機能です。
-
-: -t TEST_CASE_NAME, --test-case=TEST_CASE_NAME
-
- TEST_CASE_NAMEにマッチしたテストケースを実行します。もし、
- TEST_CASE_NAMEが"/"で囲まれていた場合は（例: /test_/）正
- 規表現として扱います。
-
- このオプションは複数回指定できます。その場合は、どれかの
- TEST_CASE_NAMEにマッチしたテストケースを実行します。（OR）
-
-: -n TEST_NAME, --name=TEST_NAME
-
- TEST_NAMEにマッチしたテストを実行します。もし、TEST_NAME
- が"/"で囲まれていた場合は（例: /test_/）正規表現として扱
- います。
-
- このオプションは複数回指定できます。その場合は、どれかの
- TEST_NAMEにマッチしたテストケースを実行します。（OR）
-
-: -m, --multi-thread
-
- 各テストケースを新しいスレッドで実行します。
-
-: --test-case-order=[none|name|name-desc]
-
- 各テストケースの実行順を並び替えます。デフォルトでは並び
- 替えません。（none）
-
- nameを指定するとテストケース名で昇順に並び替えます。
- name-descを指定するとテストケース名で降順に並び替えます。
-
-: -u=[console|gtk], --ui=[console|gtk]
-
- UIを指定します。デフォルトはコンソールUIです。
-
-: -v[s|silent|n|normal|v|verbose], --verbose=[s|silent|n|normal|v|verbose]
-
- 出力の詳細さを指定します。
-
- このオプションはコンソールUIを使用する場合だけ有効です。
-
-: -c[yes|true|no|false|auto], --color=[yes|true|no|false|auto]
-
- yesまたはtrueが指定された場合はCutterはエスケープシーケン
- スで色付けして出力します。noまたはfalseが指定された場合は
- 色付けしません。autoあるいは値が省略された時は、可能なら
- 色付けをします。
-
- このオプションはコンソールUIを使用する場合だけ有効です。
-
-: --xml-report=FILE
-
- FILEにXML形式でテスト結果を出力します。
-
-: -?, --help
-
- UIやテスト結果レポート機能に依存しないオプションを表示し
- ます。
-
-: --help-all
-
- すべてのオプションを表示します。
-
== テストの仕方
テストの実行は以下のような流れになります．
Property changes on: cutter/trunk/doc
___________________________________________________________________
Modified: svn:ignore
- Makefile
Makefile.in
+ Makefile
Makefile.in
*.man
*.jman
Modified: cutter/trunk/doc/Makefile.am
===================================================================
--- cutter/trunk/doc/Makefile.am 2009-03-21 05:06:16 UTC (rev 2784)
+++ cutter/trunk/doc/Makefile.am 2009-03-21 05:39:00 UTC (rev 2785)
@@ -1,23 +1,28 @@
-## -*- Mode: Makefile; tab-width: 8; indent-tabs-mode: t; -*-
+SUBDIRS = reference
-## Makefile.am -- Process this file with automake to produce Makefile.in
-## Copyright (C) 2005 Takuro Ashie <as...@ho...>
-##
-## This library is free software; you can redistribute it and/or
-## modify it under the terms of the GNU Lesser General Public
-## License as published by the Free Software Foundation; either
-## version 2 of the License, or (at your option) any later version.
-##
-## This library is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-## GNU Lesser General Public License for more details.
-##
-## You should have received a copy of the GNU Lesser General Public
-## License along with this program; if not, write to the
-## Free Software Foundation, Inc., 59 Temple Place, Suite 330,
-## Boston, MA 02111-1307 USA
+EXTRA_DIST =
-MAINTAINERCLEANFILE = Makefile.in
+dist_man1_MANS = \
+ cutter.man
-SUBDIRS = reference
+ja_man1dir = $(mandir)/ja/man1
+
+#dist_ja_man1_DATA = \
+# man in Japanese is not installed. Should they be installed? But how?
+dist_ja_man1_mans = \
+ cutter.jman
+
+EXTRA_DIST += $(dist_ja_man1_mans)
+
+# durty...
+cutter.jman: cutter.rd.ja
+
+MAINTAINERCLEANFILES = $(dist_man1_MANS) $(dist_ja_man1_mans)
+
+SUFFIXES: .rd .man .jman
+
+.rd.man:
+ rd2 -r$(top_srcdir)/misc/rd2man-lib $< > $@
+
+.rd.jman: # durty...
+ rd2 -r$(top_srcdir)/misc/rd2man-lib $<.ja > $@
Added: cutter/trunk/doc/cutter.rd
===================================================================
--- cutter/trunk/doc/cutter.rd (rev 0)
+++ cutter/trunk/doc/cutter.rd 2009-03-21 05:39:00 UTC (rev 2785)
@@ -0,0 +1,224 @@
+= cutter / Cutter / Cutter's manual
+
+== NAME
+
+cutter - xUnit family unit testing framework for C
+
+== SYNOPSIS
+
+(({cutter})) [((*option ...*))] ((*test-directory*))
+
+(({cutter})) --mode=analyze [((*option ...*))] ((*log-directory*))
+
+== DESCRIPTION
+
+Cutter is a xUnit family unit testing framework for
+C. Cutter provides programmers two important interfaces:
+
+ (1) easy to write API
+ (2) easy to debug UI
+
+Cutter helps programmers to write their new tests, run their
+existing tests, get feedbacks from ran their
+tests.
+
+((*test-directory*)) is a directory which has test_*.so.
+test_*.so are searched recursively.
+
+((*log-directory*)) is a directory which has Cutter log
+files. Cutter logs test results when --stream-directory
+option is specified.
+
+== Options
+
+: --version
+
+ Cutter shows its own version and exits.
+
+: --mode=[test|analyze]
+
+ It specifies run mode. Cutter runs tests when run mode is
+ test. Cutter analyzes test results when run mode is
+ analyze.
+
+ The default is test.
+
+: -s DIRECTORY, --source-directory=DIRECTORY
+
+ Cutter prepends DIRECTORY to file name when test fails. This
+ is for tolls (like Emacs) which have function jumping to
+ error line.
+
+: -t TEST_CASE_NAME, --test-case=TEST_CASE_NAME
+
+ Cutter runs test cases that are matched with
+ TEST_CASE_NAME. If TEST_CASE_NAME is surrounded by "/"
+ (e.g. /test_/), TEST_CASE_NAME is handled as regular
+ expression.
+
+ This option can be specified n times. In the case, Cutter
+ runs test cases that are matched with any
+ TEST_CASE_NAME. (OR)
+
+: -n TEST_NAME, --name=TEST_NAME
+
+ Cutter runs tests that are matched with TEST_NAME. If
+ TEST_NAME is surrounded by "/" (e.g. /test_/), TEST_NAME
+ is handled as regular expression.
+
+ This option can be specified n times. In the case, Cutter
+ runs test that are matched with any TEST_NAME. (OR)
+
+: -m, --multi-thread
+
+ Cutter runs a test case in a new thread.
+
+ The default is off.
+
+: --max-threads=MAX_THREADS
+
+ Run test cases and iterated tests with MAX_THREADS
+ threads concurrently at a maximum. -1 means no limit.
+
+ The default is 10.
+
+: --test-case-order=[none|name|name-desc]
+
+ It specifies test case order.
+
+ If 'none' is specified, Cutter doesn't sort. If 'name' is
+ specified, Cutter sorts test cases by name in
+ ascending order. If 'name-desc' is specified, Cutter
+ sorts test cases by name in descending order.
+
+ The default is none.
+
+: --exclude-file=FILE
+
+ Cutter doesn't read FILE on test collecting.
+
+: --exclude-directory=DIRECTORY
+
+ Cutter doesn't search tests under DIRECTORY.
+
+: --fatal-failures
+
+ Cutter treats failures as fatal problem. It means that
+ Cutter stops test run.
+
+ The default is off.
+
+: --keep-opening-modules
+
+ Cutter keeps opening loaded modules to resolve symbols
+ for debugging.
+
+ The default is off.
+
+: --enable-convenience-attribute-definition
+
+ It enables convenience but danger
+ '#{ATTRIBUTE_NAME}_#{TEST_NAME - 'test_' PREFIX}'
+ attribute set function.
+
+ The default is off.
+
+: -u[console|gtk], --ui=[console|gtk]
+
+ It specifies UI.
+
+ The default is console UI.
+
+: -v[s|silent|n|normal|v|verbose], --verbose=[s|silent|n|normal|v|verbose]
+
+ It specifies verbose level.
+
+ This option is only for console UI.
+
+: -c[yes|true|no|false|auto], --color=[yes|true|no|false|auto]
+
+ If 'yes' or 'true' is specified, Cutter uses colorized
+ output by escape sequence. If 'no' or 'false' is
+ specified, Cutter never use colorized output. If 'auto'
+ or the option is omitted, Cutter uses colorized output if
+ available.
+
+ This option is only for console UI.
+
+: --pdf-report=FILE
+
+ Cutter outputs a test report to FILE as PDF format.
+
+: --xml-report=FILE
+
+ Cutter outputs a test report to FILE as XML format.
+
+: --stream=[xml]
+
+ It specifies stream backend. Stream backend streams
+ test results.
+
+ There is only XML stream backend for now.
+
+: --stream-fd=FILE_DESCRIPTOR
+
+ It specifies output file descriptor. The XML stream
+ backend streams to FILE_DESCRIPTOR.
+
+ This option is only for XML stream backend.
+
+: --stream-directory=DIRECTORY
+
+ It specifies output directory. The XML stream backend
+ streams to a file under DIRECTORY.
+
+ This option is only for XML stream backend.
+
+: -?, --help
+
+ Cutter shows common options.
+
+: --help-stream
+
+ Cutter shows stream related options.
+
+: --help-report
+
+ Cutter shows report related options.
+
+: --help-ui
+
+ Cutter shows UI related options.
+
+: --help-all
+
+ Cutter shows all options.
+
+== EXIT STATUS
+
+The exit status is 0 if all tests are passed and non-0
+otherwise. Omission test result and notification test
+result are not treated as failure.
+
+== FILES
+
+: /usr/local/share/doc/cutter/
+
+ The directory has Cutter documents. e.g. reference
+ manual, tutorial and so on.
+
+== EXAMPLE
+
+In the following example, cutter runs tests under tests/
+directory and shows test progress verbosely.
+
+ % cutter -v v test/
+
+In the following example, test results are saved under logs/
+directory:
+
+ % cutter --stream=xml --stream-directory=logs/ test/
+
+== SEE ALSO
+
+GLib's reference manual.
Added: cutter/trunk/doc/cutter.rd.ja
===================================================================
--- cutter/trunk/doc/cutter.rd.ja (rev 0)
+++ cutter/trunk/doc/cutter.rd.ja 2009-03-21 05:39:00 UTC (rev 2785)
@@ -0,0 +1,223 @@
+= cutter / Cutter / Cutterのマニュアル
+
+== 名前
+
+cutter - C言語用のxUnit系テスティングフレームワーク
+
+== 書式
+
+(({cutter})) [((*オプション...*))] ((*テストディレクトリ*))
+
+(({cutter})) --mode=analyze [((*オプション ...*))] ((*ログディレクトリ*))
+
+== 説明
+
+CutterはC言語用のxUnit系単体テスト（ユニットテスト）フレーム
+ワークです。Cutterはプログラマに2つの重要なインターフェイス
+を提供します。
+
+ (1) 簡単にテストが書けるAPI
+ (2) 簡単にデバッグできるユーザインターフェイス
+
+Cutterはプログラマが新しいテストを書くこと、すでにあるテスト
+を実行すること、実行したテストからフィードバックを得ることを
+支援します。
+
+((*テストディレクトリ*))にはtest_*.soがあるディレクトリを指
+定します。Cutterはtest_*.soは再帰的に検索します。
+
+((*ログディレクトリ*))にはCutterのログファイルがあるディレク
+トリを指定します。Cutterは--stream-directoryオプションがして
+いされるとテスト結果をログファイルに出力します。
+
+== オプション
+
+: --version
+
+ バージョンを表示して終了します。
+
+: --mode=[test|analyze]
+
+ 実行モードを指定します。testモードのときはテストを実行し
+ ます。analyzeモードのときはテスト結果を解析します。
+
+ デフォルトはtestです。
+
+: -s DIRECTORY, --source-directory=DIRECTORY
+
+ テストが失敗した場合にファイル名の前にDIRECTORYを付加しま
+ す。Cutterの出力からテストが失敗した箇所にジャンプするツー
+ ル（Emacsなど）と連携するための機能です。
+
+: -t TEST_CASE_NAME, --test-case=TEST_CASE_NAME
+
+ TEST_CASE_NAMEにマッチしたテストケースを実行します。もし、
+ TEST_CASE_NAMEが"/"で囲まれていた場合は（例: /test_/）正
+ 規表現として扱います。
+
+ このオプションは複数回指定できます。その場合は、どれかの
+ TEST_CASE_NAMEにマッチしたテストケースを実行します。（OR）
+
+: -n TEST_NAME, --name=TEST_NAME
+
+ TEST_NAMEにマッチしたテストを実行します。もし、TEST_NAME
+ が"/"で囲まれていた場合は（例: /test_/）正規表現として扱
+ います。
+
+ このオプションは複数回指定できます。その場合は、どれかの
+ TEST_NAMEにマッチしたテストケースを実行します。（OR）
+
+: -m, --multi-thread
+
+ 各テストケースを新しいスレッドで実行します。
+
+ デフォルトでは無効です。
+
+: --max-threads=MAX_THREADS
+
+ 最大MAX_THREADSスレッドを同時に動かしてテストケースと繰り
+ 返しテストを実行します。-1を指定すると最大同時スレッド数
+ を制限しません。
+
+ デフォルトは最大10スレッドです。
+
+: --test-case-order=[none|name|name-desc]
+
+ 各テストケースの実行順を並び替えます。
+
+ noneを指定すると並び替えません。nameを指定するとテストケー
+ ス名で昇順に並び替えます。name-descを指定するとテストケー
+ ス名で降順に並び替えます。
+
+ デフォルトはnoneです。
+
+: --exclude-file=FILE
+
+ テストを集めるときにFILEを読み込みません。
+
+: --exclude-directory=DIRECTORY
+
+ DIRECTORY以下にあるテストを検索しません。
+
+: --fatal-failures
+
+ 失敗を致命的な問題として扱います。つまり、表明に失敗する
+ とテストの実行を中断します。
+
+ デフォルトでは無効です。
+
+: --keep-opening-modules
+
+ ロードしたモジュールを開いたままにします。シンボルを解決
+ できるようになるため、デバッグ時に便利です。
+
+ デフォルトでは無効です。
+
+: --enable-convenience-attribute-definition
+
+ 便利ですが、危険でもある、
+ '#{属性名}_#{テスト名 - 'test_'プリフィックス}'属性設定関
+ 数を有効にします。
+
+ デフォルトでは無効です。
+
+: -u=[console|gtk], --ui=[console|gtk]
+
+ UIを指定します。
+
+ デフォルトはコンソールUIです。
+
+: -v[s|silent|n|normal|v|verbose], --verbose=[s|silent|n|normal|v|verbose]
+
+ 出力の詳細さを指定します。
+
+ このオプションはコンソールUIを使用する場合だけ有効です。
+
+: -c[yes|true|no|false|auto], --color=[yes|true|no|false|auto]
+
+ yesまたはtrueが指定された場合はCutterはエスケープシーケン
+ スで色付けして出力します。noまたはfalseが指定された場合は
+ 色付けしません。autoあるいは値が省略された時は、可能なら
+ 色付けをします。
+
+ このオプションはコンソールUIを使用する場合だけ有効です。
+
+: --pdf-report=FILE
+
+ FILEにPDF形式でテスト結果を出力します。
+
+: --xml-report=FILE
+
+ FILEにXML形式でテスト結果を出力します。
+
+: --stream=[xml]
+
+ ストリームバックエンドを指定します。ストリームバックエン
+ ドはテスト結果を配信します。
+
+ 現在はXMLストリームバックエンドがあります。
+
+: --stream-fd=FILE_DESCRIPTOR
+
+ 出力ファイルディスクリプタを指定します。XMLストリームバッ
+ クエンドはFILE_DESCRIPTORに配信します。
+
+ このオプションはXMLストリームバックエンドを使用する場合だ
+ け有効です。
+
+: --stream-directory=DIRECTORY
+
+ 出力ディレクトリを指定します。XMLストリームバックエンドは
+ DIRECTORY以下にファイルを作成し、そのファイルに配信します。
+
+ このオプションはXMLストリームバックエンドを使用する場合だ
+ け有効です。
+
+: -?, --help
+
+ UIやテスト結果レポート機能に依存しないオプションを表示し
+ ます。
+
+: --help-stream
+
+ ストリーム関連のオプションを表示します。
+
+: --help-report
+
+ レポート関連のオプションを表示します。
+
+: --help-ui
+
+ UI関連のオプションを表示します。
+
+: --help-all
+
+ すべてのオプションを表示します。
+
+== 終了ステータス
+
+すべてのテストがパスすると0で、そうでない場合は0以外になりま
+す。テスト結果の「省略」と「通知」は失敗として扱いません。
+
+== ファイル
+
+: /usr/local/share/doc/cutter/ja/
+
+ リファレンスマニュアルやチュートリアルなどのCutterのドキュ
+ メントがあります。
+
+== 例
+
+以下の例では、cutterはtest/ディレクトリ以下のテストを実行し、
+テストの進行状況を詳細に表示します。
+
+ % cutter -v v test/
+
+以下の例では、テスト結果がlogs/ディレクトリ以下に保存されま
+す。
+
+ % cutter --stream=xml --stream-directory=logs/ test/
+
+== 関連項目
+
+GLibのリファレンスマニュアル。
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|