Use note() instead of diag() #164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In the documentation for Test::More, the note() function is described as "Handy for putting in notes which might be useful for debugging, but don't indicate a problem." diag() is mainly intended to be used in situations where a unit test has failed and more diagnostic output would be helpful in debugging. Here, we're simply making a note of the name of the tempfile created during testing, so note() is more appropriate. In addition, note() prints to STDOUT when the tests are run as part of a harness; diag() prints to STDERR. When Encode's test suite is run as part of the Perl 5 core distribution's test suite, this diag() statement is the *only* statement that gets printed to STDERR. Once this p.r. is applied, a new version of Encode is released to CPAN, and that version is synched into blead, then Perl's test suite will run entirely to STDOUT.
|
Thank you! |
kraj
pushed a commit
to YoeDistro/meta-openembedded
that referenced
this pull request
Apr 25, 2022
Changelog: ========== ! bin/enc2xs t/enc_data.t t/enc_module.t t/encoding.t t/jperl.t Pulled: Fix Issue openembedded#144, spurious warnings from -Wc++-compate, and a few related nits dankogai/p5-encode#168 ! MANIFEST add t/utf32warnings.t which was missing ! t/taint.t Pulled: Skip taint tests if your perl was built without taint support dankogai/p5-encode#167 ! Unicode/Unicode.pm Pulled: fix link to Unicode standard dankogai/p5-encode#165 ! t/Unicode_trailing_nul.t Pulled: Use note() instead of diag() dankogai/p5-encode#164 Signed-off-by: Wang Mingyu <wangmy@fujitsu.com> Signed-off-by: Khem Raj <raj.khem@gmail.com>
kraj
pushed a commit
to YoeDistro/meta-openembedded
that referenced
this pull request
Apr 25, 2022
Changelog: ========== ! bin/enc2xs t/enc_data.t t/enc_module.t t/encoding.t t/jperl.t Pulled: Fix Issue openembedded#144, spurious warnings from -Wc++-compate, and a few related nits dankogai/p5-encode#168 ! MANIFEST add t/utf32warnings.t which was missing ! t/taint.t Pulled: Skip taint tests if your perl was built without taint support dankogai/p5-encode#167 ! Unicode/Unicode.pm Pulled: fix link to Unicode standard dankogai/p5-encode#165 ! t/Unicode_trailing_nul.t Pulled: Use note() instead of diag() dankogai/p5-encode#164 Signed-off-by: Wang Mingyu <wangmy@fujitsu.com> Signed-off-by: Khem Raj <raj.khem@gmail.com>
halstead
pushed a commit
to openembedded/meta-openembedded
that referenced
this pull request
May 3, 2022
Changelog: ========== ! bin/enc2xs t/enc_data.t t/enc_module.t t/encoding.t t/jperl.t Pulled: Fix Issue #144, spurious warnings from -Wc++-compate, and a few related nits dankogai/p5-encode#168 ! MANIFEST add t/utf32warnings.t which was missing ! t/taint.t Pulled: Skip taint tests if your perl was built without taint support dankogai/p5-encode#167 ! Unicode/Unicode.pm Pulled: fix link to Unicode standard dankogai/p5-encode#165 ! t/Unicode_trailing_nul.t Pulled: Use note() instead of diag() dankogai/p5-encode#164 Signed-off-by: Wang Mingyu <wangmy@fujitsu.com> Signed-off-by: Khem Raj <raj.khem@gmail.com> (cherry picked from commit a21bab9) Signed-off-by: Armin Kuster <akuster808@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the documentation for Test::More, the note() function is described as
"Handy for putting in notes which might be useful for debugging, but
don't indicate a problem." diag() is mainly intended to be used in
situations where a unit test has failed and more diagnostic output would
be helpful in debugging.
Here, we're simply making a note of the name of the tempfile created
during testing, so note() is more appropriate.
In addition, note() prints to STDOUT when the tests are run as part of a
harness; diag() prints to STDERR. When Encode's test suite is run as
part of the Perl 5 core distribution's test suite, this diag() statement
is the only statement that gets printed to STDERR. Once this p.r. is
applied, a new version of Encode is released to CPAN, and that version
is synched into blead, then Perl's test suite will run entirely to
STDOUT.