RRM 3-13 Editing Tasks

From EPICSWIKI

To Do List

The purpose of this list is to bring the existing R3.13 Record Reference Manual up to match the current R3.13.10 implementation. A separate effort can then be made to come out with a version of the manual for R3.14.x, starting from the R3.13.10 version.

  • Read Database Concepts and revise as necessary.
    • Maybe replace the existing CapFast diagrams with VDCT equivalents.
  • For Fields Common to All Record Types update the field tables and descriptions according to how dbCommon has changed.
  • Check Fields Common to Many Record Types for typical changes made across all record types.
  • For each existing record chapter we need to update its for
    • Changes to individual fields
    • Changes made to the record processing description
    • Fix shortcomings of the existing text, e.g.
      • Missing sections
      • Device support report() function prototypes
  • For Menu Choices check and update the list of menus and choices in each.

Record Documentation/Distribution Anomalies

These records are documented here but not present in any distribution of EPICS Base:

  • Archive
  • CPID

These records are not documented here, but are present in both the R3.13.10 and R3.14.x distributions:

  • Analog Array Input
  • Analog Array Output

These records are neither documented here nor present in any distribution of Base, but being commonly used they are candidates for possible inclusion in the documentation:

  • Enhanced PID
  • genSub
  • Motor
  • Transform
  • Table
  • waveformAnalysis
  • ... other ...

Don't add pages for these obsolete records, which were present in the R3.13.10 distribution but removed in R3.14.x:

  • Event Generator Event
  • Event Generator
  • Event Receiver Event
  • Event Receiver
  • GSub (not Andy Foster's genSub)
  • recDynLink
  • recWaitCa