| Title | Hard to keep "Common assertions" up to date |
| Status | closed |
| Priority | nice |
| Assigned user | Gareth Rees |
| Organization | Ravenbrook |
| Description | The manual section "Common assertions and their causes" [1] gives the text of some assertion errors. But this one is out of date (5 should now be 4): global.c: RingLength(&arenaGlobals->poolRing) == 5 |
| Analysis | When this line of code was edited, there was no indication that the manual also needed to be changed. There needs to be a convention for labelling assertions that appear in the manual. |
| How found | inspection |
| Evidence | [1] http://www.ravenbrook.com/project/mps/...anual/html/topic/error.html#topic-error |
| Created by | Gareth Rees |
| Created on | 2016-08-25 10:16:36 |
| Last modified by | Gareth Rees |
| Last modified on | 2016-09-02 14:11:08 |
| History | 2016-08-25 GDR Created. |
| Change | Effect | Date | User | Description |
|---|---|---|---|---|
| 192097 | closed | 2016-09-02 14:11:08 | Gareth Rees | Fix assertion text in the manual. Place a cross-reference by each assertion the appears in the manual, to assist in keeping the manual up to date. |