gitMirror/googletest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename AdvancedGuide.md to advanced.md and adjust the links.

Browse Source 
Part of documentation rationalization work
This commit is contained in:
Gennadiy Civil
2018-06-11 11:40:35 -04:00
parent de47b0d30c
commit 8f87d00398
9 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
googlemock/docs/CheatSheet.md
View File

@@ -229,7 +229,7 @@ The `argument` can be either a C string or a C++ string object:
`ContainsRegex()` and `MatchesRegex()` use the regular expression `ContainsRegex()` and `MatchesRegex()` use the regular expression
syntax defined syntax defined
[here](../../googletest/docs/AdvancedGuide.md#regular-expression-syntax). [here](../../googletest/docs/advanced.md#regular-expression-syntax).
`StrCaseEq()`, `StrCaseNe()`, `StrEq()`, and `StrNe()` work for wide `StrCaseEq()`, `StrCaseNe()`, `StrEq()`, and `StrNe()` work for wide
strings as well. strings as well.

2
googlemock/docs/CookBook.md
View File

@@ -3655,6 +3655,6 @@ This printer knows how to print built-in C++ types, native arrays, STL
containers, and any type that supports the `<<` operator. For other containers, and any type that supports the `<<` operator. For other
types, it prints the raw bytes in the value and hopes that you the types, it prints the raw bytes in the value and hopes that you the
user can figure it out. user can figure it out.
[Google Test's advanced guide](../../googletest/docs/AdvancedGuide.md#teaching-google-test-how-to-print-your-values) [Google Test's advanced guide](../../googletest/docs/advanced.md#teaching-google-test-how-to-print-your-values)
explains how to extend the printer to do a better job at explains how to extend the printer to do a better job at
printing your particular type than to dump the bytes. printing your particular type than to dump the bytes.

2
googlemock/docs/ForDummies.md
View File

@@ -187,7 +187,7 @@ sometimes causes the test program to crash. You'll still be able to
notice that the test has failed, but it's not a graceful failure. notice that the test has failed, but it's not a graceful failure.
A better solution is to use Google Test's A better solution is to use Google Test's
[event listener API](../../googletest/docs/AdvancedGuide.md#extending-google-test-by-handling-test-events) [event listener API](../../googletest/docs/advanced.md#extending-google-test-by-handling-test-events)
to report a test failure to your testing framework properly. You'll need to to report a test failure to your testing framework properly. You'll need to
implement the `OnTestPartResult()` method of the event listener interface, but it implement the `OnTestPartResult()` method of the event listener interface, but it
should be straightforward. should be straightforward.

2
googletest/docs/Documentation.md
View File

@@ -6,7 +6,7 @@ the respective git branch/tag).**
* [Primer](primer.md) -- start here if you are new to Google Test. * [Primer](primer.md) -- start here if you are new to Google Test.
* [Samples](Samples.md) -- learn from examples. * [Samples](Samples.md) -- learn from examples.
* [AdvancedGuide](AdvancedGuide.md) -- learn more about Google Test. * [AdvancedGuide](advanced.md) -- learn more about Google Test.
* [XcodeGuide](XcodeGuide.md) -- how to use Google Test in Xcode on Mac. * [XcodeGuide](XcodeGuide.md) -- how to use Google Test in Xcode on Mac.
* [Frequently-Asked Questions](FAQ.md) -- check here before asking a question on the mailing list. * [Frequently-Asked Questions](FAQ.md) -- check here before asking a question on the mailing list.

16
googletest/docs/FAQ.md
View File

@@ -1,7 +1,7 @@
If you cannot find the answer to your question here, and you have read If you cannot find the answer to your question here, and you have read
[Primer](primer.md) and [AdvancedGuide](AdvancedGuide.md), send it to [Primer](primer.md) and [AdvancedGuide](advanced.md), send it to
googletestframework@googlegroups.com. googletestframework@googlegroups.com.
## Why should I use Google Test instead of my favorite C++ testing framework? ## ## Why should I use Google Test instead of my favorite C++ testing framework? ##
@@ -28,11 +28,11 @@ list can help you decide whether it is for you too.
* `SCOPED_TRACE` helps you understand the context of an assertion failure when it comes from inside a sub-routine or loop. * `SCOPED_TRACE` helps you understand the context of an assertion failure when it comes from inside a sub-routine or loop.
* You can decide which tests to run using name patterns. This saves time when you want to quickly reproduce a test failure. * You can decide which tests to run using name patterns. This saves time when you want to quickly reproduce a test failure.
* Google Test can generate XML test result reports that can be parsed by popular continuous build system like Hudson. * Google Test can generate XML test result reports that can be parsed by popular continuous build system like Hudson.
* Simple things are easy in Google Test, while hard things are possible: in addition to advanced features like [global test environments](AdvancedGuide.md#global-set-up-and-tear-down) and tests parameterized by [values](AdvancedGuide.md#value-parameterized-tests) or [types](docs/AdvancedGuide.md#typed-tests), Google Test supports various ways for the user to extend the framework -- if Google Test doesn't do something out of the box, chances are that a user can implement the feature using Google Test's public API, without changing Google Test itself. In particular, you can: * Simple things are easy in Google Test, while hard things are possible: in addition to advanced features like [global test environments](advanced.md#global-set-up-and-tear-down) and tests parameterized by [values](advanced.md#value-parameterized-tests) or [types](docs/advanced.md#typed-tests), Google Test supports various ways for the user to extend the framework -- if Google Test doesn't do something out of the box, chances are that a user can implement the feature using Google Test's public API, without changing Google Test itself. In particular, you can:
* expand your testing vocabulary by defining [custom predicates](AdvancedGuide.md#predicate-assertions-for-better-error-messages), * expand your testing vocabulary by defining [custom predicates](advanced.md#predicate-assertions-for-better-error-messages),
* teach Google Test how to [print your types](AdvancedGuide.md#teaching-google-test-how-to-print-your-values), * teach Google Test how to [print your types](advanced.md#teaching-google-test-how-to-print-your-values),
* define your own testing macros or utilities and verify them using Google Test's [Service Provider Interface](AdvancedGuide.md#catching-failures), and * define your own testing macros or utilities and verify them using Google Test's [Service Provider Interface](advanced.md#catching-failures), and
* reflect on the test cases or change the test output format by intercepting the [test events](AdvancedGuide.md#extending-google-test-by-handling-test-events). * reflect on the test cases or change the test output format by intercepting the [test events](advanced.md#extending-google-test-by-handling-test-events).
## I'm getting warnings when compiling Google Test. Would you fix them? ## ## I'm getting warnings when compiling Google Test. Would you fix them? ##
@@ -754,7 +754,7 @@ EXPECT_TRUE(internal::Func(12345));
## I would like to run a test several times with different parameters. Do I need to write several similar copies of it? ## ## I would like to run a test several times with different parameters. Do I need to write several similar copies of it? ##
No. You can use a feature called [value-parameterized tests](AdvancedGuide.md#Value_Parameterized_Tests) which No. You can use a feature called [value-parameterized tests](advanced.md#Value_Parameterized_Tests) which
lets you repeat your tests with different parameters, without defining it more than once. lets you repeat your tests with different parameters, without defining it more than once.
## How do I test a file that defines main()? ## ## How do I test a file that defines main()? ##
@@ -849,7 +849,7 @@ expression syntax
(http://en.wikipedia.org/wiki/Regular_expression#POSIX_Extended_Regular_Expressions). (http://en.wikipedia.org/wiki/Regular_expression#POSIX_Extended_Regular_Expressions).
On Windows, it uses a limited variant of regular expression On Windows, it uses a limited variant of regular expression
syntax. For more details, see the syntax. For more details, see the
[regular expression syntax](AdvancedGuide.md#Regular_Expression_Syntax). [regular expression syntax](advanced.md#Regular_Expression_Syntax).
## I have a fixture class Foo, but TEST\_F(Foo, Bar) gives me error "no matching function for call to Foo::Foo()". Why? ## ## I have a fixture class Foo, but TEST\_F(Foo, Bar) gives me error "no matching function for call to Foo::Foo()". Why? ##

0
googletest/docs/AdvancedGuide.md → googletest/docs/advanced.md
View File

6
googletest/docs/primer.md
View File

@@ -229,7 +229,7 @@ A `NULL` pointer and an empty string are considered _different_.
_Availability_: Linux, Windows, Mac. _Availability_: Linux, Windows, Mac.
See also: For more string comparison tricks (substring, prefix, suffix, and See also: For more string comparison tricks (substring, prefix, suffix, and
regular expression matching, for example), see the [Advanced Google Test Guide](AdvancedGuide.md). regular expression matching, for example), see the [Advanced Google Test Guide](advanced.md).
# Simple Tests # # Simple Tests #
@@ -494,7 +494,7 @@ int main(int argc, char **argv) {
The `::testing::InitGoogleTest()` function parses the command line for Google The `::testing::InitGoogleTest()` function parses the command line for Google
Test flags, and removes all recognized flags. This allows the user to control a Test flags, and removes all recognized flags. This allows the user to control a
test program's behavior via various flags, which we'll cover in [AdvancedGuide](AdvancedGuide.md). test program's behavior via various flags, which we'll cover in [AdvancedGuide](advanced.md).
You must call this function before calling `RUN_ALL_TESTS()`, or the flags You must call this function before calling `RUN_ALL_TESTS()`, or the flags
won't be properly initialized. won't be properly initialized.
@@ -523,7 +523,7 @@ There is one more pitfall, though. If you use Google Test as a static library (t
Congratulations! You've learned the Google Test basics. You can start writing Congratulations! You've learned the Google Test basics. You can start writing
and running Google Test tests, read some [samples](Samples.md), or continue with and running Google Test tests, read some [samples](Samples.md), or continue with
[AdvancedGuide](AdvancedGuide.md), which describes many more useful Google Test features. [AdvancedGuide](advanced.md), which describes many more useful Google Test features.
# Known Limitations # # Known Limitations #

2
googletest/scripts/fuse_gtest_files.py
View File

@@ -52,7 +52,7 @@ EXAMPLES
This tool is experimental. In particular, it assumes that there is no This tool is experimental. In particular, it assumes that there is no
conditional inclusion of Google Test headers. Please report any conditional inclusion of Google Test headers. Please report any
problems to googletestframework@googlegroups.com. You can read problems to googletestframework@googlegroups.com. You can read
https://github.com/google/googletest/blob/master/googletest/docs/AdvancedGuide.md for https://github.com/google/googletest/blob/master/googletest/docs/advanced.md for
more information. more information.
""" """

2
googletest/src/gtest.cc
View File

@@ -5196,7 +5196,7 @@ bool ShouldRunTestOnShard(int total_shards, int shard_index, int test_id) {
// each TestCase and TestInfo object. // each TestCase and TestInfo object.
// If shard_tests == true, further filters tests based on sharding // If shard_tests == true, further filters tests based on sharding
// variables in the environment - see // variables in the environment - see
// https://github.com/google/googletest/blob/master/googletest/docs/AdvancedGuide.md // https://github.com/google/googletest/blob/master/googletest/docs/advanced.md
// . Returns the number of tests that should run. // . Returns the number of tests that should run.
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) { int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ? const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?