| Title | No MPS user manual |
| Status | closed |
| Priority | essential |
| Assigned user | Gareth Rees |
| Organization | Ravenbrook |
| Description | The MPS needs a user manual, for people writing clients. |
| Analysis | There are some relevant documents in the old MMDoc, which can be redacted and imported. See also job000537 and job000538. Some subjects belong in a user manual, and some in a programmer's guide (see job000543). See also analysis.product.prod.sw.manual.* < http://info.ravenbrook.com/project/mps...bsolete-mminfo/mminfo/analysis/product/>See also design.product.doc.user-guide < http://info.ravenbrook.com/project/mps...o/mminfo/design/product/doc/user-guide/>GDR's outline < http://info.ravenbrook.com/mail/2012/09/21/15-00-18/0/> |
| 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:56:17 |
| Last modified by | Gareth Rees |
| Last modified on | 2012-11-05 17:21:07 |
| History | 2002-06-21 NB Created. 2012-09-22 RB Added GDR's outline. 2012-10-17 GDR Assigned to GDR. |
| Change | Effect | Date | User | Description |
|---|---|---|---|---|
| 180338 | closed | 2012-11-05 17:18:50 | Gareth Rees | Build HTML version of the manual in manual/html. Check in HTML version of the manual (writable on client) so that it will display automatically on the Ravenbrook server and so that we can easily include it in product releases. |
| 157364 | open | 2006-02-22 12:28:08 | Richard Kistruck | MPS: a simple walkthrough of writing "hello world" using the MPS. This version shows how to find and use: - the main "mps.h" header file; - the additional MPS header file "mpsacl.h"; - (in "mpsacl.h") the identifier function "mps_arena_class_cl" for the "CL" arena class we want to use; And build and link with: - the MPS library "mps.a"; - the example plinth "mpsplan.a". rundoccode.py: Shell code lines must start with percent _and_ space. |