From: Mathias Lafeldt <misfire@debugon.org>
To: Git Mailing List <git@vger.kernel.org>
Subject: [PATCH] t/README: unify documentation of test function args
Date: Sun, 24 Apr 2011 12:52:59 +0200 [thread overview]
Message-ID: <4DB4010B.6080804@debugon.org> (raw)
Document all test function arguments in the same way.
While at it, correct some grammatical errors.
Signed-off-by: Mathias Lafeldt <misfire@debugon.org>
---
t/README | 26 +++++++++++++-------------
1 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/t/README b/t/README
index 428ee05..e8372d7 100644
--- a/t/README
+++ b/t/README
@@ -379,7 +379,7 @@ library for your script to use.
- test_expect_success [<prereq>] <message> <script>
- Usually takes two strings as parameter, and evaluates the
+ Usually takes two strings as parameters, and evaluates the
<script>. If it yields success, test is considered
successful. <message> should state what it is testing.
@@ -389,7 +389,7 @@ library for your script to use.
'git-write-tree should be able to write an empty tree.' \
'tree=$(git-write-tree)'
- If you supply three parameters the first will be taken to be a
+ If you supply three parameters, the first will be taken to be a
prerequisite, see the test_set_prereq and test_have_prereq
documentation below:
@@ -446,7 +446,7 @@ library for your script to use.
Merges the given rev using the given message. Like test_commit,
creates a tag and calls test_tick before committing.
- - test_set_prereq SOME_PREREQ
+ - test_set_prereq <prereq>
Set a test prerequisite to be used later with test_have_prereq. The
test-lib will set some prerequisites for you, see the
@@ -456,7 +456,7 @@ library for your script to use.
test_have_prereq directly, or the three argument invocation of
test_expect_success and test_expect_failure.
- - test_have_prereq SOME PREREQ
+ - test_have_prereq <prereq>
Check if we have a prerequisite previously set with
test_set_prereq. The most common use of this directly is to skip
@@ -503,18 +503,18 @@ library for your script to use.
test_expect_code 1 git merge "merge msg" B master
'
- - test_must_fail <git-command>
+ - test_must_fail <command>
- Run a git command and ensure it fails in a controlled way. Use
- this instead of "! <git-command>". When git-command dies due to a
- segfault, test_must_fail diagnoses it as an error; "! <git-command>"
- treats it as just another expected failure, which would let such a
- bug go unnoticed.
+ Run a command and ensure it fails in a controlled way. Use this
+ instead of "! <command>". When the command dies due to a segfault,
+ test_must_fail diagnoses it as an error; "! <command>" treats it as
+ just another expected failure, which would let such a bug go
+ unnoticed.
- - test_might_fail <git-command>
+ - test_might_fail <command>
Similar to test_must_fail, but tolerate success, too. Use this
- instead of "<git-command> || :" to catch failures due to segv.
+ instead of "<command> || :" to catch failures due to segfault.
- test_cmp <expected> <actual>
@@ -530,7 +530,7 @@ library for your script to use.
test_path_is_dir <dir> [<diagnosis>]
test_path_is_missing <path> [<diagnosis>]
- Check whether a file/directory exists or doesn't. <diagnosis> will
+ Check whether a file/directory exists or not. <diagnosis> will
be displayed if the test fails.
- test_when_finished <script>
--
1.7.5.rc3
next reply other threads:[~2011-04-24 10:53 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-04-24 10:52 Mathias Lafeldt [this message]
2011-04-25 16:07 ` [PATCH] t/README: unify documentation of test function args Junio C Hamano
2011-04-25 18:30 ` Mathias Lafeldt
2011-04-25 19:31 ` Junio C Hamano
2011-04-26 10:33 ` [PATCH v2] " Mathias Lafeldt
2011-04-26 17:30 ` Drew Northup
2011-04-27 4:44 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4DB4010B.6080804@debugon.org \
--to=misfire@debugon.org \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.