Austin Group Defect Tracker

Aardvark Mark IV

Main | My View | View Issues | Change Log | Docs
  

Viewing Issue Simple Details [ Jump to Notes ] [ Issue History ] [ Print ]
ID Category Severity Type Date Submitted Last Update
0001895 [1003.1(2024)/Issue8] Base Definitions and Headers Editorial Omission 2024-12-18 05:32 2025-01-09 15:42
Reporter larryv View Status public  
Assigned To
Priority normal Resolution Accepted As Marked  
Status Resolved  
Name Lawrence Velázquez
Organization
User Reference
Section 3.141 File Descriptor, 3.181 Job Control, 3.257 Pattern, 4.11 File System Cache, 8.1 Environment Variable Definition, 9.4.6 EREs Matching Multiple Characters, dirent.h, fcntl.h, stdatomic.h, stdlib.h, time.h, wordexp.h
Page Number 51, 57, 69, 98, 168-169, 189, 236-237, 250, 362, 383, 452, 489
Line Number 1601, 1776, 2114, 2963, 5889, 5895, 6762, 8347, 8359, 8764, 12653, 13480, 15759, 17284
Interp Status ---
Final Accepted Text Note: 0007022
Summary 0001895: XSH/XCU/XRAT prefixes missing from some cross-references
Description Most cross-references to other volumes are preceded by "XSH", "XCU", or "XRAT" as appropriate, but a few are not. The missing prefixes should be added to prevent reader confusion and maintain consistency with the cross-references that are already prefixed.
Desired Action On page 51 line 1601, change:
(see sysconf( ))
to:
(see XSH sysconf( ))


On page 57 line 1776, change:
(see for example setpgid( ))
to:
(see for example XSH setpgid( ))


On page 69 line 2114, change:
Section 2.14
to:
XCU Section 2.14


On page 98 line 2963, change:
(see write( ))
to:
(see XSH write( ))


On page 168 line 5889 and page 169 line 5895, change:
getenv( )
to:
XSH getenv( )


On page 189 line 6762, change:
Section A.9
to:
XRAT Section A.9


On page 236 line 8347 and page 237 line 8359, change:
the RATIONALE for posix_getdents( )
to:
the RATIONALE for XSH posix_getdents( )


On page 250 line 8764, change:
open( )
to:
XSH open( )


On page 362 line 12653, change:
kill_dependency( )
to:
XSH kill_dependency( )


I'm not sure about the next one. I guess the intention is for this "XCU" to cover both cross-references (as on page 93 line 2821: "see XCU Section 2.6.2 (on page 2485) and Section 2.6 (on page 2483)"), but it's hard to tell because the references are not that close to each other.

On page 383 line 13480, change:
(see XCU Section 2.8.2 (on page 2499) and the EXIT STATUS section of sh)
to:
(see XCU Section 2.8.2 (on page 2499) and the EXIT STATUS section of XCU sh)


On page 452 line 15759, change:
mktime( )
to:
XSH mktime( )


On page 489 line 17284, change:
wordexp( )
to:
XSH wordexp( )
Tags tc1-2024
Attached Files

- Relationships
related to 0001898Resolved Some cross-references have unnecessary XSH prefix 

-  Notes
(0007019)
ajosey (manager)
2024-12-19 12:20

 I am not sure that "most cross references" use the form described. I think this is covered in typographic conventions as use of () shows whether an API is a function and hence in XSH or not, similarly use of <> shows whether it is a header. The volume qualifier is used where there is some possible ambiguity, for example with a section number. In SEE ALSO we generally include the volume explicitly for APIs outside the volume you are in.
(0007022)
geoffclare (manager)
2024-12-19 16:25

 On page 69 line 2114, change:
Section 2.14

to:
XCU Section 2.14


On page 189 line 6762, change:
Section A.9

to:
XRAT Section A.9
(0007029)
larryv (reporter)
2024-12-20 01:27

 Alright, I didn't that know you treat "SEE ALSO" sections differently. That changes my sense of how often the prefixes are and aren't used.

It's reasonable to let the "fname( )" and "<header.h>" conventions imply "XSH" and "XBD", respectively, but that means that this volume currently has at least eight cross-references with an unnecessary "XSH" prefix. I've opened 0001898 requesting that they be removed for consistency.

- Issue History
Date Modified Username Field Change
2024-12-18 05:32 larryv New Issue
2024-12-18 05:32 larryv Name => Lawrence Velázquez
2024-12-18 05:32 larryv Section => 3.141 File Descriptor, 3.181 Job Control, 3.257 Pattern, 4.11 File System Cache, 8.1 Environment Variable Definition, 9.4.6 EREs Matching Multiple Characters, dirent.h, fcntl.h, stdatomic.h, stdlib.h, time.h, wordexp.h
2024-12-18 05:32 larryv Page Number => 51, 57, 69, 98, 168-169, 189, 236-237, 250, 362, 383, 452, 489
2024-12-18 05:32 larryv Line Number => 1601, 1776, 2114, 2963, 5889, 5895, 6762, 8347, 8359, 8764, 12653, 13480, 15759, 17284
2024-12-19 12:20 ajosey Note Added: 0007019
2024-12-19 16:25 geoffclare Note Added: 0007022
2024-12-19 16:27 geoffclare Interp Status => ---
2024-12-19 16:27 geoffclare Final Accepted Text => Note: 0007022
2024-12-19 16:27 geoffclare Status New => Resolved
2024-12-19 16:27 geoffclare Resolution Open => Accepted As Marked
2024-12-19 16:28 geoffclare Tag Attached: tc1-2024
2024-12-20 01:27 larryv Note Added: 0007029
2025-01-09 15:42 Don Cragun Relationship added related to 0001898

Mantis 1.1.6[^]
Copyright © 2000 - 2008 Mantis Group
Powered by Mantis Bugtracker