New developer guide
| author | Gareth Rees |
| copyright | See section Copyright and License. |
| date | 2018-09-18 |
| index terms | pair: developer; guide |
| organization | Ravenbrook Limited |
| revision | //info.ravenbrook.com/project/mps/master/design/guide.developer.txt#7 |
| status | draft documentation |
| tag | guide.developer |
Introduction
.intro: This is an introduction to the Memory Pool System (MPS) for new developers.
.source: This is based on [APT_2018-09-17].
What to read first
- manual/build.txt -- how to build the MPS.
- manual/guide -- tutorial for the public interface.
- manual/topic -- reference manual for the public interface.
- manual/code-index -- description and purpose of each file of source code.
- design.mps.config -- build configuration.
- design.mps.tests -- how to run test cases.
- design.mps.doc -- how to write and edit documentation.
References
| [APT_2018-09-17] | (1, 2) "Procedure for new developers"; Alistair Turnbull; Ravenbrook Limited; 2018-09-17; <https://info.ravenbrook.com/mail/2018/09/17/11-16-41/0/> |
Document History
- 2018-09-18 GDR Created based on [APT_2018-09-17].
Copyright and License
Copyright © 2015–2020 Ravenbrook Limited.
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.
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 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 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.