Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 314276

Summary: Platform project documentation smoke test failures.
Product: z_Archived Reporter: Paul Slauenwhite <paulslau>
Component: TPTPAssignee: Kathy Chan <kathy>
Status: CLOSED FIXED QA Contact: Kathy Chan <kathy>
Severity: normal    
Priority: P2 CC: jgwest, oec
Version: unspecifiedFlags: oec: pmc_approved+
kathy: pmc_approved? (ernest)
kathy: pmc_approved? (kathy)
paulslau: pmc_approved+
kathy: pmc_approved? (jgwest)
jgwest: review+
Target Milestone: ---   
Hardware: All   
OS: All   
Whiteboard:
Attachments:
Description Flags
Patch 1
none
Patch 2 none

Description Paul Slauenwhite CLA 2010-05-25 10:08:04 EDT
******** Checking 'D:\TPTP\Smoke_Test\doc\tptp\platform\runtime\org.eclipse.tptp.platform.doc.user'... ********

** Checking legal...
OK!
** Done checking legal!
Platform project documentation smoke test failures.

** Checking cross plug-in references...
OK!
** Done checking cross plug-in references!

** Checking TOC...
[Error parsing file] 
... continuing to next file in documentation directory

[Error parsing file] 
... continuing to next file in documentation directory

[Error parsing file] 
... continuing to next file in documentation directory

[Error parsing file] 
... continuing to next file in documentation directory

[orphan] ref/ras400limit.html
[orphan] ref/reexflwvw.htm
[orphan] ref/reobjallocanal.htm
[orphan] tasks/tprofas400.htm
** Done checking TOC!

******** Done checking 'D:\TPTP\Smoke_Test\doc\tptp\platform\runtime\org.eclipse.tptp.platform.doc.user'! ********
Comment 2 Kathy Chan CLA 2010-05-25 12:39:41 EDT
The 4 errors in parsing file are because the following toc entries have been removed (as they should be since we are no longer shipping the logging and monitoring functions):

- logging0.xml
- logging2.xml
- logging3.xml
- monitoring.xml

I suspect may be some other top level file is still refering to these files and need to be cleaned up.

As for the orphan html, some of them still seems to be referenced.  I'll take a closer look.
Comment 3 Kathy Chan CLA 2010-05-26 21:48:41 EDT
Created attachment 170129 [details]
Patch 1

Patch for "error in parsing file" and orphan links.  I found out that links are considered orphan if it's not linked from the TOC even though it's being referenced by other HTML pages.  Deleted some unused html and added a couple to the profile.toc.  

Also updated some copyright years.
Comment 4 Kathy Chan CLA 2010-05-26 22:59:14 EDT
Jonathan, please review.
Comment 5 Kathy Chan CLA 2010-05-26 22:59:58 EDT
Bug 314598 has been opened to address the version number update.
Comment 6 Kathy Chan CLA 2010-05-26 23:02:12 EDT
Created attachment 170133 [details]
Patch 2

Update copyright statement in build.xml and version number of model.hierachy.
Comment 7 Jonathan West CLA 2010-05-27 08:18:20 EDT
Patch is good.
Comment 8 Kathy Chan CLA 2010-05-27 10:06:14 EDT
I would like to request that the following defect be considered for PMC
approval for 4.7.0.

1.  Explain why you believe this is a stop-ship defect. How does the defect
manifest itself, and how will users of TPTP / consuming products be affected if
the defect is not fixed?

Certain profiling document pages are not showing up in the TOC.  Some files has wrong copyright year.

2. Is there a work-around? If so, why do you believe the work-around is
insufficient?
No.

3. Is this a regression or API breakage? Explain.
No.

4. Does this require new API?
No.

5. Who performed the code review?
Jonathan

6. Is there a test case attached to the bugzilla record?
Platform smoke test.

7. What is the nature of the fix?  What is the risk associated with this fix?
Low.

8. Is this fix related to any standards that TPTP adheres to? If so, who has
validated that the fix continues to adhere to the standard?
No..
Comment 9 Kathy Chan CLA 2010-05-27 10:35:05 EDT
Patch 1 and 2 have been checked into HEAD for TPTP 4.7.0.

We'll also track

http://download.eclipse.org/tptp/4.7.0/dev/TPTP-4.7.0-201005222133/NeedUpdate

with bug 314598.
Comment 10 Paul Slauenwhite CLA 2010-06-23 12:50:49 EDT
Verified in TPTP-4.7.0RC4-201006081927.

Closing.

See https://bugs.eclipse.org/bugs/show_bug.cgi?id=314598#c6 for the remaining copyright issues.