Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[platform-doc-dev] prechecking doc changes with chkpii


In order to give a Olivier a break on patching doc after every build ;-)...
I thought I'd share what I do to precheck my doc submissions with chkpii.  Perhaps we could update/formalize this and include on the doc wiki.  These instructions are for windows.

- First, obtain and install the latest chkpii (currently chkpw805.exe).  (How do non-IBM committers get this tool?)
I install mine into c:\chkpii
- Create a subdirectory underneath your chkpii directory called "check"
- whenever you are ready to submit doc changes, just drag all the changed files into the "check" directory.
- run the attached "chk.bat" file, which should be placed inside the chkpii directory.
- consult the "htmlog,txt" file for errors and fix them...

The ignore* files that I use and the chkpii options were obtained from releng long ago, but they seem to do the trick for me..that is they are finding my errors and when I pass locally I am passing the builds...

susan



feature.properties
feature.xml
cpl*.html
license.html
notice.html
*/.metadata/.cache.properties
*/doc_zip/reference/api/*
*/doc_zip/reference/osgi/*
*/org.apache.ant_*
*/xercesImpl_jar/*
*/xercessrc_zip/*
*/doc_zip/reference/extension-points/*
*/plugins/org.eclipse.ui_*/plugin.xml
*/plugins/org.eclipse.tomcat_*/conf/*
*/plugins/org.eclipse.tomcat_*/catalina_jar/*
*/plugins/org.eclipse.tomcat_*/jasper-runtime_jar/*
*/plugins/org.eclipse.tomcat_*/tomcat-util_jar/*
*/plugins/org.eclipse.tomcat_*/commons-digester_jar/*
*/plugins/org.eclipse.tomcat_*/naming-common_jar/*
*/plugins/org.eclipse.tomcat_*/naming-resources_jar/*
*/plugins/org.eclipse.tomcat_*/servlets-common_jar/*
*/plugins/org.eclipse.tomcat_*/tomcat-coyote_jar/*
*/plugins/org.eclipse.tomcat_*/tomcat-http11_jar/*
*/plugins/org.eclipse.tomcat_*/commons-beanutils_jar/*
*/plugins/org.eclipse.tomcat_*/commons-modeler_jar/*
*/plugins/org.eclipse.tomcat_*/jasper-runtime_jar/*
*/plugins/org.eclipse.tomcat_*/tomcat-util_jar/*
*/plugins/org.eclipse.tomcat_*/commons-logging_jar/*
*/plugins/org.eclipse.tomcat_*/servlet_jar/*
*/org.apache.lucene_*/lucene-*-src_zip/lucene-*-src/*
*/plugins/org.eclipse.platform.source_*/src/org.apache.lucene_*/lucene-*-src_zip/lucene-*/*
*/plugins/org.eclipse.jdt.ui_*/jdt_jar/org/eclipse/jdt/internal/corext/template/default-codetemplates.xml
*/plugins/org.eclipse.ant.ui_*/antui_jar/anttasks_*.xml
*/plugins/org.eclipse.ant.ui_*/antui_jar/XDOCtasks.xml
*/plugins/org.eclipse.pde.build_*/scripts/*
*/plugins/org.eclipse.pde.build_*/feature/*
*/plugins/org.eclipse.pde.build_*/notes/*
*/plugins/org.eclipse.pde.ui_*/templates*/help/toc.xml
*/plugins/org.eclipse.help.webapp_*/WEB-INF/web.xml
*/plugins/org.eclipse.ui.workbench_*/workbench-new_jar/scripts/exportplugin.xml
*/plugins/org.eclipse.ui.workbench_*/texteditor-new_jar/scripts/exportplugin.xml
*/plugins/org.eclipse.jface_*/jface-new_jar/scripts/exportplugin.xml
*/plugins/org.eclipse.jdt_*/overviewExtensionContent.xml
*/plugins/org.eclipse.jdt_*/samplesExtensionContent.xml
*/plugins/org.eclipse.jdt_*/tutorialsExtensionContent.xml
*/plugins/org.eclipse.jdt_*/cheatsheets/HelloWorld.xml
*/plugins/org.eclipse.jdt_*/cheatsheets/HelloWorldSWT.xml
*/plugins/org.eclipse.pde_*/overviewExtensionContent.xml
*/plugins/org.eclipse.pde_*/tutorialsExtensionContent.xml
*/plugins/org.eclipse.pde_*/cheatsheets/helloworld.xml
*/plugins/org.eclipse.pde_*/cheatsheets/updates.xml
*/plugins/org.eclipse.platform_*/introContent.xml
*/plugins/org.eclipse.platform_*/cheatsheets/CVS_1.xml=
127
128

Attachment chk.bat contains a potentially harmful file type extension and was removed in accordance with IBM IT content security practices. 

Back to the top