Opened 6 years ago

Closed 5 years ago

#208 closed defect (wontfix)

validate_info_seg does not handle XXX.compin.info segments correctly

Reported by: Gary Dixon Owned by: Gary Dixon
Priority: minor Milestone:
Component: Documentation Version:
Keywords: Cc:

Description

When checking info segments documenting the standard .compin file (used to format pages of manuals, etc), vis reports spurious errors in such usually well-formatted XXX.compin.info segments. For example:

vis >doc>info>argument_list.compin.info

>doc>info>argument_list.compin.info

-----------REQUEST info
LINE: 1     08/17/80          argument_list.compin
Severity 3. Date must be in iso_date format: change "08/17/80" to "1980-08-17"
LINE: 3     Syntax
Severity 2. Short name "argument_list.compin" not used.
LINE: 7     Function
LINE: 12    Macro action
Severity 2. Nonstandard section title: Macro action
Severity 2. Extra name on segment: arg_list.compin.info

None of the Severity 2 errors reported above correctly diagnose any real issue. They all are reported because validate_info_seg does not understand the format chosen to document this .compin macro files.

Since these compose macros are not used these days for generating documents (since source for earlier manuals and other documents has not been located), this report is focused on characteristic deficiencies in validate_info_seg command (such as not handling well-formatted info segments whose chosen format differs from that used by commands and active functions, etc.). I am therefore setting priority of this bug report to "minor".

Change History (3)

comment:1 by Gary Dixon, 6 years ago

Owner: changed from Eric Swenson to Gary Dixon
Status: newaccepted

verify_info handles .compin.info segments in a better fashion.

comment:2 by Gary Dixon, 6 years ago

The proposed verify_info command also does not handle info segments documenting the .compin macros.

vi >doc>info>argument_list.compin

FILE: >doc>info>argument_list.compin.info
        structure:  Info Segment - no block dividers                         lines:   20
            names:
              argument_list.compin.info
              arg_list.compin.info

       Severity 2.  Unexpected names found on the info segment:
           arg_list.compin.info

     Line    Kind                                   Block Names
 ---    1 Command                               argument_list.compin
           header:  08/17/80 argument_list.compin
        recommend:  1980-08-17  argument_list.compin
       Severity 4.  Use an iso_date in the header.
        3   Syntax
       Severity 4.  Section title not used for a Command block.
        recommend:  Syntax as a command:
        7   Function
       12   Macro action
       Severity 1.  1 section has a nonstandard title, beginning on line:
                      12

comment:3 by Gary Dixon, 5 years ago

Resolution: wontfix
Status: acceptedclosed

Because of lack of support for these .compin macros, and lack of source for the manuals created using those .compin macros, it was decided to not change verify_info to support the info segments describing such macros.

Note: See TracTickets for help on using tickets.