![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Documenting Your RCI Customization The following list provides a general outline of topics (in italics) that you should cover in user documentation for your customization. Using the RCI provides general instructions about how to use RCI commands, but it does not include customization-dependent information. Include the topics in brackets ([ ]) if you implement those features.
- Introductory Information
Provide the following for your customization:
- the name of the target compilation system
- the target compilation platform
- the compiler key directory
- the model
Provide the commands that the RCI issues to invoke the target compiler.
If your customization uses them, provide the default names for program libraries or import lists.
- Target-Compiler Options
Provide a list of the compile and link options you define for your customization's target compiler.
- Package Standard Types
Provide a list of the types you define in package Standard.
- Predefined Libraries
Provide a list of the packages you include in the lrm and predefined libraries.
- Representation Clauses
Provide a list of the representation clauses, if any, that you define for your customization.
- Attributes
Provide a list of the attributes, if any, that you define for your customization.
- Pragmas
- Implementation-Defined Pragmas
Provide a list of the pragmas you define specifically for your target compiler.
- Predefined Pragmas
Provide a list of the LRM-defined pragmas that your customization supports.
- Pragma Interface
Provide a list of languages that pragma Interface supports in your customization.
- Remote-Library Management
This section should include any customization-specific information about how your target compiler handles libraries and imports. Use this section to describe the actions your customization takes with the Apex user commands:
- File > New > New View
- File > Copy Object
- File > Delete Object
- Control > Change View Properties
- Compilation operations
- Create > Target Library
- Delete > Target Library
- Refresh > Target Imports
You need to cover the following areas to correspond with the RCI User's Guide:
- Creating Views and Target Libraries
- Creating Target Libraries for Existing Views
- Creating Target Libraries Manually
Provide instructions, if appropriate, on how to build the target library manually on the target compilation platform, if you have conditions where you want to continue work when the host system or network is not available.
- Deleting RCI Views and Ada Units
- Deleting Target Directories
- Controlling and Refreshing Target Imports
- Analyzing, Coding, and Linking Target Libraries
- RCI Batch-Compilation Support
Use this section to describe what actions your customization takes with the RCI user commands:
- Create Script
- Copy to Target
You need to cover the following areas to correspond with Using the RCI.
- Building a Batch Script
- Transferring Host Units
- Executing the Batch Script
- [Retrieving Associated Files]
- Consistency Management
Describe the methods used by the RCI commands:
- Compare to Target
- Accept Target Changes
to compare files for consistency management. Or provide a note if the customization maintains the files as links, so by definition the files are always consistent.
- [Network-Communications Mechanism]
If you implement a mechanism other than the one provided by the RCI, for example, FTP or tape transfer, provide any instructions necessary to use your customization-specific communications mechanism.
- Troubleshooting
Include any troubleshooting hints, tips, or workarounds specific to your customization.
Rational Software Corporation http://www.rational.com support@rational.com techpubs@rational.com Copyright © 1993-2002, Rational Software Corporation. All rights reserved. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |