| Title | Some external symbols are missing from the reference manual |
| Status | closed |
| Priority | essential |
| Assigned user | Gareth Rees |
| Organization | Ravenbrook |
| Description | The MPS reference manual has per-symbol documentation for a number of symbols, but some external symbols are not documented (for example, mps_arena_has_addr). |
| Analysis | There's now a list of missing symbols in section 4 of the refman. Before documentation is written, the refman needs reorganizing (job000540). GDR 2012-10-19: As of change 179970, all external symbols are either documented in the reference manual, or else the purpose of the symbol is unclear (and possibility the symbol is private or obsolete or should be deprecated) and there's a job about it. These symbols and the corresponding jobs are as follows: job003321: mps_sac_s mps_sac_freelist_block_s job003322: mps_fmt_fixed_s mps_fmt_create_fixed job003325: mps_fmt_class_t job003326: mps_arena_class_vmnz job003327: mps_ap_fill_with_reservoir_permit mps_reservoir_limit_set mps_reservoir_limit mps_reservoir_available mps_reserve_with_reservoir_permit MPS_RESERVE_WITH_RESERVOIR_PERMIT_BLOCK job003329 mps_alert_collection_set mps_alert_collection_fn_t job003448 mps_arena_vm_growth |
| 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:45:42 |
| Last modified by | Gareth Rees |
| Last modified on | 2013-03-19 11:13:56 |
| History | 2002-06-21 NB Created. 2002-06-21 NB Added list of missing symbols to the refman. 2012-10-17 GDR Assigned to GDR. 2012-10-19 GDR Note that not quite all. 2013-03-19 GDR Add mps_arena_vm_growth. |
| Change | Effect | Date | User | Description |
|---|---|---|---|---|
| 179970 | closed | 2012-10-19 16:46:55 | Gareth Rees | Complete tasks from meeting with RB earlier today. New topics "interface" and "thread". Document external symbols mps_ap_create, mps_ap_create_v, mps_ap_fill, mps_ap_s, mps_commit, mps_reserve, MPS_RESERVE_BLOCK, mps_tramp, mps_tramp_t. |