3party/googletest
0
0
Fork 0
mirror of https://github.com/google/googletest.git synced 2024-12-27 10:11:03 +08:00
Code Issues Projects Releases Wiki Activity

Fix doc links

Browse Source
This commit is contained in:
Arkady Shapkin 2018-09-04 23:07:18 +03:00
parent a2b149b239
commit e6c407d605
10 changed files with 27 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
googlemock/README.md
View File

@ -53,18 +53,18 @@ the Apache License, which is different from Google Mock's license.
If you are new to the project, we suggest that you read the user If you are new to the project, we suggest that you read the user
documentation in the following order: documentation in the following order:
* Learn the [basics](../../master/googletest/docs/primer.md) of * Learn the [basics](../googletest/docs/primer.md) of
Google Test, if you choose to use Google Mock with it (recommended). Google Test, if you choose to use Google Mock with it (recommended).
* Read [Google Mock for Dummies](../../master/googlemock/docs/ForDummies.md). * Read [Google Mock for Dummies](../googlemock/docs/ForDummies.md).
* Read the instructions below on how to build Google Mock. * Read the instructions below on how to build Google Mock.
You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation. You can also watch Zhanyong's [talk](http://www.youtube.com/watch?v=sYpCyLI47rM) on Google Mock's usage and implementation.
Once you understand the basics, check out the rest of the docs: Once you understand the basics, check out the rest of the docs:
* [CheatSheet](../../master/googlemock/docs/CheatSheet.md) - all the commonly used stuff * [CheatSheet](../googlemock/docs/CheatSheet.md) - all the commonly used stuff
at a glance. at a glance.
* [CookBook](../../master/googlemock/docs/CookBook.md) - recipes for getting things done, * [CookBook](../googlemock/docs/CookBook.md) - recipes for getting things done,
including advanced techniques. including advanced techniques.
If you need help, please check the If you need help, please check the
@ -79,7 +79,7 @@ posting a question on the
Google Mock is not a testing framework itself. Instead, it needs a Google Mock is not a testing framework itself. Instead, it needs a
testing framework for writing tests. Google Mock works seamlessly testing framework for writing tests. Google Mock works seamlessly
with [Google Test](https://github.com/google/googletest), but with [Google Test](https://github.com/google/googletest), but
you can also use it with [any C++ testing framework](../../master/googlemock/docs/ForDummies.md#using-google-mock-with-any-testing-framework). you can also use it with [any C++ testing framework](../googlemock/docs/ForDummies.md#using-google-mock-with-any-testing-framework).
### Requirements for End Users ### ### Requirements for End Users ###
@ -90,7 +90,7 @@ You must use the bundled version of Google Test when using Google Mock.
You can also easily configure Google Mock to work with another testing You can also easily configure Google Mock to work with another testing
framework, although it will still need Google Test. Please read framework, although it will still need Google Test. Please read
["Using_Google_Mock_with_Any_Testing_Framework"]( ["Using_Google_Mock_with_Any_Testing_Framework"](
../../master/googlemock/docs/ForDummies.md#using-google-mock-with-any-testing-framework) ../googlemock/docs/ForDummies.md#using-google-mock-with-any-testing-framework)
for instructions. for instructions.
Google Mock depends on advanced C++ features and thus requires a more Google Mock depends on advanced C++ features and thus requires a more
@ -299,15 +299,14 @@ do if you are upgrading from an earlier version of Google Mock.
You may need to explicitly enable or disable Google Test's own TR1 You may need to explicitly enable or disable Google Test's own TR1
tuple library. See the instructions in section "[Choosing a TR1 Tuple tuple library. See the instructions in section "[Choosing a TR1 Tuple
Library](../googletest/#choosing-a-tr1-tuple-library)". Library](#choosing-a-tr1-tuple-library)".
#### Upgrading from 1.4.0 or Earlier #### #### Upgrading from 1.4.0 or Earlier ####
On platforms where the pthread library is available, Google Test and On platforms where the pthread library is available, Google Test and
Google Mock use it in order to be thread-safe. For this to work, you Google Mock use it in order to be thread-safe. For this to work, you
may need to tweak your compiler and/or linker flags. Please see the may need to tweak your compiler and/or linker flags. Please see the
"[Multi-threaded Tests](../googletest#multi-threaded-tests "[Multi-threaded Tests](../googletest/README.md#multi-threaded-tests)" section in file Google Test's README for what you may need to do.
)" section in file Google Test's README for what you may need to do.
If you have custom matchers defined using `MatcherInterface` or If you have custom matchers defined using `MatcherInterface` or
`MakePolymorphicMatcher()`, you'll need to update their definitions to `MakePolymorphicMatcher()`, you'll need to update their definitions to

2
googlemock/docs/CheatSheet.md
View File

@ -264,7 +264,7 @@ Notes:
* These matchers can also match: * These matchers can also match:
1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and 1. a native array passed by reference (e.g. in `Foo(const int (&a)[5])`), and
1. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- see [Multi-argument Matchers](#Multiargument_Matchers.md)). 1. an array passed as a pointer and a count (e.g. in `Bar(const T* buffer, int len)` -- see [Multi-argument Matchers](#multiargument-matchers)).
* The array being matched may be multi-dimensional (i.e. its elements can be arrays). * The array being matched may be multi-dimensional (i.e. its elements can be arrays).
* `m` in `Pointwise(m, ...)` should be a matcher for `::testing::tuple<T, U>` where `T` and `U` are the element type of the actual container and the expected container, respectively. For example, to compare two `Foo` containers where `Foo` doesn't support `operator==` but has an `Equals()` method, one might write: * `m` in `Pointwise(m, ...)` should be a matcher for `::testing::tuple<T, U>` where `T` and `U` are the element type of the actual container and the expected container, respectively. For example, to compare two `Foo` containers where `Foo` doesn't support `operator==` but has an `Equals()` method, one might write:

12
googlemock/docs/CookBook.md
View File

@ -2237,7 +2237,7 @@ Mocking a method that takes and/or returns move-only types presents some
challenges, but nothing insurmountable. This recipe shows you how you can do it. challenges, but nothing insurmountable. This recipe shows you how you can do it.
Note that the support for move-only method arguments was only introduced to Note that the support for move-only method arguments was only introduced to
gMock in April 2017; in older code, you may find more complex gMock in April 2017; in older code, you may find more complex
[workarounds](#LegacyMoveOnly) for lack of this feature. [workarounds](#legacy-workarounds-for-move-only-types) for lack of this feature.
Let’s say we are working on a fictional project that lets one post and share Let’s say we are working on a fictional project that lets one post and share
snippets called “buzzes”. Your code uses these types: snippets called “buzzes”. Your code uses these types:
@ -2302,7 +2302,7 @@ action:
``` ```
If you are not happy with the default action, you can tweak it as usual; see If you are not happy with the default action, you can tweak it as usual; see
[Setting Default Actions](#OnCall). [Setting Default Actions](#setting-the-default-actions-for-a-mock-method).
If you just need to return a pre-defined move-only value, you can use the If you just need to return a pre-defined move-only value, you can use the
`Return(ByMove(...))` action: `Return(ByMove(...))` action:
@ -2345,7 +2345,7 @@ created and returned. You cannot do this with `Return(ByMove(...))`.
That covers returning move-only values; but how do we work with methods That covers returning move-only values; but how do we work with methods
accepting move-only arguments? The answer is that they work normally, although accepting move-only arguments? The answer is that they work normally, although
some actions will not compile when any of method's arguments are move-only. You some actions will not compile when any of method's arguments are move-only. You
can always use `Return`, or a [lambda or functor](#FunctionsAsActions): can always use `Return`, or a [lambda or functor](#using-functionsmethodsfunctors-as-actions):
```cpp ```cpp
using ::testing::Unused; using ::testing::Unused;
@ -2366,7 +2366,7 @@ implemented yet. If this is blocking you, please file a bug.
A few actions (e.g. `DoAll`) copy their arguments internally, so they can never A few actions (e.g. `DoAll`) copy their arguments internally, so they can never
work with non-copyable objects; you'll have to use functors instead. work with non-copyable objects; you'll have to use functors instead.
##### Legacy workarounds for move-only types {#LegacyMoveOnly} ##### Legacy workarounds for move-only types
Support for move-only function arguments was only introduced to gMock in April Support for move-only function arguments was only introduced to gMock in April
2017. In older code, you may encounter the following workaround for the lack of 2017. In older code, you may encounter the following workaround for the lack of
@ -2821,7 +2821,7 @@ and you should see an `OUTPUT_DIR` directory being created with files
These three files contain everything you need to use Google Mock (and These three files contain everything you need to use Google Mock (and
Google Test). Just copy them to anywhere you want and you are ready Google Test). Just copy them to anywhere you want and you are ready
to write tests and use mocks. You can use the to write tests and use mocks. You can use the
[scrpts/test/Makefile](../scripts/test/Makefile) file as an example on how to compile your tests [make/Makefile](../make/Makefile) file as an example on how to compile your tests
against them. against them.
# Extending Google Mock # # Extending Google Mock #
@ -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/advanced.md#teaching-google-test-how-to-print-your-values) [Google Test's advanced guide](../../googletest/docs/advanced.md#teaching-googletest-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/Documentation.md
View File

@ -11,5 +11,5 @@ the respective git branch/tag).**
To contribute code to Google Mock, read: To contribute code to Google Mock, read:
* [CONTRIBUTING](../CONTRIBUTING.md) -- read this _before_ writing your first patch. * [CONTRIBUTING](../../CONTRIBUTING.md) -- read this _before_ writing your first patch.
* [Pump Manual](../../googletest/docs/PumpManual.md) -- how we generate some of Google Mock's source files. * [Pump Manual](../../googletest/docs/PumpManual.md) -- how we generate some of Google Mock's source files.

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/advanced.md#extending-google-test-by-handling-test-events) [event listener API](../../googletest/docs/advanced.md#extending-googletest-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.

10
googlemock/docs/FrequentlyAskedQuestions.md
View File

@ -3,7 +3,7 @@
Please send your questions to the Please send your questions to the
[googlemock](http://groups.google.com/group/googlemock) discussion [googlemock](http://groups.google.com/group/googlemock) discussion
group. If you need help with compiler errors, make sure you have group. If you need help with compiler errors, make sure you have
tried [Google Mock Doctor](#How_am_I_supposed_to_make_sense_of_these_horrible_template_error.md) first. tried [Google Mock Doctor](#how-am-i-supposed-to-make-sense-of-these-horrible-template-errors) first.
## When I call a method on my mock object, the method for the real object is invoked instead. What's the problem? ## ## When I call a method on my mock object, the method for the real object is invoked instead. What's the problem? ##
@ -474,10 +474,10 @@ verbose level.
If you find yourself needing to perform some action that's not If you find yourself needing to perform some action that's not
supported by Google Mock directly, remember that you can define your own supported by Google Mock directly, remember that you can define your own
actions using actions using
[MakeAction()](CookBook.md#writing-new-actions) or [MakeAction()](CookBook.md#writing-new-actions-quickly) or
[MakePolymorphicAction()](CookBook.md#writing_new_polymorphic_actions), [MakePolymorphicAction()](CookBook.md#writing-new-polymorphic-actions),
or you can write a stub function and invoke it using or you can write a stub function and invoke it using
[Invoke()](CookBook.md#using-functions_methods_functors). [Invoke()](CookBook.md#using-functionsmethodsfunctors-as-actions).
## MOCK\_METHODn()'s second argument looks funny. Why don't you use the MOCK\_METHODn(Method, return\_type, arg\_1, ..., arg\_n) syntax? ## ## MOCK\_METHODn()'s second argument looks funny. Why don't you use the MOCK\_METHODn(Method, return\_type, arg\_1, ..., arg\_n) syntax? ##
@ -599,7 +599,7 @@ when the mock method is called. `SetArgPointee()` says what the
side effect is, but doesn't say what the return value should be. You side effect is, but doesn't say what the return value should be. You
need `DoAll()` to chain a `SetArgPointee()` with a `Return()`. need `DoAll()` to chain a `SetArgPointee()` with a `Return()`.
See this [recipe](CookBook.md#mocking_side_effects) for more details and an example. See this [recipe](CookBook.md#mocking-side-effects) for more details and an example.
## My question is not in your FAQ! ## ## My question is not in your FAQ! ##

4
googletest/docs/advanced.md
View File

@ -150,7 +150,7 @@ c is 10
> >
> 1. If you see a compiler error "no matching function to call" when using > 1. If you see a compiler error "no matching function to call" when using
> `ASSERT_PRED*` or `EXPECT_PRED*`, please see > `ASSERT_PRED*` or `EXPECT_PRED*`, please see
> [this](faq.md#OverloadedPredicate) for how to resolve it. > [this](faq.md#the-compiler-complains-no-matching-function-to-call-when-i-use-assert_pred-how-do-i-fix-it) for how to resolve it.
> 1. Currently we only provide predicate assertions of arity <= 5. If you need > 1. Currently we only provide predicate assertions of arity <= 5. If you need
> a higher-arity assertion, let [us](https://github.com/google/googletest/issues) know. > a higher-arity assertion, let [us](https://github.com/google/googletest/issues) know.
@ -423,7 +423,7 @@ and you're ready to go.
### More String Assertions ### More String Assertions
(Please read the [previous](#AssertThat) section first if you haven't.) (Please read the [previous](#asserting-using-gmock-matchers) section first if you haven't.)
You can use the gMock [string matchers](../../googlemock/docs/CheatSheet.md#string-matchers) You can use the gMock [string matchers](../../googlemock/docs/CheatSheet.md#string-matchers)
with `EXPECT_THAT()` or `ASSERT_THAT()` to do more string comparison tricks with `EXPECT_THAT()` or `ASSERT_THAT()` to do more string comparison tricks

2
googletest/docs/faq.md
View File

@ -131,7 +131,7 @@ In August 2008 we had to switch the default death test style from `fast` to
default. This caused many death tests to slow down. Unfortunately this change default. This caused many death tests to slow down. Unfortunately this change
was necessary. was necessary.
Please read [Fixing Failing Death Tests](death_test_styles.md) for what you can Please read [Fixing Failing Death Tests](advanced.md#death-test-styles) for what you can
do. do.
## I got some run-time errors about invalid proto descriptors when using `ProtocolMessageEquals`. Help! ## I got some run-time errors about invalid proto descriptors when using `ProtocolMessageEquals`. Help!

2
googletest/docs/primer.md
View File

@ -198,7 +198,7 @@ objects, you should use `ASSERT_EQ`.
When doing pointer comparisons use `*_EQ(ptr, nullptr)` and `*_NE(ptr, nullptr)` When doing pointer comparisons use `*_EQ(ptr, nullptr)` and `*_NE(ptr, nullptr)`
instead of `*_EQ(ptr, NULL)` and `*_NE(ptr, NULL)`. This is because `nullptr` is instead of `*_EQ(ptr, NULL)` and `*_NE(ptr, NULL)`. This is because `nullptr` is
typed while `NULL` is not. See [FAQ](faq.md#why-does-google-test-support-expect_eqnull-ptr-and-assert_eqnull-ptr-but-not-expect_nenull-ptr-and-assert_nenull-ptr) typed while `NULL` is not. See [FAQ](faq.md#why-does-googletest-support-expect_eqnull-ptr-and-assert_eqnull-ptr-but-not-expect_nenull-ptr-and-assert_nenull-ptr)
for more details. for more details.
If you're working with floating point numbers, you may want to use the floating If you're working with floating point numbers, you may want to use the floating

2
googletest/docs/samples.md
View File

@ -1,4 +1,4 @@
# Googletest Samples {#samples} # Googletest Samples
If you're like us, you'd like to look at [googletest If you're like us, you'd like to look at [googletest
samples.](https://github.com/google/googletest/tree/master/googletest/samples) samples.](https://github.com/google/googletest/tree/master/googletest/samples)