diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_data/navigation.yml | 4 | ||||
| -rw-r--r-- | docs/advanced.md | 4 | ||||
| -rw-r--r-- | docs/index.md | 23 | ||||
| -rw-r--r-- | docs/platforms.md | 35 |
4 files changed, 53 insertions, 13 deletions
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 671ed905..b79f2505 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -1,4 +1,8 @@ nav: +- section: "Get Started" + items: + - title: "Supported Platforms" + url: "/platforms.html" - section: "Guides" items: - title: "GoogleTest Primer" diff --git a/docs/advanced.md b/docs/advanced.md index 17ba194d..4103507b 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -1501,11 +1501,11 @@ class MyTestSuite : public testing::TestWithParam<std::tuple<MyType, std::string INSTANTIATE_TEST_SUITE_P( MyGroup, MyTestSuite, testing::Combine( - testing::Values(MyType::VALUE_0, MyType::VALUE_1), + testing::Values(MyType::MY_FOO, MyType::MY_BAR), testing::Values("A", "B")), [](const testing::TestParamInfo<MyTestSuite::ParamType>& info) { std::string name = absl::StrCat( - std::get<0>(info.param) == MY_FOO ? "Foo" : "Bar", + std::get<0>(info.param) == MyType::MY_FOO ? "Foo" : "Bar", std::get<1>(info.param)); absl::c_replace_if(name, [](char c) { return !std::isalnum(c); }, ''); return name; diff --git a/docs/index.md b/docs/index.md index 9f18e3e8..b162c740 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,17 +5,18 @@ GoogleTest is Google's C++ testing and mocking framework. This user's guide has the following contents: -* [GoogleTest Primer](primer) - Teaches you how to write simple tests using +* [GoogleTest Primer](primer.md) - Teaches you how to write simple tests using GoogleTest. Read this first if you are new to GoogleTest. -* [GoogleTest Advanced](advanced) - Read this when you've finished the Primer - and want to utilize GoogleTest to its full potential. -* [GoogleTest Samples](samples) - Describes some GoogleTest samples. -* [GoogleTest FAQ](faq) - Have a question? Want some tips? Check here first. -* [Mocking for Dummies](gmock_for_dummies) - Teaches you how to create mock +* [GoogleTest Advanced](advanced.md) - Read this when you've finished the + Primer and want to utilize GoogleTest to its full potential. +* [GoogleTest Samples](samples.md) - Describes some GoogleTest samples. +* [GoogleTest FAQ](faq.md) - Have a question? Want some tips? Check here + first. +* [Mocking for Dummies](gmock_for_dummies.md) - Teaches you how to create mock objects and use them in tests. -* [Mocking Cookbook](gmock_cook_book) - Includes tips and approaches to common - mocking use cases. -* [Mocking Cheat Sheet](gmock_cheat_sheet) - A handy reference for matchers, - actions, invariants, and more. -* [Mocking FAQ](gmock_faq) - Contains answers to some mocking-specific +* [Mocking Cookbook](gmock_cook_book.md) - Includes tips and approaches to + common mocking use cases. +* [Mocking Cheat Sheet](gmock_cheat_sheet.md) - A handy reference for + matchers, actions, invariants, and more. +* [Mocking FAQ](gmock_faq.md) - Contains answers to some mocking-specific questions. diff --git a/docs/platforms.md b/docs/platforms.md new file mode 100644 index 00000000..eba6ef80 --- /dev/null +++ b/docs/platforms.md @@ -0,0 +1,35 @@ +# Supported Platforms + +GoogleTest requires a codebase and compiler compliant with the C++11 standard or +newer. + +The GoogleTest code is officially supported on the following platforms. +Operating systems or tools not listed below are community-supported. For +community-supported platforms, patches that do not complicate the code may be +considered. + +If you notice any problems on your platform, please file an issue on the +[GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues). +Pull requests containing fixes are welcome! + +### Operating systems + +* Linux +* macOS +* Windows + +### Compilers + +* gcc 5.0+ +* clang 5.0+ +* MSVC 2015+ + +**macOS users:** Xcode 9.3+ provides clang 5.0+. + +### Build systems + +* [Bazel](https://bazel.build/) +* [CMake](https://cmake.org/) + +Bazel is the build system used by the team internally and in tests. CMake is +supported on a best-effort basis and by the community. |
