diff options
author | Gennadiy Civil <misterg@google.com> | 2018-06-11 15:40:35 (GMT) |
---|---|---|
committer | Gennadiy Civil <misterg@google.com> | 2018-06-11 15:40:35 (GMT) |
commit | 8f87d00398228925b1542b81710a9015c8f68e7b (patch) | |
tree | a383d30b17b861537037174038fc3e15daa6e055 | |
parent | de47b0d30c1d2a2072eb1c2a2e852d6aaa028931 (diff) | |
download | googletest-8f87d00398228925b1542b81710a9015c8f68e7b.zip googletest-8f87d00398228925b1542b81710a9015c8f68e7b.tar.gz googletest-8f87d00398228925b1542b81710a9015c8f68e7b.tar.bz2 |
Rename AdvancedGuide.md to advanced.md and adjust the links.
Part of documentation rationalization work
-rw-r--r-- | googlemock/docs/CheatSheet.md | 2 | ||||
-rw-r--r-- | googlemock/docs/CookBook.md | 2 | ||||
-rw-r--r-- | googlemock/docs/ForDummies.md | 2 | ||||
-rw-r--r-- | googletest/docs/Documentation.md | 2 | ||||
-rw-r--r-- | googletest/docs/FAQ.md | 16 | ||||
-rw-r--r-- | googletest/docs/advanced.md (renamed from googletest/docs/AdvancedGuide.md) | 0 | ||||
-rw-r--r-- | googletest/docs/primer.md | 6 | ||||
-rwxr-xr-x | googletest/scripts/fuse_gtest_files.py | 2 | ||||
-rw-r--r-- | googletest/src/gtest.cc | 2 |
9 files changed, 17 insertions, 17 deletions
diff --git a/googlemock/docs/CheatSheet.md b/googlemock/docs/CheatSheet.md index d078b42..d54dd16 100644 --- a/googlemock/docs/CheatSheet.md +++ b/googlemock/docs/CheatSheet.md @@ -229,7 +229,7 @@ The `argument` can be either a C string or a C++ string object: `ContainsRegex()` and `MatchesRegex()` use the regular expression 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 strings as well. diff --git a/googlemock/docs/CookBook.md b/googlemock/docs/CookBook.md index 3737d03..bd9f026 100644 --- a/googlemock/docs/CookBook.md +++ b/googlemock/docs/CookBook.md @@ -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 types, it prints the raw bytes in the value and hopes that you the 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 printing your particular type than to dump the bytes. diff --git a/googlemock/docs/ForDummies.md b/googlemock/docs/ForDummies.md index 7691056..1e0fd41 100644 --- a/googlemock/docs/ForDummies.md +++ b/googlemock/docs/ForDummies.md @@ -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. 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 implement the `OnTestPartResult()` method of the event listener interface, but it should be straightforward. diff --git a/googletest/docs/Documentation.md b/googletest/docs/Documentation.md index de6aaae..1b6aa4f 100644 --- a/googletest/docs/Documentation.md +++ b/googletest/docs/Documentation.md @@ -6,7 +6,7 @@ the respective git branch/tag).** * [Primer](primer.md) -- start here if you are new to Google Test. * [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. * [Frequently-Asked Questions](FAQ.md) -- check here before asking a question on the mailing list. diff --git a/googletest/docs/FAQ.md b/googletest/docs/FAQ.md index 362f81b..a886bdc 100644 --- a/googletest/docs/FAQ.md +++ b/googletest/docs/FAQ.md @@ -1,7 +1,7 @@ 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. ## 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. * 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. - * 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: - * expand your testing vocabulary by defining [custom predicates](AdvancedGuide.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), - * define your own testing macros or utilities and verify them using Google Test's [Service Provider Interface](AdvancedGuide.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). + * 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](advanced.md#predicate-assertions-for-better-error-messages), + * 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](advanced.md#catching-failures), and + * 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? ## @@ -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? ## -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. ## 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). On Windows, it uses a limited variant of regular expression 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? ## diff --git a/googletest/docs/AdvancedGuide.md b/googletest/docs/advanced.md index 857967a..857967a 100644 --- a/googletest/docs/AdvancedGuide.md +++ b/googletest/docs/advanced.md diff --git a/googletest/docs/primer.md b/googletest/docs/primer.md index 5e8ee0c..561ad02 100644 --- a/googletest/docs/primer.md +++ b/googletest/docs/primer.md @@ -229,7 +229,7 @@ A `NULL` pointer and an empty string are considered _different_. _Availability_: Linux, Windows, Mac. 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 # @@ -494,7 +494,7 @@ int main(int argc, char **argv) { 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 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 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 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 # diff --git a/googletest/scripts/fuse_gtest_files.py b/googletest/scripts/fuse_gtest_files.py index 9a5c8d3..d0dd464 100755 --- a/googletest/scripts/fuse_gtest_files.py +++ b/googletest/scripts/fuse_gtest_files.py @@ -52,7 +52,7 @@ EXAMPLES This tool is experimental. In particular, it assumes that there is no conditional inclusion of Google Test headers. Please report any 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. """ diff --git a/googletest/src/gtest.cc b/googletest/src/gtest.cc index 5406392..3498ffe 100644 --- a/googletest/src/gtest.cc +++ b/googletest/src/gtest.cc @@ -5196,7 +5196,7 @@ bool ShouldRunTestOnShard(int total_shards, int shard_index, int test_id) { // each TestCase and TestInfo object. // If shard_tests == true, further filters tests based on sharding // 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. int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) { const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ? |