From b6a296d0f7caff7140f422e49f5398c9ef17504d Mon Sep 17 00:00:00 2001 From: shiqian Date: Mon, 17 Nov 2008 22:57:44 +0000 Subject: Clarifies how gtest supports different platforms in README and code comments. --- README | 29 +++++++++++++++++++++-------- include/gtest/internal/gtest-port.h | 7 +++++++ 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/README b/README index 865ac69..9cf673c 100644 --- a/README +++ b/README @@ -5,7 +5,7 @@ http://code.google.com/p/googletest/ Overview -------- Google's framework for writing C++ tests on a variety of platforms (Linux, Mac -OS X, Windows, Windows CE, and Symbian). Based on the xUnit architecture. +OS X, Windows, Windows CE, Symbian, and etc). Based on the xUnit architecture. Supports automatic test discovery, a rich set of assertions, user-defined assertions, death tests, fatal and non-fatal failures, various options for running the tests, and XML test report generation. @@ -16,12 +16,15 @@ OFTC (irc.oftc.net) #gtest available. Please join us! Requirements ------------ -Google Test is designed to have fairly minimal requirements to build and use -with your projects, but there are some. Currently, the only Operating System -(OS) on which Google Test is known to build properly is Linux, but we are -actively working on Windows and Mac support as well. The source code itself is -already portable across many other platforms, but we are still developing -robust build systems for each. +Google Test is designed to have fairly minimal requirements to build +and use with your projects, but there are some. Currently, we support +building Google Test on Linux, Windows, Mac OS X, and Cygwin. We will +also make our best effort to support other platforms (e.g. Solaris and +IBM z/OS). However, since core members of the Google Test project +have no access to them, Google Test may have outstanding issues on +these platforms. If you notice any problems on your platform, please +notify googletestframework@googlegroups.com (patches for fixing them +are even more welcome!). ### Linux Requirements ### These are the base requirements to build and use Google Test from a source @@ -207,9 +210,19 @@ in the "Variables to be set in the environment:" list, where you replace when you run your executable, it will load the framework and your test will run as expected. +### Using Your Own Build System ### +If none of the build solutions we provide works for you, or if you +prefer your own build system, you just need to compile +src/gtest-all.cc into a library and link your tests with it. Assuming +a Linux-like system and gcc, something like the following will do: + + $ cd ${SRCDIR} + $ g++ -I. -I./include -c src/gtest-all.cc + $ ar -rv libgtest.a gtest-all.o + $ g++ -I. -I./include path/to/your_test.cc libgtest.a -o your_test + Regenerating Source Files ------------------------- - Some of Google Test'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 diff --git a/include/gtest/internal/gtest-port.h b/include/gtest/internal/gtest-port.h index c7aba87..5277056 100644 --- a/include/gtest/internal/gtest-port.h +++ b/include/gtest/internal/gtest-port.h @@ -75,6 +75,13 @@ // GTEST_OS_WINDOWS - defined iff compiled on Windows. // GTEST_OS_ZOS - defined iff compiled on IBM z/OS. // +// Among the platforms, Cygwin, Linux, Max OS X, and Windows have the +// most stable support. Since core members of the Google Test project +// don't have access to other platforms, support for them may be less +// stable. If you notice any problems on your platform, please notify +// googletestframework@googlegroups.com (patches for fixing them are +// even more welcome!). +// // Note that it is possible that none of the GTEST_OS_ macros are defined. // // Macros indicating available Google Test features: -- cgit v0.12