summaryrefslogtreecommitdiffstats
path: root/googletest/include/gtest/internal/custom
diff options
context:
space:
mode:
authorGennadiy Civil <misterg@google.com>2018-08-13 14:31:56 -0400
committerGennadiy Civil <misterg@google.com>2018-08-13 14:31:56 -0400
commit63baab8924f589fdfd934ae24613e59f8d3ef635 (patch)
treeedbe727cf93c2ed7ae838f78f73ef5a1daf26064 /googletest/include/gtest/internal/custom
parent18c940d13a58a3fa1016d2887e66bd1c73720e0f (diff)
downloadgoogletest-63baab8924f589fdfd934ae24613e59f8d3ef635.tar.gz
googletest-63baab8924f589fdfd934ae24613e59f8d3ef635.zip
Move instructions into custom/README files
Diffstat (limited to 'googletest/include/gtest/internal/custom')
-rw-r--r--googletest/include/gtest/internal/custom/README.md56
-rw-r--r--googletest/include/gtest/internal/custom/gtest-port.h35
-rw-r--r--googletest/include/gtest/internal/custom/gtest-printers.h4
-rw-r--r--googletest/include/gtest/internal/custom/gtest.h10
4 files changed, 60 insertions, 45 deletions
diff --git a/googletest/include/gtest/internal/custom/README.md b/googletest/include/gtest/internal/custom/README.md
new file mode 100644
index 00000000..e39b7c6e
--- /dev/null
+++ b/googletest/include/gtest/internal/custom/README.md
@@ -0,0 +1,56 @@
+# Customization Points
+
+The custom directory is an injection point for custom user configurations.
+
+## Header gtest.h
+
+### The following macros can be defined:
+
+* GTEST_OS_STACK_TRACE_GETTER_ - The name of an implementation of
+ OsStackTraceGetterInterface.
+* GTEST_CUSTOM_TEMPDIR_FUNCTION_ - An override for testing::TempDir(). See
+ testing::TempDir for semantics and signature.
+
+## Header gtest-port.h
+
+The following macros can be defined:
+
+### Flag related macros:
+
+* GTEST_FLAG(flag_name)
+* GTEST_USE_OWN_FLAGFILE_FLAG_ - Define to 0 when the system provides its own
+ flagfile flag parsing.
+* GTEST_DECLARE_bool_(name)
+* GTEST_DECLARE_int32_(name)
+* GTEST_DECLARE_string_(name) *
+* GTEST_DEFINE_bool_(name, default_val, doc)
+* GTEST_DEFINE_int32_(name, default_val, doc)
+* GTEST_DEFINE_string_(name, default_val, doc)
+
+### Logging:
+
+* GTEST_LOG_(severity)
+* GTEST_CHECK_(condition)
+* Functions LogToStderr() and FlushInfoLog() have to be provided too.
+
+### Threading:
+
+* GTEST_HAS_NOTIFICATION_ - Enabled if Notification is already provided.
+* GTEST_HAS_MUTEX_AND_THREAD_LOCAL_ - Enabled if Mutex and ThreadLocal are
+ already provided. Must also provide GTEST_DECLARE_STATIC_MUTEX_(mutex) and
+ GTEST_DEFINE_STATIC_MUTEX_(mutex)
+* GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
+* GTEST_LOCK_EXCLUDED_(locks)
+
+### Underlying library support features
+
+* GTEST_HAS_CXXABI_H_
+
+### Exporting API symbols:
+
+* GTEST_API_ - Specifier for exported symbols.
+
+## Header gtest-printers.h
+
+* See documentation at gtest/gtest-printers.h for details on how to define a
+ custom printer.
diff --git a/googletest/include/gtest/internal/custom/gtest-port.h b/googletest/include/gtest/internal/custom/gtest-port.h
index aa5da295..cd85d956 100644
--- a/googletest/include/gtest/internal/custom/gtest-port.h
+++ b/googletest/include/gtest/internal/custom/gtest-port.h
@@ -27,40 +27,7 @@
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
-// Injection point for custom user configurations.
-// The following macros can be defined:
-//
-// Flag related macros:
-// GTEST_FLAG(flag_name)
-// GTEST_USE_OWN_FLAGFILE_FLAG_ - Define to 0 when the system provides its
-// own flagfile flag parsing.
-// GTEST_DECLARE_bool_(name)
-// GTEST_DECLARE_int32_(name)
-// GTEST_DECLARE_string_(name)
-// GTEST_DEFINE_bool_(name, default_val, doc)
-// GTEST_DEFINE_int32_(name, default_val, doc)
-// GTEST_DEFINE_string_(name, default_val, doc)
-//
-// Logging:
-// GTEST_LOG_(severity)
-// GTEST_CHECK_(condition)
-// Functions LogToStderr() and FlushInfoLog() have to be provided too.
-//
-// Threading:
-// GTEST_HAS_NOTIFICATION_ - Enabled if Notification is already provided.
-// GTEST_HAS_MUTEX_AND_THREAD_LOCAL_ - Enabled if Mutex and ThreadLocal are
-// already provided.
-// Must also provide GTEST_DECLARE_STATIC_MUTEX_(mutex) and
-// GTEST_DEFINE_STATIC_MUTEX_(mutex)
-//
-// GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
-// GTEST_LOCK_EXCLUDED_(locks)
-//
-// Underlying library support features:
-// GTEST_HAS_CXXABI_H_
-//
-// Exporting API symbols:
-// GTEST_API_ - Specifier for exported symbols.
+// Injection point for custom user configurations. See README for details
//
// ** Custom implementation starts here **
diff --git a/googletest/include/gtest/internal/custom/gtest-printers.h b/googletest/include/gtest/internal/custom/gtest-printers.h
index 60c1ea05..eb4467ab 100644
--- a/googletest/include/gtest/internal/custom/gtest-printers.h
+++ b/googletest/include/gtest/internal/custom/gtest-printers.h
@@ -31,8 +31,8 @@
// installation of gTest.
// It will be included from gtest-printers.h and the overrides in this file
// will be visible to everyone.
-// See documentation at gtest/gtest-printers.h for details on how to define a
-// custom printer.
+//
+// Injection point for custom user configurations. See README for details
//
// ** Custom implementation starts here **
diff --git a/googletest/include/gtest/internal/custom/gtest.h b/googletest/include/gtest/internal/custom/gtest.h
index 6f7c5e40..4c8e07be 100644
--- a/googletest/include/gtest/internal/custom/gtest.h
+++ b/googletest/include/gtest/internal/custom/gtest.h
@@ -27,15 +27,7 @@
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
-// Injection point for custom user configurations.
-// The following macros can be defined:
-//
-// GTEST_OS_STACK_TRACE_GETTER_ - The name of an implementation of
-// OsStackTraceGetterInterface.
-//
-// GTEST_CUSTOM_TEMPDIR_FUNCTION_ - An override for testing::TempDir().
-// See testing::TempDir for semantics and
-// signature.
+// Injection point for custom user configurations. See README for details
//
// ** Custom implementation starts here **
OpenPOWER on IntegriCloud