summaryrefslogtreecommitdiff
path: root/ossig.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2017-03-10 03:14:43 -0500
committerJeffrey Walton <noloader@gmail.com>2017-03-10 03:14:43 -0500
commit75a379593d7d94372ccce72a361a6b633bd3360c (patch)
tree11eb002a1936138cf6c6440e661f68f6c88bc1b0 /ossig.h
parenta0bb490056396233363c8822903fead429f7ef5b (diff)
downloadcryptopp-git-75a379593d7d94372ccce72a361a6b633bd3360c.tar.gz
Updated documentation
Diffstat (limited to 'ossig.h')
-rw-r--r--ossig.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/ossig.h b/ossig.h
index 2e39ea2b..4a47fed0 100644
--- a/ossig.h
+++ b/ossig.h
@@ -46,6 +46,10 @@ extern "C" {
//! using sigaction flags set to 0. The default handler only returns from the call.
//! \details Upon destruction the previous signal handler is restored if the former signal handler
//! was replaced.
+//! \details On Cygwin systems using Newlib, you need to ensure you define <tt>_XOPEN_SOURCE=700</tt>,
+//! <tt>_GNU_SOURCE</tt>; or use <tt>-std=gnu++03</tt>, <tt>-std=gnu++11</tt>, or similar. If
+//! you compile with <tt>-std=c++03</tt>, <tt>-std=c++11</tt> or similar, then define
+//! <tt>_XOPEN_SOURCE=700</tt>.
//! \warning Do not use SignalHandler in a code block that uses <tt>setjmp</tt> or <tt>longjmp</tt>
//! because the destructor may not run.
//! \since Crypto++ 5.6.5
@@ -63,6 +67,10 @@ struct SignalHandler
//! using sigaction flags set to 0. The default handler only returns from the call.
//! \details Upon destruction the previous signal handler is restored if the former signal handler
//! was overwritten.
+ //! \details On Cygwin systems using Newlib, you need to ensure you define <tt>_XOPEN_SOURCE=700</tt>,
+ //! <tt>_GNU_SOURCE</tt>; or use <tt>-std=gnu++03</tt>, <tt>-std=gnu++11</tt>, or similar. If
+ //! you compile with <tt>-std=c++03</tt>, <tt>-std=c++11</tt> or similar, then define
+ //! <tt>_XOPEN_SOURCE=700</tt>.
//! \warning Do not use SignalHandler in a code block that uses <tt>setjmp</tt> or <tt>longjmp</tt>
//! because the destructor may not run. <tt>setjmp</tt> is why cpu.cpp does not use SignalHandler
//! during CPU feature testing.