PCR 6753 - DEOS_TEST_INFO structure documentation incomplete.
Summary: DEOS_TEST_INFO structure documentation incomplete.
Status: ASSIGNED
Alias: None
Product: Kernel
Classification: Deos
Component: Kernel (show other PCRs)
Version: mainline
Hardware: All Deos
: Any Upcoming
: Defect
Target Milestone: mainline
Assignee: .Kernel
URL:
Whiteboard:
: 7664 (view as PCR list)
Depends on:
Blocks:
 
Reported: 2010-10-14 08:49 MST by alarson
Modified: 2025-12-15 11:42 MST (History)
3 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this PCR.
Description alarson 2010-10-14 08:49:04 MST
The documentation for the contents of the DEOS_TEST_INFO structure in testapiuk.h is incomplete and the requirements that utilize the test info structure for verification do not consistently have verification notes that inform the tester that tests can use the information in the structure to facilitate verification.
Comment 1 alarson 2010-10-14 08:55:37 MST
This issue was raised during one of the test reviewes.  Historically the role the DEOS_TEST_INFO structure elements was placed in the test case documents, however more recent convention has this information placed in the requirements document (where it probably should have been all along).  In some cases this has caused the rationale for the test info structure fields to be scattered amongst several test case documents.  Although this is an unfortunate situation, I don't see that it has any safety impact.  
Comment 2 deosbugs.ccb 2010-10-14 13:05:39 MST
CCB visited this PCR on 2010-10-14.
Comment 3 rroffelsen 2010-10-14 17:24:21 MST
As this missing documentation has no user visible impact and does not impact  safety (this documentation is only needed to assist kernel testers) I recommend this PCR be placed on deferred. 
Comment 4 deosbugs.ccb 2010-10-21 13:09:20 MST
CCB visited this PCR on 2010-10-21.
Comment 5 deosbugs.ccb 2010-12-17 10:18:25 MST
CCB visited this PCR on 2010-12-17.
Comment 6 deosbugs.ccb 2011-03-07 17:40:05 MST
CCB visited this PCR on 2011-03-07
Comment 7 deosbugs.ccb 2011-04-11 14:38:34 MST
CCB visited this PCR on 2011-04-11
Comment 8 deosbugs.ccb 2011-05-16 15:21:08 MST
CCB2 visited this PCR on 2011-05-16
Comment 9 deosbugs.ccb 2011-08-17 15:11:25 MST
CCB visited this PCR on 2011-08-17
Comment 10 deosbugs.ccb 2011-11-04 15:53:08 MST
CCB 2 visited this PCR on 2011-11-04
Comment 11 deosbugs.ccb 2012-01-31 13:46:25 MST
CCB visited this PCR on 2012-01-31
Comment 12 deosbugs.ccb 2012-05-15 08:41:15 MST
CCB visited this PCR on 2012-05-15
Comment 13 deosbugs.ccb 2012-06-08 13:17:41 MST
CCB 2 visited this PCR on 2012-06-08
Comment 14 deosbugs.ccb 2012-08-24 09:16:16 MST
CCB visited this PCR on 2012-08-24
Comment 15 deosbugs.ccb 2012-09-07 10:37:29 MST
CCB visited this PCR on 2012-09-07
Comment 16 rroffelsen 2012-09-17 16:01:22 MST
CCB visited this PCR on 2012-09-17
Comment 17 deosbugs.ccb 2012-11-19 12:20:20 MST
CCB visited this PCR on 2012-11-19
Comment 18 deosbugs.ccb 2012-11-26 17:46:42 MST
CCB visited this PCR on 2012-11-26
Comment 19 deosbugs.ccb 2013-02-12 21:18:07 MST
CCB visited this PCR on 2013-02-12
Comment 20 deosbugs.ccb 2013-03-18 14:36:04 MST
CCB visited this PCR on 2013-03-18
Comment 21 deosbugs.ccb 2013-05-15 10:12:51 MST
CCB visited this PCR on 2013-05-15
Comment 22 deosbugs.ccb 2013-07-19 11:26:28 MST
CCB visited this PCR on 2013-07-19
Comment 23 deosbugs.ccb 2013-11-15 17:40:45 MST
CCB visited this PCR on 2013-11-15
Comment 24 deosbugs.ccb 2014-05-20 10:14:48 MST
CCB 2 visited this PCR on 2014-05-20
Comment 25 deosbugs.ccb 2014-07-14 15:12:24 MST
CCB visited this PCR on 2014-07-14
Comment 26 deosbugs.ccb 2014-11-11 13:17:25 MST
CCB 2 visited this PCR on 2014-11-11
Comment 27 deosbugs.ccb 2014-11-11 13:36:04 MST
*** PCR 7664 has been marked as a duplicate of this PCR. ***
Comment 28 deosbugs.ccb 2014-11-17 08:58:36 MST
CCB visited this PCR on 2014-11-17
Comment 29 deosbugs.ccb 2016-04-18 12:56:58 MST
CCB visited this PCR on 2016-04-18
Comment 30 deosbugs.ccb 2016-06-20 13:09:56 MST
CCB visited this PCR on 2016-06-20
Comment 31 deosbugs.ccb 2017-02-01 09:43:25 MST
CCB visited this PCR on 2017-02-01-59501
Comment 32 deosbugs.ccb 2017-06-28 13:01:58 MST
CCB visited this PCR on 2017-06-28-69227
Comment 33 deosbugs.ccb 2017-07-06 11:07:50 MST
CCB visited this PCR on 2017-07-06-58325
Comment 34 deosbugs.ccb 2021-03-26 09:37:38 MST
CCB visited this PCR on 2021-03-26-57787
Comment 35 deosbugs.ccb 2021-04-05 09:54:34 MST
CCB visited this PCR on 2021-04-05-59141
Comment 36 deosbugs.ccb 2023-02-16 08:28:54 MST
CCB visited this PCR on 2023-02-16-53362
Comment 37 deosbugs.ccb 2023-02-16 08:33:27 MST
PCR does not impact gnu-language-1.4.2.
Comment 38 deosbugs.ccb 2023-08-14 11:07:03 MST
CCB visited this PCR on 2023-08-14-64795
Comment 39 deosbugs.ccb 2023-08-14 12:54:47 MST
This is a desired feature that should be included in an upcoming release if time allows.  It is being taken off of HOLD for consideration for Kismet.
Comment 40 deosbugs.ccb 2024-04-04 13:19:55 MST
CCB visited this PCR on 2024-04-04-71881
Comment 41 Sam DiCaro 2024-08-07 14:57:06 MST
Committed SVNRevision 94794.

