Commit Graph

164 Commits

Author SHA1 Message Date
Prashant Jaikumar
ce58a5972b Remove google internal links from documentation on github 2019-06-19 15:18:55 -07:00
Gennadiy Civil
b4676595c0 Incremental doc changes in preparation for doc sync 2019-06-19 17:04:47 -04:00
Gennadiy Civil
5ed950c9e3 Renaming doc files to make the file names more palatable and in preparation for including documentation in sync process 2019-06-19 16:48:38 -04:00
Gennadiy Civil
ac31db8fac small docs restucture and cleanup 2019-06-19 16:23:44 -04:00
Gennadiy Civil
ba68290cb3 small docs restucture and cleanup 2019-06-19 16:20:19 -04:00
Gennadiy Civil
176eccfb8f
Merge pull request #2287 from PhilLab/patch-1
docs/primer: Fixed usage of test case
2019-06-17 11:44:48 -04:00
Gennadiy Civil
fd20d1ecce
Merge pull request #2286 from gennadiycivil/master
Removing make and automake.
2019-06-17 11:05:13 -04:00
Philipp Hasper
b72b1bee95
docs/primer: Fixed usage of test case
According to the nomenclature, what was called a test case
is actually a test suite
2019-06-16 15:00:02 +02:00
Gennadiy Civil
e110929a7b Documentation sync working on the documentation being included with the code 2019-06-14 11:36:35 -04:00
Gennadiy Civil
38d967e889 doc is still valid 2019-06-13 16:48:25 -04:00
Gennadiy Civil
6b8c138154 Removing make and automake. The only supported build systems are Bazel internally and CMake community supported 2019-06-13 13:49:42 -04:00
Gennadiy Civil
fbcb2eb200 removing obsolete language from docs, CMake and Bazel is the only supporeted build methods 2019-06-10 10:51:41 -04:00
Gennadiy Civil
f71fb4f9a9
Update advanced.md
Adding back section that was lost in merge
2019-05-17 15:10:47 -04:00
Enji Cooper
67c75ff8ba Handle GTEST_SKIP() when calling Environment::SetUp()
gtest prior to this change would completely ignore `GTEST_SKIP()` if
called in `Environment::SetUp()`, instead of bailing out early, unlike
`Test::SetUp()`, which would cause the tests themselves to be skipped.
The only way (prior to this change) to skip the tests would be to
trigger a fatal error via `GTEST_FAIL()`.

Desirable behavior, in this case, when dealing with
`Environment::SetUp()` is to check for prerequisites on a system
(example, kernel supports a particular featureset, e.g., capsicum), and
skip the tests. The alternatives prior to this change would be
undesirable:

- Failing sends the wrong message to the test user, as the result of the
  tests is indeterminate, not failed.
- Having to add per-test class abstractions that override `SetUp()` to
  test for the capsicum feature set, then skip all of the tests in their
  respective SetUp fixtures, would be a lot of human and computational
  work; checking for the feature would need to be done for all of the
  tests, instead of once for all of the tests.

For those reasons, making `Environment::SetUp()` handle `GTEST_SKIP()`,
by not executing the testcases, is the most desirable solution.

In order to properly diagnose what happened when running the tests if
they are skipped, print out the diagnostics in an ad hoc manner.

Update the documentation to note this change and integrate a new test,
gtest_skip_in_environment_setup_test, into the test suite.

This change addresses #2189.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
2019-03-30 11:38:03 -07:00
Gennadiy Civil
d31151a493
Update googletest/docs/advanced.md
Co-Authored-By: antismap <michael.thenault@gmail.com>
2019-03-21 16:20:07 +01:00
antismap
f233360933
Note about INSTANTIATE_TEST_SUITE_P / INSTANTIATE_TEST_CASE_P keyword change
See https://github.com/google/googletest/issues/2065
2019-03-21 14:38:50 +01:00
Ryan Sinnet
d70cd4e358
Fix grammatical error in primer.md 2019-02-25 08:03:28 -08:00
Keiichi Watanabe
b3679d8565 Fix an invalid example of JSON report in advanced.md
This is just a mistake in the document. Google Test doesn't output
such an invalid JSON report.

