Review checklist
| author | Gareth Rees |
| copyright | See section Copyright and License. |
| date | 2015-08-10 |
| index terms | pair: review; checklist |
| organization | Ravenbrook Limited |
| revision | //info.ravenbrook.com/project/mps/master/design/guide.review.txt#6 |
| status | incomplete documentation |
| tag | guide.review |
Introduction
.scope: This document contains a list of checks to apply when reviewing code or other documents in the Memory Pool System.
.readership: This document is intended for reviewers.
.example: The "example" links are issues caused by a failure to apply the checklist item.
.diff: Some items in the checklist are particularly susceptible to being ignored if one reviews only via the version control diff. These items refer to this tag.
Checklist
.test: If a new feature has been added to the code, is there a test case? Example: job003923.
.unwind: If code has been updated in a function that unwinds its state in failure cases, have the failure cases been updated to correspond? Example: job003922. See .diff.
Document History
2015-08-10 GDR Created.
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.