PCR 14558 - Add select sections to xref-alternates files.
Summary: Add select sections to xref-alternates files.
Status: ASSIGNED
Alias: None
Product: Kernel
Classification: Deos
Component: Kernel (show other PCRs)
Version: mainline
Hardware: All Deos
: Any Upcoming
: WorkStep
Target Milestone: mainline
Assignee: .Kernel
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2022-10-03 12:11 MST by alarson
Modified: 2024-12-11 13:05 MST (History)
1 user (show)

See Also:
Impact Assessment: TBD
Organization: DDC-I, Inc.
rroffelsen: Requirements?
alarson: Code-
alarson: TestCases-
alarson: TestProcedures-
rroffelsen: Other?

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this PCR.
Description alarson 2022-10-03 12:11:44 MST 
Several components make reference to kernel user guide sections (not just API functions) via informal means.  The kernel should provide xref-alternate files codifying the which sections are "public" and what their ID's are.
Comment 1 alarson 2022-10-03 12:13:55 MST 
The integration tool maintainer reports:

> The ITUG is currently referencing these non-public xrefs.  These are
> section references.  Not sure if its appropriate for all sections to
> be public_id or not, but i do know other UGs/DDDs reference the memory
> model section.
> 
>  <xref-alternate id="resapi"> 
>    <link xl:href="&kernug;#resapi">Platform Resource Services</link></xref-alternate> 
>  
>  <xref-alternate id="sect-IO-API-Services"> 
>    <link xl:href="&kernug;#sect-IO-API-Services">I/O Mapped Resource Services</link></xref-alternate>  
>    
>  <xref-alternate id="PROXY-ACCESS-API-SERVICES"> 
>    <link xl:href="&kernug;#PROXY-ACCESS-API-SERVICES">Proxy Access Resource Services</link></xref-alternate> 
>  
>  <xref-alternate id="sect-striped-range"> 
>    <link xl:href="&kernug;#sect-striped-range">Striped Range</link></xref-alternate> 
>  
>  <xref-alternate id="fileserv"> 
>    <link xl:href="&kernug;#fileserv">File Services</link></xref-alternate> 
> 
>  <xref-alternate id="pal-interrupts"> 
>    <link xl:href="&kernug;#pal-interrupts">Interrupts</link></xref-alternate>   
> 
>  <xref-alternate id="sect-kernel-mode-interrupts"> 
>    <link xl:href="&kernug;#sect-kernel-mode-interrupts">Kernel Mode Interrupts</link></xref-alternate> 
>  
>  <xref-alternate id="sect-window-attributes"> 
>    <link xl:href="&kernug;#sect-window-attributes">Window Attributes</link></xref-alternate> 
> 
>  <xref-alternate id="window-services"> 
>    <link xl:href="&kernug;#window-services">Window Services</link></xref-alternate>
Comment 2 alarson 2022-10-03 12:15:53 MST 
In addition to deciding which sections, I think we should resolve:

1. Should exported section references be "required" to follow the new
   naming convention, e.g., sect-...? 
2. What should the xreflabel be?  Just the title/section number (I
   prefer title)?  Should it include other info, e.g., "Section $title in
   [KERNUG]", or "Section "$title" in the Deos Kernel Users Guide"?

Item 2 probably drives requirements on DeosBook.
Comment 3 deosbugs.ccb 2023-02-13 13:07:05 MST 
CCB visited this PCR on 2023-02-13-71816
Comment 4 deosbugs.ccb 2023-02-13 13:36:58 MST 
PCR being placed on HOLD for jupiter verf.  It will be considered for a subsequent verf.
Comment 5 deosbugs.ccb 2023-08-14 11:05:03 MST 
CCB visited this PCR on 2023-08-14-64795
Comment 6 deosbugs.ccb 2023-08-23 09:21:15 MST 
PCR being taken off HOLD for kismet, to be worked if time permits.
Comment 7 deosbugs.ccb 2024-08-30 06:55:55 MST 
CCB visited this PCR on 2024-08-30-49739
Comment 8 deosbugs.ccb 2024-12-11 13:05:16 MST 
CCB visited this PCR on 2024-12-11-68907