Signed-off-by: Keiichi Watanabe <keiichiw@chromium.org>
2019-02-05 21:05:16 +09:00
Gennadiy Civil
acde02c635
Repeat #2090
Testing
2019-01-30 14:44:27 -05:00
Gennadiy Civil
5d3a2cd9c8 Update docs, TestCase->TestSuite 2019-01-03 17:18:03 -05:00
Gennadiy Civil
7b6b3be342
Update advanced.md
Fixes #1802
2018-10-23 17:27:38 -04:00
Gennadiy Civil
40f82ce56a
Update primer.md
fixes #1709
2018-10-05 16:23:08 -04:00
Arkady Shapkin
e6c407d605 Fix doc links 2018-09-04 23:07:18 +03:00
Gennadiy Civil
3787a483b9
Merge pull request #1803 from KindDragon/patch-2
Update documentation to syntax highlight code
2018-09-04 10:56:49 -04:00
Andrew Siplas
70a7017582 Fix #1805: add .md to hyperlink 2018-09-03 22:13:52 -04:00
Arkady Shapkin
de9675986f Update documentation to syntax highlight code 2018-09-03 21:56:23 +03:00
Steven Santos Erenst
ca912f8b70
Fix broken FAQ link in primer.md
The current link pointed to a non existing section in the FAQ.
2018-08-28 21:03:19 -07:00
Vadim Kotov
ddc618ab31
docs: fix more broken links to sections in Advanced guide 2018-08-20 16:20:14 +03:00
Vadim Kotov
02c4f1af9d
docs: fixed broken references to sections in Advanced guide 2018-08-20 15:31:55 +03:00
Vadim Berezniker
0796415314 std references shouldn't be fully qualified 2018-08-17 10:49:10 -07:00
Yi Zheng
ecc241900a - Fix the broken markdown table
- Fix some format issue
2018-08-13 17:57:51 +08:00
Wiktor Garbacz
db43df6df7 docs: fix broken links 2018-08-09 13:14:36 +02:00
Piotr Kąkol
309e8a271e Updated broken and outdated URLs 2018-07-25 19:19:26 +02:00
Stian Valle
bb9fc6f66e
Update primer.md 2018-07-21 15:50:45 +02:00
Stian Valle
7abf99d941
Update primer.md 2018-07-21 15:40:57 +02:00
Stian Valle
baf2115a59
Update primer.md 2018-07-21 15:29:58 +02:00
Gennadiy Civil
20ef7944a4
Merge pull request #1667 from hckr/patch-1
Fix broken links to FAQ in primer.md
2018-07-18 10:21:46 -04:00
Gennadiy Civil
5437926b22 Docs sync 2018-07-17 17:47:25 -04:00
Jakub Młokosiewicz
021c308069
Fix broken links to FAQ in primer.md 2018-07-17 00:49:31 +02:00
Gennadiy Civil
36066cfecf more formatting [skip ci] 2018-07-11 09:42:48 -04:00
Gennadiy Civil
74cccf494a formatting, [ci skip] 2018-07-11 09:38:47 -04:00
Gennadiy Civil
4f9194286c Fix heading
[skip ci]
2018-07-10 17:30:28 -04:00
Gennadiy Civil
50daf299c2 Docs sync
[ci skip]
2018-07-10 17:16:03 -04:00
Gennadiy Civil
3847aecb5f Docs sync/internal 2018-06-13 14:29:26 -04:00
Gennadiy Civil
6a484baf06 Doc sync/internal 2018-06-13 14:26:24 -04:00
Gennadiy Civil
0b958a03e9 Removed "Documentation.md" not adding value and not consitent with internal docs 2018-06-11 12:07:45 -04:00
Gennadiy Civil
109f848bc8 Rename Samples.md to samples.md and adjust the links 2018-06-11 11:54:27 -04:00
Gennadiy Civil
4490be8789 Rename FAQ.md to faq.md and adjust the links.
Part of documentation rationalization
2018-06-11 11:49:02 -04:00
Gennadiy Civil
8f87d00398 Rename AdvancedGuide.md to advanced.md and adjust the links.
Part of documentation rationalization work
2018-06-11 11:40:35 -04:00
Gennadiy Civil
de47b0d30c Rename "Primer.md" to "primer.md" and adjust links. Part of the documentaion rationalzation 2018-06-11 11:26:16 -04:00
Petr Hosek
6baf17e9d1 Support JSON output format in addition to XML
This change allows emitting output in JSON format in addition to the
already supported XML format. The implementation as well as the file
structure is intentionally modelled after the XML one.
2018-02-28 00:48:41 -08:00
Aleksey Kozin
06568301ec
TEST() arguments are invalid in an example
Both names must be valid C++ identifiers, and they should not contain underscore (`_`)
2018-02-23 01:34:26 +03:00
Gennadiy Civil
b324a36c35
Merge branch 'master' into assert 2018-02-09 11:42:05 -05:00
Troy Holsapple
c8510504dd Fixed typos 2018-02-07 22:06:00 -08:00
Alexey Sokolov
092d088533 Add ability to throw from ASSERT
while not losing benefits of EXPECT, and not killing the whole test,
as with --gtest_throw_on_failure.

