Fix formatting of Markdown files

PiperOrigin-RevId: 504308485
Change-Id: Ia4ae97b2173b44b89aa5d987ddefd6e0c1488386
This commit is contained in:
Tom Hughes 2023-01-24 10:12:28 -08:00 committed by Copybara-Service
parent 544c96ed5b
commit 408471e20c
2 changed files with 39 additions and 15 deletions

View File

@ -102,30 +102,40 @@ To make sure your changes work as intended and don't break existing
functionality, you'll want to compile and run Google Test and GoogleMock's own functionality, you'll want to compile and run Google Test and GoogleMock's own
tests. For that you can use CMake: tests. For that you can use CMake:
```
mkdir mybuild mkdir mybuild
cd mybuild cd mybuild
cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR} cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR}
```
To choose between building only Google Test or Google Mock, you may modify your To choose between building only Google Test or Google Mock, you may modify your
cmake command to be one of each cmake command to be one of each
```
cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests
cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests
```
Make sure you have Python installed, as some of Google Test's tests are written Make sure you have Python installed, as some of Google Test's tests are written
in Python. If the cmake command complains about not being able to find Python in Python. If the cmake command complains about not being able to find Python
(`Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)`), try telling it (`Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)`), try telling it
explicitly where your Python executable can be found: explicitly where your Python executable can be found:
```
cmake -DPYTHON_EXECUTABLE=path/to/python ... cmake -DPYTHON_EXECUTABLE=path/to/python ...
```
Next, you can build Google Test and / or Google Mock and all desired tests. On Next, you can build Google Test and / or Google Mock and all desired tests. On
\*nix, this is usually done by \*nix, this is usually done by
```
make make
```
To run the tests, do To run the tests, do
```
make test make test
```
All tests should pass. All tests should pass.

View File

@ -152,11 +152,15 @@ GoogleTest is thread-safe where the pthread library is available. After
If GoogleTest doesn't correctly detect whether pthread is available in your If GoogleTest doesn't correctly detect whether pthread is available in your
environment, you can force it with environment, you can force it with
```
-DGTEST_HAS_PTHREAD=1 -DGTEST_HAS_PTHREAD=1
```
or or
```
-DGTEST_HAS_PTHREAD=0 -DGTEST_HAS_PTHREAD=0
```
When GoogleTest uses pthread, you may need to add flags to your compiler and/or When GoogleTest uses pthread, you may need to add flags to your compiler and/or
linker to select the pthread library, or you'll get link errors. If you use the linker to select the pthread library, or you'll get link errors. If you use the
@ -172,14 +176,18 @@ as a DLL on Windows) if you prefer.
To compile *gtest* as a shared library, add To compile *gtest* as a shared library, add
```
-DGTEST_CREATE_SHARED_LIBRARY=1 -DGTEST_CREATE_SHARED_LIBRARY=1
```
to the compiler flags. You'll also need to tell the linker to produce a shared to the compiler flags. You'll also need to tell the linker to produce a shared
library instead - consult your linker's manual for how to do it. library instead - consult your linker's manual for how to do it.
To compile your *tests* that use the gtest shared library, add To compile your *tests* that use the gtest shared library, add
```
-DGTEST_LINKED_AS_SHARED_LIBRARY=1 -DGTEST_LINKED_AS_SHARED_LIBRARY=1
```
to the compiler flags. to the compiler flags.
@ -200,7 +208,9 @@ rename its macro to avoid the conflict.
Specifically, if both GoogleTest and some other code define macro FOO, you can Specifically, if both GoogleTest and some other code define macro FOO, you can
add add
```
-DGTEST_DONT_DEFINE_FOO=1 -DGTEST_DONT_DEFINE_FOO=1
```
to the compiler flags to tell GoogleTest to change the macro's name from `FOO` to the compiler flags to tell GoogleTest to change the macro's name from `FOO`
to `GTEST_FOO`. Currently `FOO` can be `ASSERT_EQ`, `ASSERT_FALSE`, `ASSERT_GE`, to `GTEST_FOO`. Currently `FOO` can be `ASSERT_EQ`, `ASSERT_FALSE`, `ASSERT_GE`,
@ -208,10 +218,14 @@ to `GTEST_FOO`. Currently `FOO` can be `ASSERT_EQ`, `ASSERT_FALSE`, `ASSERT_GE`,
`EXPECT_FALSE`, `EXPECT_TRUE`, `FAIL`, `SUCCEED`, `TEST`, or `TEST_F`. For `EXPECT_FALSE`, `EXPECT_TRUE`, `FAIL`, `SUCCEED`, `TEST`, or `TEST_F`. For
example, with `-DGTEST_DONT_DEFINE_TEST=1`, you'll need to write example, with `-DGTEST_DONT_DEFINE_TEST=1`, you'll need to write
```
GTEST_TEST(SomeTest, DoesThis) { ... } GTEST_TEST(SomeTest, DoesThis) { ... }
```
instead of instead of
```
TEST(SomeTest, DoesThis) { ... } TEST(SomeTest, DoesThis) { ... }
```
in order to define a test. in order to define a test.