| Title | Reference manual symbol coverage needs reorganizing |
| Status | closed |
| Priority | essential |
| Assigned user | Gareth Rees |
| Organization | Ravenbrook |
| Description | The MPS reference manual is just a giant concatenation of references, one for each symbol, in approximate alphabetical order. Although it is essential to be able to find documentation given a symbol, this is not the best way. Reference documentation for related symbols should be together (e.g. mps_ap_frame_pop and mps_ap_frame_push), and the manual should probably have separate pages for separate groups of symbols. The manual index can link to the appropriate page for every symbol (and have an anchor for each symbol). See also job000539. |
| Analysis | I think we should model ourselves on Unix man pages. |
| How found | inspection |
| Evidence | I just know |
| Observed in | 1.100.0 |
| Introduced in | 1.100.0 |
| Created by | Nick Barnes |
| Created on | 2002-06-21 11:51:59 |
| Last modified by | Gareth Rees |
| Last modified on | 2012-10-19 18:09:10 |
| History | 2002-06-21 NB Created. 2012-10-17 GDR Assigned to GDR. |
| Change | Effect | Date | User | Description |
|---|---|---|---|---|
| 179974 | closed | 2012-10-19 18:09:10 | Gareth Rees | Distribute symbol reference into the topics. |