| Title | Event descriptions are in a mess |
| Status | closed |
| Priority | nice |
| Assigned user | Gareth Rees |
| Organization | Ravenbrook |
| Description | The event definitions [1] have some outstanding to-do items: 1. "TODO: Rather than commenting them [unused events] out, we should leave them in and mark them in some other way, because this header is used by event decoders and they still want to decode those events. RB 2012-09-07" 2. "TODO: Add a doc string to each event type." 3. "TODO: Add a doc string to each parameter." 4. Additionally, a mistake in change 182553 led to the omission of event codes 0x007A-0x007F. |
| Analysis | The rollover of the major version number as a result of the work on job001150 means that we could clear-out unused event codes and renumber the remaining events. To solve (1), I note that each event code has an "always" parameter which is a Boolean. We could make this a tristate with values Always, Coolonly, Never. |
| How found | inspection |
| Evidence | [1] https://info.ravenbrook.com/project/mps/master/code/eventdef.h |
| Created by | Gareth Rees |
| Created on | 2018-06-27 10:45:23 |
| Last modified by | Gareth Rees |
| Last modified on | 2020-09-06 18:11:59 |
| History | 2018-06-27 GDR Created. |
| Change | Effect | Date | User | Description |
|---|---|---|---|---|
| 195235 | closed | 2018-10-13 12:22:24 | Gareth Rees | Merge branch/2018-06-20/monitor into the master sources. |