summaryrefslogtreecommitdiffstats
path: root/googletest
diff options
context:
space:
mode:
authorGennadiy Civil <gennadiycivil@users.noreply.github.com>2018-06-11 16:55:06 (GMT)
committerGitHub <noreply@github.com>2018-06-11 16:55:06 (GMT)
commit9077ec7efe5b652468ab051e93c67589d5cb8f85 (patch)
treec1420a17dc6c9f9b0900a47d2b9a566d318faded /googletest
parentc091b0469ab4c04ee9411ef770f32360945f4c53 (diff)
parent0b958a03e9f757c5f744f09fac2f82b6d896561b (diff)
downloadgoogletest-9077ec7efe5b652468ab051e93c67589d5cb8f85.zip
googletest-9077ec7efe5b652468ab051e93c67589d5cb8f85.tar.gz
googletest-9077ec7efe5b652468ab051e93c67589d5cb8f85.tar.bz2
Merge pull request #1624 from gennadiycivil/master
Adjust documentation files and links.
Diffstat (limited to 'googletest')
-rw-r--r--googletest/docs/Documentation.md16
-rw-r--r--googletest/docs/advanced.md (renamed from googletest/docs/AdvancedGuide.md)6
-rw-r--r--googletest/docs/faq.md (renamed from googletest/docs/FAQ.md)18
-rw-r--r--googletest/docs/primer.md (renamed from googletest/docs/Primer.md)10
-rw-r--r--googletest/docs/samples.md (renamed from googletest/docs/Samples.md)0
-rwxr-xr-xgoogletest/scripts/fuse_gtest_files.py2
-rw-r--r--googletest/src/gtest.cc2
7 files changed, 19 insertions, 35 deletions
diff --git a/googletest/docs/Documentation.md b/googletest/docs/Documentation.md
deleted file mode 100644
index 20f2503..0000000
--- a/googletest/docs/Documentation.md
+++ /dev/null
@@ -1,16 +0,0 @@
-This page lists all documentation markdown files for Google Test **(the
-current git version)**
--- **if you use a former version of Google Test, please read the
-documentation for that specific version instead (e.g. by checking out
-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.
- * [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.
-
-To contribute code to Google Test, read:
-
- * [CONTRIBUTING](../../CONTRIBUTING.md) -- read this _before_ writing your first patch.
- * [PumpManual](PumpManual.md) -- how we generate some of Google Test's source files.
diff --git a/googletest/docs/AdvancedGuide.md b/googletest/docs/advanced.md
index c1a1a4a..73b7954 100644
--- a/googletest/docs/AdvancedGuide.md
+++ b/googletest/docs/advanced.md
@@ -1,6 +1,6 @@
-Now that you have read [Primer](Primer.md) and learned how to write tests
+Now that you have read [Primer](primer.md) and learned how to write tests
using Google Test, it's time to learn some new tricks. This document
will show you more assertions as well as how to construct complex
failure messages, propagate fatal failures, reuse and speed up your
@@ -125,7 +125,7 @@ c is 10<br>
**Notes:**
- 1. If you see a compiler error "no matching function to call" when using `ASSERT_PRED*` or `EXPECT_PRED*`, please see [this FAQ](FAQ.md#the-compiler-complains-no-matching-function-to-call-when-i-use-assert_predn-how-do-i-fix-it) for how to resolve it.
+ 1. If you see a compiler error "no matching function to call" when using `ASSERT_PRED*` or `EXPECT_PRED*`, please see [this FAQ](faq.md#the-compiler-complains-no-matching-function-to-call-when-i-use-assert_predn-how-do-i-fix-it) for how to resolve it.
1. Currently we only provide predicate assertions of arity <= 5. If you need a higher-arity assertion, let us know.
_Availability_: Linux, Windows, Mac.
@@ -2413,4 +2413,4 @@ file as an example on how to compile your tests against them.
Congratulations! You've now learned more advanced Google Test tools and are
ready to tackle more complex testing tasks. If you want to dive even deeper, you
-can read the [Frequently-Asked Questions](FAQ.md).
+can read the [Frequently-Asked Questions](faq.md).
diff --git a/googletest/docs/FAQ.md b/googletest/docs/faq.md
index bd9526d..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? ##
@@ -956,7 +956,7 @@ using gtest-md.vcproj instead of gtest.vcproj.
## I put my tests in a library and Google Test doesn't run them. What's happening? ##
Have you read a
-[warning](Primer.md#important-note-for-visual-c-users) on
+[warning](primer.md#important-note-for-visual-c-users) on
the Google Test Primer page?
## I want to use Google Test with Visual Studio but don't know where to start. ##
diff --git a/googletest/docs/Primer.md b/googletest/docs/primer.md
index 5e8ee0c..52b99f9 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 #
@@ -290,7 +290,7 @@ To create a fixture, just:
1. Derive a class from `::testing::Test` . Start its body with `protected:` or `public:` as we'll want to access fixture members from sub-classes.
1. Inside the class, declare any objects you plan to use.
1. If necessary, write a default constructor or `SetUp()` function to prepare the objects for each test. A common mistake is to spell `SetUp()` as `Setup()` with a small `u` - don't let that happen to you.
- 1. If necessary, write a destructor or `TearDown()` function to release any resources you allocated in `SetUp()` . To learn when you should use the constructor/destructor and when you should use `SetUp()/TearDown()`, read this [FAQ entry](FAQ.md#should-i-use-the-constructordestructor-of-the-test-fixture-or-the-set-uptear-down-function).
+ 1. If necessary, write a destructor or `TearDown()` function to release any resources you allocated in `SetUp()` . To learn when you should use the constructor/destructor and when you should use `SetUp()/TearDown()`, read this [FAQ entry](faq.md#should-i-use-the-constructordestructor-of-the-test-fixture-or-the-set-uptear-down-function).
1. If needed, define subroutines for your tests to share.
When using a fixture, use `TEST_F()` instead of `TEST()` as it allows you to
@@ -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.
@@ -522,8 +522,8 @@ There is one more pitfall, though. If you use Google Test as a static library (t
# Where to Go from Here #
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.
+and running Google Test tests, read some [samples](samples.md), or continue with
+[AdvancedGuide](advanced.md), which describes many more useful Google Test features.
# Known Limitations #
diff --git a/googletest/docs/Samples.md b/googletest/docs/samples.md
index f21d200..f21d200 100644
--- a/googletest/docs/Samples.md
+++ b/googletest/docs/samples.md
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 ?