[Mockpp-commits] mockpp/mockpp/docs/en appendix.docbook,1.19,1.20 dev_embedded.docbook,1.10,1.11
Brought to you by:
ewald-arnold
Menu
▾
▴
[Mockpp-commits] mockpp/mockpp/docs/en appendix.docbook,1.19,1.20 dev_embedded.docbook,1.10,1.11
|
From: Ewald A. <ewa...@us...> - 2006-01-05 20:17:19
|
Update of /cvsroot/mockpp/mockpp/mockpp/docs/en In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv22489/mockpp/docs/en Modified Files: appendix.docbook dev_embedded.docbook Log Message: update docs Index: appendix.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/appendix.docbook,v retrieving revision 1.19 retrieving revision 1.20 diff -u -d -r1.19 -r1.20 --- appendix.docbook 5 Jan 2006 19:13:55 -0000 1.19 +++ appendix.docbook 5 Jan 2006 20:17:11 -0000 1.20 @@ -137,6 +137,32 @@ <!-- ===================================== --> +<sect2 id="installing-cygwin"> +<title>Installing on systems using Cygwin</title> + +<para>There have been reports about problems to compile and link +with &cppunit; on Windows system under &cygwin;. A solution might be to be to link +statically. First compile &cppunit; (and possibly force installation with -k): +</para> + +<screen width="40"> + <prompt>%</prompt> <userinput>./configure --disable-shared</userinput> + <prompt>%</prompt> <userinput>make check</userinput> + <prompt>%</prompt> <userinput>make -k install</userinput> +</screen> + +<para>Then install &mockpp;:</para> + +<screen width="40"> + <prompt>%</prompt> <userinput>./configure --disable-shared</userinput> + <prompt>%</prompt> <userinput>make check</userinput> + <prompt>%</prompt> <userinput>make install</userinput> +</screen> + +</sect2> + +<!-- ===================================== --> + <sect2 id="creating-rpms"> <title>Creating and Installing an RPM</title> @@ -185,52 +211,92 @@ <varlistentry> <term><literal>MOCKPP_UNICODE</literal></term> - <listitem>Enable unicode characters (based on <token>wchar_t</token>) instead + <listitem><para>Enable unicode characters (based on <token>wchar_t</token>) instead of ascii characters.There are some related macros. <literal>MOCKPP_PCHAR</literal> - is used to mark literal character strings either with or without leading "L". - <literal>MOCPP_STRING</literal> is used to create a <token>String</token> variable. - </listitem> + <literal>MOCKPP_CHAR</literal> are used to mark literal character strings + either with or without leading "L". + <literal>MOCKPP_STRING</literal> and <literal>MOCKPP_PCSTRING</literal> are + used to create a <token>String</token> variable. + </para></listitem> </varlistentry> <varlistentry> <term><literal>MOCKPP_EXPORT</literal></term> - <listitem>Some platforms export only explicitly tagged elements in dynamic + <listitem><para>Some platforms export only explicitly tagged elements in dynamic libraries. Other elements can't be linked from other binaries. This macro - hides such an export declaration. + hides such an export declaration.</para> </listitem> </varlistentry> + <varlistentry> + <term><literal>MOCKPP_USE_MINI_STL</literal></term> + <listitem><para>Use the built-in alternative STL implementation instead of the + STL that come with the C++ compiler to try to save memory resources. + In this case <literal>CXXTEST_USE_MINI_STL</literal> should also be defined + if you use &cxxtest;.</para> + <para>If you want to use another STL you have to extend the according section + in <filename>mockpp.h</filename>. Search for <literal>MOCKPP_USE_MINI_STL</literal> + and add an appropriate section similar to the one for + <literal>ministl</literal>.</para> + </listitem> + </varlistentry> -</variablelist> + <varlistentry> + <term><literal>MOCKPP_NO_RTTI</literal></term> + <listitem><para>Disable all features that are based on runtime type information + to reduce the library size.</para> + </listitem> + </varlistentry> -MOCKPP_BOUNDARY_DELTA + <varlistentry> + <term><literal>MOCKPP_NO_EXCEPTIONS</literal></term> + <listitem><para>Disable exception handling to reduce the library size. If you do not + use the built-in &cxxtest; you probably need to adjust the handling of failures. + See <xref linkend="no-exceptions" /> for a list of the according macros.</para> + </listitem> + </varlistentry> -MOCKPP_USE_MINI_STL -CXXTEST_USE_MINI_STL -MOCKPP_STL -MOCKPP_STRING_H -MOCKPP_VECTOR_H -MOCKPP_MAP_H -MOCKPP_SET_H -MOCKPP_FUNCTION_H -MOCKPP_ALGORITHM_H + <varlistentry> + <term><literal>MOCKPP_USE_CPPUNIT</literal></term> + <listitem><para>Use &cppunit; as framework for fow control.</para> + </listitem> + </varlistentry> -MOCKPP_ALTERNATIVE_STL + <varlistentry> + <term><literal>MOCKPP_USE_CXXTEST</literal></term> + <listitem><para>Use &cxxtest; as framework for fow control.</para> + </listitem> + </varlistentry> -MOCKPP_USE_CPPUNIT -MOCKPP_USE_CXXTEST -MOCKPP_USE_BOOSTTEST + <varlistentry> + <term><literal>MOCKPP_USE_BOOSTTEST</literal></term> + <listitem><para>Use &boost.test; as framework for fow control.</para> + </listitem> + </varlistentry> -MOCKPP_NO_RTTI + <varlistentry> + <term><literal>MOCKPP_BOUNDARY_DELTA</literal></term> + <listitem><para>Include source code for + <function>ExpectationBoundary::setExpectedDelta()</function></para>. + </listitem> + </varlistentry> -MOCKPP_NO_EXCEPTIONS -MOCKPP_THROW(x) -MOCKPP_RETHROW -MOCKPP_TRY -MOCKPP_CATCH(x) -MOCKPP_CATCH_ALL + <varlistentry> + <term><literal>MOCKPP_USE_STD_EXCEPTION</literal></term> + <listitem><para>Derive <classname>mockpp::Exception</classname> + from <classname>std::exception</classname></para>. + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>MOCKPP_MAKE_CHAR_READABLE</literal></term> + <listitem><para>Display non-printable characters in a more readable form.</para> + </listitem> + </varlistentry> +</variablelist> +There are more predefined options of less interest in <filename>mockpp.h</filename>. </para> @@ -242,30 +308,6 @@ </sect2> -<sect2 id="installing-cygwin"> -<title>Installing on systems using Cygwin</title> - -<para>There have been reports about problems to compile and link -with &cppunit; on Windows system under &cygwin;. A solution might be to be to link -statically. First compile &cppunit; (and possibly force installation with -k): -</para> - -<screen width="40"> - <prompt>%</prompt> <userinput>./configure --disable-shared</userinput> - <prompt>%</prompt> <userinput>make check</userinput> - <prompt>%</prompt> <userinput>make -k install</userinput> -</screen> - -<para>Then install &mockpp;:</para> - -<screen width="40"> - <prompt>%</prompt> <userinput>./configure --disable-shared</userinput> - <prompt>%</prompt> <userinput>make check</userinput> - <prompt>%</prompt> <userinput>make install</userinput> -</screen> - -</sect2> - </sect1> </appendix> Index: dev_embedded.docbook =================================================================== RCS file: /cvsroot/mockpp/mockpp/mockpp/docs/en/dev_embedded.docbook,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- dev_embedded.docbook 28 Dec 2005 09:23:30 -0000 1.10 +++ dev_embedded.docbook 5 Jan 2006 20:17:11 -0000 1.11 @@ -105,7 +105,7 @@ machine with high speed very often whereas the complete tests are run on the target device only if appropriate.</para> -<para>Without exceptions you have to provide a way to forward the messages +<para id="no-exceptions">Without exceptions you have to provide a way to forward the messages about the malfunction. &mockpp; uses some macros to run the built-in tests with or without exceptions using the same source files. When exceptions are enabled theses macros contain what you probably expect: |
