diff options
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/index.qdoc | 2 | ||||
-rw-r--r-- | doc/src/messaging.qdoc | 96 |
2 files changed, 0 insertions, 98 deletions
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc index 3402a28f..9f2caa9e 100644 --- a/doc/src/index.qdoc +++ b/doc/src/index.qdoc @@ -22,8 +22,6 @@ \o \list \o \l {Messaging}{Introduction} - \o \l {Building and Compiling}{Building and Running} - \o \l {Testing the Messaging Framework}{Test Results} \o \l {Changes Between Messaging Framework Versions} \o \l {Messaging Framework Client Library#Examples}{Examples} \endlist diff --git a/doc/src/messaging.qdoc b/doc/src/messaging.qdoc index 39461e1c..e225e06a 100644 --- a/doc/src/messaging.qdoc +++ b/doc/src/messaging.qdoc @@ -48,102 +48,6 @@ For detailed information refer to: \o \l{Messages Client}{Messages client application} \endlist -\section1 Building and Compiling - -To build the Messaging Framework, ensure qt4, zlib and libicu development packages are installed, and run \c qmake on the top level \c messagingframework.pro file as follows: - -\code -qmake "QMF_INSTALL_ROOT=<image directory path>" messagingframework.pro -\endcode - -Where \c <image \c directory \c path> is the location that \c make \c install will put the resultant binary files. It is optional but -desirable to set this variable as it is not possible to run the applications from within their build directories due -to dependencies. The \c debug configuration parameter is also optional. - -Following this simply run: - -\code -make -make install -\endcode - -It is also recommended to build in a separate path to the source tree. This is just a matter -of running the above commands from within a separate build directory. - -\bold Note: If there are build errors referring to valgrind (tst_messageserver), please ensure that valgrind development headers are installed, -or optionally remove unwanted tests from the messagingframework.pro. - -\bold Note: By default the QMF libraries, messageserver and protocol plugins depend on the QtGui library. This is so that protocol plugins (e.g. IMAP/SMTP/POP) can provide GUI account editors. To remove this dependency use the define QMF_NO_MESSAGE_SERVICE_EDITOR e.g: -\code -qmake -r messagingframework.pro DEFINES+=QMF_NO_MESSAGE_SERVICE_EDITOR -\endcode - -\bold Note: By default QMF operations on the message store are atomic and durable, so long as the underlying OS supports durable writes, e.g. on Linux based systems so long as fsync makes durable writes. Atomic means all of an operation such as a delete/update/add take effect or none of it does. Durable means once an operation is reported to have succeeded it will survive permanently even in the event of a system crash. Ensuring these properties has a considerable performance cost. To increase performance both durability and atomicity can be disabled using the define QMF_NO_DURABILITY e.g.: -\code -qmake -r messagingframework.pro DEFINES+=QMF_NO_DURABILITY -\endcode - -\section1 Running Messaging Framework - -After \c{make install} has run, the following layout should exist in your image directory: - -\code -bin -include -lib -tests -\endcode - -The binary files \c messageserver and \c qtmail and \c messagingaccounts should be located in the \c bin directory. -Set the following evironment variables prior to running these files: - -\code -PATH=<imagedir/bin>:$PATH -LD_LIBRARY_PATH=<imagedir/lib>:$LD_LIBRARY_PATH -QMF_PLUGINS=<imagedir/lib/qmf/plugins> -\endcode - -Optionally set \c QMF_DATA to the location where you want the framework data files stored. If this is not set, the -default of \c $HOME/.qmf will be used. - -\bold Note: When running the example client application \c qtmail, if the \c messageserver is not already running it will be started as -a child process of the application, whose output is not visible. If you prefer to see the output of the \c messageserver -daemon, ensure it is running separately before running \c qtmail. - -\section1 Testing the Messaging Framework - -The messaging framework includes a series of unit tests designed to ensure that it is functioning correctly -in an operating environment. Unit tests are located in the \c tests top-level directory. - -To run the tests: - -\code -cd tests -make test -\endcode - -Normal \c make options control the operation of the testing - \c{-j} controls the number of concurrent tests invoked, \c{-k} instructs make to keep running in the event of a failure. - -\bold Note: some tests alter or remove data from the mailstore they operate against. It is prudent to use a different value for the \c QMF_DATA environment variable when running tests than when operating normally. - -To run a single test, perform \c{make test} within the subdirectory of the relevant test program. For example, to run just the \c tst_QMailCodec test: - -\code -make -C tests/tst_qmailcodec test -\endcode - -To run a single test suite, provide the name of the test suite in the \c ARGS variable: - -\code -make -C test/tst_qmailcodec ARGS="encode" test -\endcode - -To run a single test case, provide the name of the test case in the \c ARGS variable: - -\code -make -C test/tst_qmailcodec ARGS="encode:'one padding byte'" test -\endcode - \section1 Changes Between Messaging Framework Versions Historical changes in the \l {Messaging Framework Client Library} API are listed in \l{changes-qtopiamail.html}{CHANGES.qdoc}. |