Rename "Primer.md" to "primer.md" and adjust links. Part of the documentaion rationalzation
This commit is contained in:
parent
98a0d007d7
commit
de47b0d30c
@ -15,8 +15,8 @@ mailing list for questions, discussions, and development. There is
|
||||
also an IRC channel on [OFTC](https://webchat.oftc.net/) (irc.oftc.net) #gtest available. Please
|
||||
join us!
|
||||
|
||||
Getting started information for **Google Test** is available in the
|
||||
[Google Test Primer](googletest/docs/Primer.md) documentation.
|
||||
Getting started information for **Google Test** is available in the
|
||||
[Google Test Primer](googletest/docs/primer.md) documentation.
|
||||
|
||||
**Google Mock** is an extension to Google Test for writing and using C++ mock
|
||||
classes. See the separate [Google Mock documentation](googlemock/README.md).
|
||||
|
@ -53,7 +53,7 @@ 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
|
||||
documentation in the following order:
|
||||
|
||||
* Learn the [basics](../../master/googletest/docs/Primer.md) of
|
||||
* Learn the [basics](../../master/googletest/docs/primer.md) of
|
||||
Google Test, if you choose to use Google Mock with it (recommended).
|
||||
* Read [Google Mock for Dummies](../../master/googlemock/docs/ForDummies.md).
|
||||
* Read the instructions below on how to build Google Mock.
|
||||
@ -129,20 +129,20 @@ build Google Mock and its tests, which has further requirements:
|
||||
|
||||
If you have CMake available, it is recommended that you follow the
|
||||
[build instructions][gtest_cmakebuild]
|
||||
as described for Google Test.
|
||||
as described for Google Test.
|
||||
|
||||
If are using Google Mock with an
|
||||
existing CMake project, the section
|
||||
[Incorporating Into An Existing CMake Project][gtest_incorpcmake]
|
||||
may be of particular interest.
|
||||
To make it work for Google Mock you will need to change
|
||||
may be of particular interest.
|
||||
To make it work for Google Mock you will need to change
|
||||
|
||||
target_link_libraries(example gtest_main)
|
||||
|
||||
to
|
||||
to
|
||||
|
||||
target_link_libraries(example gmock_main)
|
||||
|
||||
|
||||
This works because `gmock_main` library is compiled with Google Test.
|
||||
However, it does not automatically add Google Test includes.
|
||||
Therefore you will also have to change
|
||||
@ -161,8 +161,8 @@ to
|
||||
"${gtest_SOURCE_DIR}/include" "${gmock_SOURCE_DIR}/include")
|
||||
endif()
|
||||
|
||||
This will addtionally mark Google Mock includes as system, which will
|
||||
silence compiler warnings when compiling your tests using clang with
|
||||
This will addtionally mark Google Mock includes as system, which will
|
||||
silence compiler warnings when compiling your tests using clang with
|
||||
`-Wpedantic -Wall -Wextra -Wconversion`.
|
||||
|
||||
|
||||
|
@ -349,7 +349,7 @@ You can make a matcher from one or more other matchers:
|
||||
|
||||
## Matchers as Test Assertions ##
|
||||
|
||||
|`ASSERT_THAT(expression, m)`|Generates a [fatal failure](../../googletest/docs/Primer.md#assertions) if the value of `expression` doesn't match matcher `m`.|
|
||||
|`ASSERT_THAT(expression, m)`|Generates a [fatal failure](../../googletest/docs/primer.md#assertions) if the value of `expression` doesn't match matcher `m`.|
|
||||
|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|`EXPECT_THAT(expression, m)`|Generates a non-fatal failure if the value of `expression` doesn't match matcher `m`. |
|
||||
|
||||
|
@ -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
|
||||
|
@ -4,7 +4,7 @@ current git version)**
|
||||
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.
|
||||
* [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.
|
||||
|
@ -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](AdvancedGuide.md), send it to
|
||||
googletestframework@googlegroups.com.
|
||||
|
||||
## Why should I use Google Test instead of my favorite C++ testing framework? ##
|
||||
@ -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. ##
|
||||
|
Loading…
Reference in New Issue
Block a user