Opened 3 years ago
Last modified 12 months ago
#329 assigned enhancement
Expand mbuild internal help documentation
| Reported by: | Gary Dixon | Owned by: | Gary Dixon |
|---|---|---|---|
| Priority: | major | Milestone: | MR12.9 |
| Component: | Documentation | Version: | MR12.8 |
| Keywords: | Cc: |
Description
Internal help documentation for the mbuild subsystem needs to be expanded in several different ways. Current documentation covers the following topics:
- User interface for the mbuild command (and its supporting commands like mbuild_type).
- Documentation of the statements supported in the Build_script Changes -- section. These statements describe exact contents of an mbuild change_set.
- Documentation for each mbuild request.
Topics missing from the current documentation set include the following.
- Description of mbuild features, and the special terminology it uses (a glossary of mbuild terms).
- A list of information blocks available to the mbuild help (h) request (a list_help style overview).
- A list of supporting compilers, archiving and bind tools, library description tools and other tools known to, and used by the mbuild subsystem.
- A description of the possible build/install outcomes that can be provided by mbuild, with details for build_directory setup to achieve each of those outcomes.
This ticket proposes that mbuild be enhanced to provide such missing documentation.
Note:
See TracTickets
for help on using tickets.
