1 :Info: info_seg_verify_:  2020-11-26  info_seg_verify_
  2 
  3 The verify_info command uses the info_seg_verify_ subroutine to parse
  4 and verify info segments, and display rules and guidelines for info
  5 segment which are maintained in the info_seg_specifications_ data
  6 structures.
  7 
  8 
  9 :Entry: iFiles:  2020-11-25  info_seg_verify_$iFiles
 10 
 11 Function: initiates and verifies contents of each info segment
 12 described by an input iFile structure (in the verify_info_data.files
 13 threaded list), reporting failures to meet info segment organization
 14 and formatting guidelines.
 15 
 16 If verify_info_data.totalsS is "1"b, three elements are set in
 17 verify_info_data to report that issues were found:
 18 
 19   .segs_processed    count of info segments examined.
 20   .error_count       count of errors or issues found.
 21   .highest_severity  severity of the most serious error or issue found.
 22 
 23 
 24 If verify_info_data.totalsS is "0"b, those elements are set, but error
 25 or warning messages are displayed for each error or issue found in a
 26 particular info segment.  Also, info segment block and section
 27 organization is reported to the user as each info segment is verified.
 28 
 29 
 30 Syntax:
 31    declare info_seg_verify_$iFiles entry (ptr);
 32    call info_seg_verify_$iFiles (verify_info_dataP);
 33 
 34 
 35 Arguments:
 36 verify_info_dataP
 37    points to the verify_info_data structure (see
 38    verify_info_data.incl.pl1).
 39 
 40 
 41 :Entry: display_specifications:  2020-11-26  info_seg_verify_$display_specifications
 42 
 43 Function: displays guidelines for:
 44  - supported info segment file structures (ordering of info blocks).
 45  - rules for determining kind of each block.
 46  - preferred section titles, with recommendations for mapping
 47    deprecated (obsolete) titles to a preferred title.
 48  - recommended section titles used in each kind of block.
 49 
 50 
 51 Syntax:
 52    declare info_seg_verify_$display_specifications entry (ptr);
 53    call info_seg_verify_$display_specifications (verify_info_dataP);
 54 
 55 
 56 Arguments:
 57 verify_info_dataP
 58    points to the info_seg_data structure.  Refer to
 59    verify_info_data.incl.pl1.
 60 
 61 
 62 List of selectors:
 63    The verify_info_data.rules_area element selects the info seg
 64    guidelines to display.  This element may have one of the following
 65    constants (also declared in verify_info_data.incl.pl1).
 66 VI_RULE_all_areas
 67   displays all rules and guidelines used by verify_info.
 68 VI_RULE_file_structure
 69   displays guidelines for supported file structures (allowed order of
 70   :Info: :[Info]: :Entry: and :hcom: block divider lines within an
 71   info segment).
 72 VI_RULE_block_kind
 73   displays rules used to determine the kind of each info block
 74   (e.g., command or active function, subroutine, subsystem request,
 75   etc.).
 76 
 77 
 78 VI_RULE_section_titles
 79   displays Multics standard info segment section titles, and a list of
 80   obsolete or deprecated titles with a preferred replacement.
 81 VI_RULE_all_kinds
 82   displays section titles typical for each kind of info block,
 83   including the usual order of appearance within the block of each
 84   title.  Use a selector below to display section titles for
 85   particular kinds of info blocks.
 86 
 87 
 88 VI_RULE_command_titles
 89   displays section titles typical for an info block describing a
 90   command or active function.
 91 VI_RULE_gi_titles
 92   displays section titles typical for a generic info block (.gi.info
 93   segment).
 94 
 95 
 96 VI_RULE_subsystem_titles
 97   displays section titles typical for an info block describing a
 98   subsystem request or active request; a subsystem request summary; or
 99   other subsystem topic.
100 VI_RULE_request_titles
101   displays section titles typical for an info block describing a
102   subsystem request or active request.
103 VI_RULE_topic_titles
104   displays section titles typical for an info block describing a
105   subsystem request summary; or other subsystem topic.
106 
107 
108 VI_RULE_subroutine_titles
109   displays section titles typical for an info block describing a
110   subroutine or function.  This includes a subroutine introduction
111   block, and blocks describing each subroutine entry point.
112 VI_RULE_io_titles
113   displays section titles typical for an info block describing an
114   I/O module; or one of its setup operations (open_file, close_file,
115   or detach); or one of its control orders.
116 
117 
118 :hcom:
119 
120 /****^  HISTORY COMMENTS:
121   1) change(2020-11-26,GDixon), approve(2021-02-23,MCR10089),
122      audit(2021-03-31,Swenson), install(2021-03-31,MR12.6g-0053):
123      Created initial version of this info segment.
124                                                    END HISTORY COMMENTS */