Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-releng-dev] Missing extension point documentation documents


Releng Team,

Attached is a simple JUnit test case that checks for missing documents.  Since doc plug-ins do not run JUnit test, can (after M5) this test be run as part of the releng suite, similarly as chkpii is today?  It would be good if each missing document was listed, instead of a single failure for all of documentation.  You would need to modify the testMissingDocs() method to produce an output suitable for including in the report page.

Thank you.



Konrad Kolosowski




Konrad Kolosowski/Toronto/IBM@IBMCA
Sent by: platform-releng-dev-admin@xxxxxxxxxxx

02/16/2005 10:59 AM

Please respond to
platform-releng-dev

To
platform-releng-dev@xxxxxxxxxxx
cc
Subject
[platform-releng-dev] Missing extension point documentation documents






Teams,


There are still documents missing from documentation plug-ins while appearing in help table of contents.  In the latest build these are documents for few extension points.  Teams providing these extension points, please address before M5.  The extension points and API documentation are generated and copied to the documentation plug-ins, but individual teams are still responsible for ensuring their documents are included in the build.  For details of how to add new APIs and extension points to the build, refer to aaa-how-to-add-things.txt file in the org.eclipse.platform.doc.isv and org.eclipse.jdt.doc.isv projects.


Debug team https://bugs.eclipse.org/bugs/show_bug.cgi?id=85172

org.eclipse.platform.doc.isv/reference/extension-points/org_eclipse_debug_ui_launchShortcuts.html


UI team https://bugs.eclipse.org/bugs/show_bug.cgi?id=85170

org.eclipse.platform.doc.isv/reference/extension-points/org_eclipse_ui_popupMenus.html


JDT team https://bugs.eclipse.org/bugs/show_bug.cgi?id=85173

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_ltk_core_refactoring_renameParticipants.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_jdt_ui_quickFixProcessors.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_ltk_core_refactoring_createParticipants.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_ltk_core_refactoring_deleteParticipants.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_jdt_ui_quickAssistProcessors.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_ltk_ui_refactoring_statusContextViewers.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_ltk_ui_refactoring_changePreviewViewers.html

org.eclipse.jdt.doc.isv/reference/extension-points/org_eclipse_ltk_core_refactoring_moveParticipants.html


At the moment there are no JUnit test cases flagging these problems.  I think we need a test run as part of each build implemented after M5.  In the meantime, to verify the problems are fixed, shutdown Eclipse, delete configuration/org.eclipse.help.base/index directory, restart Eclipse, execute search in help, and check workspace/.log for any missing documents being reported.


Konrad Kolosowski

Attachment: TestTocDocuments.java
Description: Binary data


Back to the top