{"thread":{"id":"45471","subject":"[PATCH 1/3] t/README: link to metacpan.org, not search.cpan.org","startedAt":"2017-03-22T22:19:12Z","lastAt":"2017-03-24T00:59:48Z","messageCount":5,"participants":["Ævar Arnfjörð Bjarmason","Junio C Hamano","Jonathan Nieder"],"isPatch":true,"patchVersion":1,"patchTotal":3},"messages":[{"id":"314998","messageId":"20170322221854.10791-1-avarab@gmail.com","threadId":"45471","inReplyTo":null,"subject":"[PATCH 1/3] t/README: link to metacpan.org, not search.cpan.org","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2017-03-22T22:18:52Z","receivedAt":"2017-03-22T22:19:12Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"Change a link to the web version of the TAP::Parser::Grammar\ndocumentation to link to metacpan.org instead of search.cpan.org.\n\nThis is something I added back in commit 20873f45e7 (\"t/README:\nDocument the do's and don'ts of tests\", 2010-07-02), at the time\nsearch.cpan.org was the more actively maintained CPAN web-interface,\nnowadays that's metacpan.org.\n\nSigned-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>\n---\n t/README | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/t/README b/t/README\nindex 4982d1c521..a50290c789 100644\n--- a/t/README\n+++ b/t/README\n@@ -471,7 +471,7 @@ Don't:\n    their output.\n \n    You can glean some further possible issues from the TAP grammar\n-   (see http://search.cpan.org/perldoc?TAP::Parser::Grammar#TAP_Grammar)\n+   (see https://metacpan.org/pod/TAP::Parser::Grammar#TAP-GRAMMAR)\n    but the best indication is to just run the tests with prove(1),\n    it'll complain if anything is amiss.\n \n-- \n2.11.0\n\n"},{"id":"314999","messageId":"20170322221854.10791-3-avarab@gmail.com","threadId":"45471","inReplyTo":"20170322221854.10791-1-avarab@gmail.com","subject":"[PATCH 3/3] t/README: clarify the test_have_prereq documentation","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2017-03-22T22:18:54Z","receivedAt":"2017-03-22T22:19:17Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"Clarify the test_have_prereq documentation so that it's clear in the\nreader's mind when the text says \"most common use of this directly\"\nwhat the answer to \"as opposed to what?\" is.\n\nUsually this function isn't used in lieu of using the prerequisite\nsupport built into test_expect_*, mention that explicitly.\n\nThis changes documentation that I added in commit\n9a897893a7 (\"t/README: Document the prereq functions, and 3-arg\ntest_*\", 2010-07-02).\n\nSigned-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>\n---\n t/README | 6 ++++--\n 1 file changed, 4 insertions(+), 2 deletions(-)\n\ndiff --git a/t/README b/t/README\nindex 89512e23d4..36813cef94 100644\n--- a/t/README\n+++ b/t/README\n@@ -612,8 +612,10 @@ library for your script to use.\n  - test_have_prereq <prereq>\n \n    Check if we have a prerequisite previously set with\n-   test_set_prereq. The most common use of this directly is to skip\n-   all the tests if we don't have some essential prerequisite:\n+   test_set_prereq. The most common use-case for using this directly,\n+   as opposed to as an argument to test_expect_*, is to skip all the\n+   tests at the start of the test script if we don't have some\n+   essential prerequisite:\n \n \tif ! test_have_prereq PERL\n \tthen\n-- \n2.11.0\n\n"},{"id":"315000","messageId":"20170322221854.10791-2-avarab@gmail.com","threadId":"45471","inReplyTo":"20170322221854.10791-1-avarab@gmail.com","subject":"[PATCH 2/3] t/README: change \"Inside <X> part\" to \"Inside the <X> part\"","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2017-03-22T22:18:53Z","receivedAt":"2017-03-22T22:19:19Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"Change the mention of \"Inside the <script> part, the standard\noutput...\" to use the definite article, which makes more sense in this\ncontext.\n\nThis changes documentation I originally added back in commit\n20873f45e7 (\"t/README: Document the do's and don'ts of tests\",\n2010-07-02).\n\nSigned-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>\n---\n t/README | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/t/README b/t/README\nindex a50290c789..89512e23d4 100644\n--- a/t/README\n+++ b/t/README\n@@ -477,7 +477,7 @@ Don't:\n \n Keep in mind:\n \n- - Inside <script> part, the standard output and standard error\n+ - Inside the <script> part, the standard output and standard error\n    streams are discarded, and the test harness only reports \"ok\" or\n    \"not ok\" to the end user running the tests. Under --verbose, they\n    are shown to help debugging the tests.\n-- \n2.11.0\n\n"},{"id":"315010","messageId":"xmqqpoh9gcur.fsf@gitster.mtv.corp.google.com","threadId":"45471","inReplyTo":"20170322221854.10791-1-avarab@gmail.com","subject":"Re: [PATCH 1/3] t/README: link to metacpan.org, not search.cpan.org","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2017-03-22T22:34:20Z","receivedAt":"2017-03-22T22:34:27Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Thanks.\n"},{"id":"315218","messageId":"20170324005932.GG20794@aiede.mtv.corp.google.com","threadId":"45471","inReplyTo":"20170322221854.10791-3-avarab@gmail.com","subject":"Re: [PATCH 3/3] t/README: clarify the test_have_prereq documentation","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2017-03-24T00:59:32Z","receivedAt":"2017-03-24T00:59:48Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Hi,\n\nÆvar Arnfjörð Bjarmason wrote:\n\n> --- a/t/README\n> +++ b/t/README\n> @@ -612,8 +612,10 @@ library for your script to use.\n>   - test_have_prereq <prereq>\n>  \n>     Check if we have a prerequisite previously set with\n> -   test_set_prereq. The most common use of this directly is to skip\n> -   all the tests if we don't have some essential prerequisite:\n> +   test_set_prereq. The most common use-case for using this directly,\n> +   as opposed to as an argument to test_expect_*, is to skip all the\n> +   tests at the start of the test script if we don't have some\n> +   essential prerequisite:\n\nNit: the hyphenated word \"use-case\" feels jargon-ish.  I've seen it\nmore often as two separate words.  Better yet to clarify that we're\ntalking about idioms and not just goals:\n\n                       The most common way to use this explicitly (as opposed\n      to the implicit use when an argument is passed to test_expect_*) is to\n      skip all the tests at the start of a test script if we don't have some\n      essential prerequisite:\n\nWith or without such a change,\nReviewed-by: Jonathan Nieder <jrnieder@gmail.com>\n\nThanks.\n"}]}