From 37b5c297cf908a636355e8e3434bacfcdf537269 Mon Sep 17 00:00:00 2001 From: Billy Donahue Date: Wed, 26 Aug 2015 18:28:20 -0400 Subject: readme merging --- googlemock/README.md | 91 ++++++++++++++++++---------------------------------- 1 file changed, 32 insertions(+), 59 deletions(-) (limited to 'googlemock/README.md') diff --git a/googlemock/README.md b/googlemock/README.md index cb51a31a..107685a0 100644 --- a/googlemock/README.md +++ b/googlemock/README.md @@ -1,10 +1,8 @@ -Google C++ Mocking Framework -============================ +## Google C++ Mocking Framework ## -Overview --------- +### Overview ### Google's framework for writing and using C++ mock classes on a variety of platforms (Linux, Mac OS X, Windows, Windows CE, Symbian, etc). @@ -37,24 +35,23 @@ Please note that code under scripts/generator/ is from the [cppclean project](http://code.google.com/p/cppclean/) and under the Apache License, which is different from Google Mock's license. -Requirements for End Users --------------------------- +### Requirements for End Users ### -Google Mock is implemented on top of the [Google Test C++ testing -framework](http://github.com/google/googletest/), and depends on it. -You must use the bundled version of Google Test when using Google Mock, or -you may get compiler/linker errors. +Google Mock is implemented on top of [Google Test]( + http://github.com/google/googletest/), and depends on it. +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 -framework of your choice; although it will still need Google Test as -an internal dependency. Please read - -for how to do it. +framework, although it will still need Google Test. Please read + +["Using_Google_Mock_with_Any_Testing_Framework"]( + docs/ForDummies.md#Using_Google_Mock_with_Any_Testing_Framework) +for instructions. Google Mock depends on advanced C++ features and thus requires a more -modern compiler. The following are needed to use Google Mock: +modern compiler. The following are needed to use Google Mock: -### Linux Requirements ### +#### Linux Requirements #### These are the base requirements to build and use Google Mock from a source package (as described below): @@ -64,17 +61,16 @@ package (as described below): * POSIX(-2) Regular Expressions (regex.h) * C++98-standard-compliant compiler (e.g. GCC 3.4 or newer) -### Windows Requirements ### +#### Windows Requirements #### * Microsoft Visual C++ 8.0 SP1 or newer -### Mac OS X Requirements ### +#### Mac OS X Requirements #### * Mac OS X 10.4 Tiger or newer * Developer Tools Installed -Requirements for Contributors ------------------------------ +### Requirements for Contributors ### We welcome patches. If you plan to contribute a patch, you need to build Google Mock and its own tests from an SVN checkout (described @@ -86,8 +82,7 @@ below), which has further requirements: * Python version 2.3 or newer (for running some of the tests and re-generating certain source files from templates) -Getting the Source ------------------- +### Getting the Source ### There are two primary ways of getting Google Mock's source code: you can download a [stable source release](releases), @@ -127,15 +122,14 @@ instance, if you have both GNU Automake 1.4 and 1.9 installed and Make sure you're using the same version of automake and aclocal. -Setting up the Build --------------------- +### Preparing to Build ### To build Google Mock and your tests that use it, you need to tell your build system where to find its headers and source files. The exact way to do it depends on which build system you use, and is usually straightforward. -### Generic Build Instructions ### +### Build ### This section shows how you can integrate Google Mock into your existing build system. @@ -208,8 +202,7 @@ have to configure it to use the `gmock_config` propety sheet. For that: * In Project Properties | Configuration Properties | General | Additional Include Directories, type /include. -Tweaking Google Mock --------------------- +### Tweaking Google Mock ### Google Mock can be used in diverse environments. The default configuration may not work (or may not work well) out of the box in @@ -264,21 +257,20 @@ for instructions on how to set up necessary compiler settings. Most of Google Test's control macros apply to Google Mock as well. Please see [Google Test's README][gtest_readme] for how to tweak them. -Upgrading from an Earlier Version ---------------------------------- +### Upgrading from an Earlier Version ### We strive to keep Google Mock releases backward compatible. Sometimes, though, we have to make some breaking changes for the users' long-term benefits. This section describes what you'll need to do if you are upgrading from an earlier version of Google Mock. -### Upgrading from 1.1.0 or Earlier ### +#### Upgrading from 1.1.0 or Earlier #### You may need to explicitly enable or disable Google Test's own TR1 tuple library. See the instructions in section "[Choosing a TR1 Tuple Library](../googletest/#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 Google Mock use it in order to be thread-safe. For this to work, you @@ -294,20 +286,19 @@ use the new matcher API ( Matchers defined using `MATCHER()` or `MATCHER_P*()` aren't affected. -Developing Google Mock ----------------------- +### Developing Google Mock ### This section discusses how to make your own changes to Google Mock. -### Testing Google Mock Itself ### +#### Testing Google Mock Itself #### To make sure your changes work as intended and don't break existing functionality, you'll want to compile and run Google Test's own tests. For that you'll need Autotools. First, make sure you have followed -the instructions in section "SVN Checkout" to configure Google Mock. +the instructions above to configure Google Mock. Then, create a build output directory and enter it. Next, - ${GMOCK_DIR}/configure # Standard GNU configure script, --help for more info + ${GMOCK_DIR}/configure # try --help for more info Once you have successfully configured Google Mock, the build steps are standard for GNU-style OSS packages. @@ -319,32 +310,14 @@ Note that when building your project against Google Mock, you are building against Google Test as well. There is no need to configure Google Test separately. -### Regenerating Source Files ### - -Some of Google Mock's source files are generated from templates (not -in the C++ sense) using a script. A template file is named FOO.pump, -where FOO is the name of the file it will generate. For example, the -file `include/gmock/gmock-generated-actions.h.pump` is used to generate -`gmock-generated-actions.h` in the same directory. - -Normally you don't need to worry about regenerating the source files, -unless you need to modify them. In that case, you should modify the -corresponding `.pump` files instead and run the 'pump' script (for Pump -is Useful for Meta Programming) to regenerate them. You can find -pump.py in the `${GTEST_DIR}/scripts/` directory. Read the -[Pump manual](http://code.google.com/p/googletest/wiki/PumpManual) -for how to use it. +#### Contributing a Patch #### - -### Contributing a Patch ### - -We welcome patches. Please read the [Google Mock developer's Guide]( -http://code.google.com/p/googlemock/wiki/DevGuide) -for how you can contribute. In particular, make sure you have signed +We welcome patches. +Please read the [Developer's Guide](docs/DevGuide.md) +for how you can contribute. In particular, make sure you have signed the Contributor License Agreement, or we won't be able to accept the patch. - Happy testing! -[gtest_readme]: ../googletest/ "googletest" +[gtest_readme]: ../googletest/README.md "googletest" -- cgit v1.2.3