Memory Pool System Product Tools
================================
:author: Richard Brooksby
:organization: Ravenbrook Limited
:date: 2002-06-18
:revision: $Id: //info.ravenbrook.com/project/mps/version/1.113/tool/index.rst#1 $
:confidentiality: public
:copyright: See `C. Copyright and License`_


1. Introduction
---------------

This document lists the tools which have been written to develop the
Memory Pool System product.

This document will be updated as new tools are created.

The readership of this document is anyone developing or extending the
product sources.

This document is not confidential.


2. Tools
--------

=================  =========================================================
`gcovfmt.py`_      Formats the output of the ``gcov`` coverage tool into a
                   summary table. It runs only on OS X, where it is invoked
                   from the Xcode project after running the test suite for
                   the “Debug” configuration.
`testrun.bat`_     Implements the ``testrun`` make target on Windows, where
                   it is invoked from ``commpost.nmk``.
`testrun.sh`_      Implements the ``testrun`` make target on FreeBSD and
                   Linux, it is invoked from ``comm.gmk``, and on OS X,
                   where it is invoked from the Xcode project.
`test-runner.py`_  Builds and runs tests. As of 2013-05-24 it is not used.
=================  =========================================================

.. _gcovfmt.py: gcovfmt.py
.. _testrun.bat: testrun.bat
.. _testrun.sh: testrun.sh
.. _test-runner.py: test-runner.py


A. References
-------------


B. Document History
-------------------

==========  ======  ========================================================
2002-06-18  RB_     Created based on P4DTI document.
2005-09-30  RHSK_   Added ``test-runner.py``.
2013-05-24  GDR_    Added ``gcovfmt.py`` and ``testrun.sh``. 
                    ``test-runner.py`` is no longer used.
2014-01-13  GDR_    Converted to reStructuredText. Added ``testrun.bat``.
==========  ======  ========================================================

.. _GDR: mailto:gdr@ravenbrook.com
.. _RB: mailto:rb@ravenbrook.com
.. _RHSK: mailto:rhsk@ravenbrook.com


C. Copyright and License
------------------------

Copyright © 2002-2014 Ravenbrook Limited. All rights reserved.
<http://www.ravenbrook.com/> This is an open source license. Contact
Ravenbrook for commercial licensing options.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

#. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
#. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
#. Redistributions in any form must be accompanied by information on how
   to obtain complete source code for the this software and any
   accompanying software that uses this software. The source code must
   either be included in the distribution or be available for no more
   than the cost of distribution plus a nominal fee, and must be freely
   redistributable under reasonable conditions. For an executable file,
   complete source code means the source code for all modules it
   contains. It does not include source code for modules or files that
   typically accompany the major components of the operating system on
   which the executable file runs.

**This software is provided by the copyright holders and contributors
"as is" and any express or implied warranties, including, but not
limited to, the implied warranties of merchantability, fitness for a
particular purpose, or non-infringement, are disclaimed. In no event
shall the copyright holders and contributors be liable for any direct,
indirect, incidental, special, exemplary, or consequential damages
(including, but not limited to, procurement of substitute goods or
services; loss of use, data, or profits; or business interruption)
however caused and on any theory of liability, whether in contract,
strict liability, or tort (including negligence or otherwise) arising in
any way out of the use of this software, even if advised of the
possibility of such damage.**