- Added new terms for DEOS_TEST_INFO and all its members in getTestInfo() api description.
- Added various verification notes to Kernel SRD.
- The verification notes make reference to DEOS_TEST_INFO and the members that are used in the test for the respective requirement.
- Updated any reference to DEOS_TEST_INFO or its members with the proper xref.
- Updated release notes.
Comment 42 alarson 2024-08-07 15:49:50 MST
(In reply to Sam DiCaro from comment #41)
> Committed SVNRevision 94794.
> 
> - Added new terms for DEOS_TEST_INFO and all its members in getTestInfo()
> api description.
Something to consider: In several places in the kernel you'll see
multiple firstterm elements describing the same logical entity.
Having multiple names means it is possible to have the xreflabels be
different.  This can simplify the references.  E.g., instead of:

> <xref linkend="term-DEOS_TEST_INFO"/>.<xref linkend="DEOS_TEST_INFO-WriteProcessMemoryRaceVariablePtr"/>
Can be simplified to:

> <xref linkend="DEOS_TEST_INFO.WriteProcessMemoryRaceVariablePtr"/>
If the definition of WriteProcessMemoryRaceVariablePtr was changed to be:

>       <term><firstterm xml:id="DEOS_TEST_INFO-WriteProcessMemoryRaceVariablePtr> xreflabel="WriteProcessMemoryRaceVariablePtr">WriteProcessMemoryRaceVariablePtr
> </firstterm><firstterm xml:id="DEOS_TEST_INFO.WriteProcessMemoryRaceVariablePtr> xreflabel="DEOS_TEST_INFO.WriteProcessMemoryRaceVariablePtr"/>
Note the "-" to "." separator after TEST_INFO, and the inclusion of "DEOS_TEST_INFO." in the xreflabel.

Not strictly necessary, but there are typically more references than
definitions, so it is nice to keep the references simpler.

Note that if you do the above, make sure there is no whitespace between the closing </firstterm> and the next <firstterm>.  Otherwise space gets injected into the final markup and that looks messy.
Comment 43 Sam DiCaro 2024-08-15 11:51:24 MST
Committed SVNRevision 94894.

Fix xref's to DEOS_TEST_INFO members to use a struct_x.memberY format. Added new firstterm with struct_x.memberY for each member of DEOS_TEST_INFO as suggested in comment #42.
Comment 44 deosbugs.ccb 2024-08-30 06:57:36 MST
CCB visited this PCR on 2024-08-30-49739
Comment 45 deosbugs.ccb 2024-08-30 07:21:16 MST
Developer asserts updates are acceptable for release 11.4.0.
Comment 46 deosbugs.ccb 2024-12-11 13:05:31 MST
CCB visited this PCR on 2024-12-11-68907
Comment 47 Hernaldo Ramirez 2025-09-01 15:27:12 MST
Committed SVNRevision 100148.

Updates for tck290:
     o Update trace tags for requirements DDD_DEOS_TESTINF_20.1/30.1

Note: The wording in those requirements remains the same, changes related to docs references
Comment 48 deosbugs.ccb 2025-09-23 09:53:42 MST
CCB visited this PCR on 2025-09-23-60061
Comment 49 deosbugs.ccb 2025-12-15 11:42:54 MST
CCB visited this PCR on 2025-12-15-62159