Changeset 3602

Timestamp:

Jan 22, 2017, 2:36:48 PM (6 years ago)

Author:

Peter

Message:

doc how to turn on cxx11 features. closes #878

File:

• trunk/README (modified) (1 diff)

trunk/README

@@ -152 +152 @@
   #> ./configure LDFLAGS="-L/usr/lib64/atlas"
 
-=== Rvalues ===
-
-The configure script tries to find a modern compiler that understands
-rvalues and move semantics, and turns on switches such as '-std=c++11'
-if needed. This search can be turned off by invoking
-
-  #> ./configure --without-cxx11
-
-If a compiler with rvalue support is found, macro YAT_HAVE_RVALUE is
-#defined in 'config.h' and move constructors and move assignments is
-available for certain classes plus that moves are used internally. If
-yat is built with rvalue support, yat's header are not compatible with
-a compiler that lack the support. Packages that use autoconf you can
-use macro YAT_CXX_RVALUE, defined in 'm4/yat_cxx11', to turn on
-the compiler switch in the same fashion as yat's
-configure. Alternatively, yat's choice of compiler with needed
-switches can be accessed via `yat-config --cxx`. If necessary, you can
-turn off rvalue support completely by compiling your program with the
-preprocessor definition YAT_WITHOUT_CXX11.
+=== C++11 Features ===
+
+If enabled, yat uses C++11 features such as rvalues and std::atomic,
+which make the library faster and safer. To turn on these features you
+need to configure yat with option
+
+  #> ./configure --enable-cxx11
+
+This will make the configure script test if the compiler supports
+these features, and, if nessecary, add options such as -std=cxx11. If
+the search is sucessful corresponding macro is defined in file
+'yat/utility/config_public.h'. If you want to use these features in
+your own code, you need turn them on by setting preproccessor
+definition YAT_WITH_CXX11 (and of course make sure the compiler
+supports them).
 
 === Doxygen ===