183822976
2018-02-08 01:15:42 +00:00
LI Daobing
efd49c2d45
Update Documentation.md 2018-01-26 15:36:57 +08:00
Gennadiy Civil
e29805aa5d upstream cl 182543808 2018-01-24 13:04:36 -05:00
Fedor Trushkin
8e862211a2 Use fully qualified in examples 2018-01-18 10:38:25 +01:00
Fedor Trushkin
354fc8d8b1 Document ScopedTrace utility 2018-01-18 10:34:05 +01:00
Carlos O'Ryan
23a014ab57
Refactor docs about contributions to CONTRIBUTING.md.
Per the review comments.
2017-12-11 19:33:27 -05:00
Herbert Thielen
8866af0386 remove markdown stars (bold) from code examples 2017-10-29 17:12:00 +01:00
Jonathan Wakely
b70cf1a663 Use gender-neutral pronouns in comments and docs 2017-09-27 13:31:13 +01:00
Gennadiy Civil
836c194a81 Merge pull request #1241 from aninf-wo/hethi/issue-635-old-links
change links from former code.google.com to current github repository
2017-08-31 18:28:19 -04:00
Herbert Thielen
e033d8c73d change links from former code.google.com to current github repository 2017-08-31 18:12:17 +02:00
Herbert Thielen
14cf7f574a fix example's comment 2017-08-31 16:10:36 +02:00
Gennadiy Civil
fa70b84ab5 Removed "Trivial"
Who knows? may not be very trivial given the code drift between internal and OSS
2017-08-30 14:51:36 -04:00
Gennadiy Civil
c4e01616af removed internal link ( not allowed in OSS) 2017-08-30 14:50:40 -04:00
Scott Graham
0eb49f4d6b Note that it is preferable for Googlers to create a CL internally first 2017-08-30 11:29:06 -07:00
Herbert Thielen
f0c72bfe09 fix SetUp/TearDownTestCase() in AdvancedGuide
fixes issue #1087
2017-08-30 12:19:59 +02:00
David Seifert
9cacce4e5c Add documentation for pkg-config 2017-08-14 13:45:56 +02:00
Gennadiy Civil
c81be0f6fc Merge pull request #871 from tommyleo2/master
Update Primer.md
2017-08-10 21:34:15 -04:00
Gennadiy Civil
c822c85659 Merge pull request #1164 from aninf-wo/hethi/remove-old-docs
remove documentation of former versions - it's available in the commit history
2017-08-10 21:19:03 -04:00
Gennadiy Civil
cfab28d594 Merge pull request #1192 from eduherminio/master
Minor style fixes
2017-08-10 20:36:29 -04:00
Herbert Thielen
dc7214f222 say "former version" instead of "released version" 2017-08-10 20:21:46 +02:00
Eduardo Caceres
854b28f199 Minor style fixes
Typos, punctuation & broken links
2017-08-10 18:05:32 +02:00
Gennadiy Civil
75f0723c45 Merge pull request #1178 from aninf-wo/hethi/testsuite-hint
add note about different definitions of Test Case
2017-08-10 09:13:45 -04:00
Herbert Thielen
c09e9e646d clarify distinction regarding Test Case 2017-08-10 10:08:08 +02:00
Herbert Thielen
33edcaed89 be more specific on Test Case 2017-08-09 16:41:38 +02:00
Eduardo Cáceres
67fcf00703 Punctuation
Missing periods
2017-08-09 14:10:23 +02:00
Herbert Thielen
e022dcded8 Merge branch 'master' into hethi/remove-old-docs 2017-08-09 11:03:27 +02:00
Gennadiy Civil
40aa72c7dc Merge pull request #675 from theHacker/master
Fix: Markdown in V1_7_Primer.md
2017-08-08 11:53:40 -04:00
Gennadiy Civil
22d1a7a1a7 Merge pull request #909 from AsturaPhoenix/patch-1
Update Primer.md
2017-08-07 23:01:42 -04:00
Herbert Thielen
0f702cebb0 add note about different definitions of Test Case
There are contradictory definitions of the term "test case", so prepare
new users in Primer.md to avoid confusion.
2017-08-05 15:12:12 +02:00
Gennadiy Civil
e1f3d8d175 Merge pull request #671 from mehagar/patch-1
Fix typo in AdvancedGuide.md
2017-08-02 17:07:27 -04:00
Gennadiy Civil
0cb2eeb5f1 Merge pull request #764 from flyd1005/wip-fix-typo
remove duplicated words
2017-08-02 17:04:33 -04:00
Gennadiy Civil
d966d5fbe0 Merge pull request #968 from nicolacavallini/link_typed_test_docs
added link to sample 6 in the  documentation of typed test
2017-08-02 16:45:13 -04:00
Herbert Thielen
ec19d455bc fix links to Google C++ Style Guide 2017-07-30 17:05:48 +02:00
Herbert Thielen
b3908406e6 remove doc of former versions
The documentation of former versions is available in the history (e.g.
by checking out the appropriate git tags), so there is no need to keep
them in parallel to the current documentation.
2017-07-30 16:26:29 +02:00
Herbert Thielen
f6ac9a30a4 remove obsolete reference to SVN trunk 2017-07-30 16:25:58 +02:00
Gennadiy Civil
6527ee0624 Merge pull request #1107 from lipk/patch-1
Minor grammar fix in docs.
2017-07-26 15:29:54 -04:00
Vincent Palancher
4568374a6e Fixes a typo in FAQ.md 2017-07-05 14:12:58 +02:00
jorgehb
00ed9b566e Fixing float comparison broken link
Updating the link with a valid one. The old one was considered obsolete by the publisher.
2017-06-08 10:01:55 -04:00
lipk
dca9d5fc51 Remove unnecessary 'the'. 2017-05-30 17:29:32 +02:00
nicolacavallini
2eaab21554 added link to sample 6 in the documentation of typed test 2016-12-23 11:45:08 +01:00
Ross Wang
0b6d947517 Update Primer.md
Correcting typo: "text fixture" => "test fixture"
2016-10-18 13:56:03 -07:00
tommyleo2
82396f2d54 Update Primer.md
fix bug in string comparison assertions table where _str2_ is mistakenly written as _str_2
2016-09-02 19:45:48 +08:00
Li Peng
266a185a52 remove duplicated words
Signed-off-by: Li Peng <lip@dtdream.com>
2016-04-27 16:41:27 +08:00
Manuel Binna
207147495c Fix whitespace in paragraph 2016-03-16 06:49:57 +01:00
Paul Wilkinson
83d3b47acf Fix formatting in AdvancedGuide.md
Put occurrences of "#include" in a code span so they are not interpreted
as headers.

Other documents were not broken because the #include was not at the
start of the line, but put them in code spans anyway just in case the
text gets refilled in the future.
2016-02-21 15:52:09 +00:00
Alexey Sokolov
f364e18837 Change error message of EXPECT_EQ to treat lhs and rhs equivalently. 2016-02-16 23:32:01 +00:00