Bug 91695 - Search index building in docs
Summary: Search index building in docs
Status: RESOLVED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.1 M7   Edit
Assignee: Dani Megert CLA
QA Contact:
URL:
Whiteboard:
Keywords: performance
Depends on:
Blocks:
 
Reported: 2005-04-17 16:56 EDT by Dejan Glozic CLA
Modified: 2005-05-25 15:45 EDT (History)
0 users

See Also:


Attachments
ISV patch for enabling search index pre-building (2.29 KB, patch)
2005-04-17 16:57 EDT, Dejan Glozic CLA
no flags Details | Diff
User doc patch for enabling search index pre-building (2.51 KB, patch)
2005-04-17 16:58 EDT, Dejan Glozic CLA
no flags Details | Diff
The corrected doc.user patch (1.91 KB, patch)
2005-04-19 17:20 EDT, Dejan Glozic CLA
no flags Details | Diff
The corrected doc.isv patch (1.17 KB, patch)
2005-04-19 17:21 EDT, Dejan Glozic CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Dejan Glozic CLA 2005-04-17 16:56:44 EDT
As part of the performance effort in M7, we have created an Ant task to build 
search index for document plug-ins as part of the regular build. Please apply 
the patches in this defect against org.eclipse.jdt.doc.* plug-ins (user and 
isv) so that index building is enabled.
Comment 1 Dejan Glozic CLA 2005-04-17 16:57:33 EDT
Created attachment 19983 [details]
ISV patch for enabling search index pre-building
Comment 2 Dejan Glozic CLA 2005-04-17 16:58:07 EDT
Created attachment 19984 [details]
User doc patch for enabling search index pre-building
Comment 3 Dani Megert CLA 2005-04-19 03:56:56 EDT
Thanks for the patches.

Fixed in HEAD.
Released to I20050419-0800.
Comment 4 Dirk Baeumer CLA 2005-04-19 04:32:20 EDT
Thanks Dani.
Comment 5 Dejan Glozic CLA 2005-04-19 07:25:21 EDT
Great - we can now have a complete index on every build. It is worth it - 
first-time help search will now take only couple of seconds.
Comment 6 Dejan Glozic CLA 2005-04-19 17:20:13 EDT
Sorry, the attached patches were not correct. I placed the antcall for build 
indexing in wrong targets. Attached are revised patches that should be 'it'.
Comment 7 Dejan Glozic CLA 2005-04-19 17:20:52 EDT
Created attachment 20086 [details]
The corrected doc.user patch
Comment 8 Dejan Glozic CLA 2005-04-19 17:21:19 EDT
Created attachment 20087 [details]
The corrected doc.isv patch
Comment 9 Dani Megert CLA 2005-04-20 12:10:22 EDT
Fixed in HEAD.
Comment 10 Nick Boldt CLA 2005-05-25 15:45:55 EDT
For what it's worth, I hit one minor (in retrospect, obvious) problem
implementing the patches defined here. This is mostly since our build.xml files
aren't exactly verbatim to the ones for doc.user or doc.isv - as such, I had to
manually stick in the new code:

	<target name="build.jars" depends="init" description="Build all the jars for
the plug-in: org.eclipse.emf.doc.">

  ...
		<antcall target="build.index"/> <!-- new call -->

		<zip destfile="${build.result.folder}/doc.zip">
			<zipfileset dir="index" prefix="index"/> <!-- new fileset -->
			<zipfileset dir="references" prefix="references"/>
			<zipfileset dir="images" prefix="images"/>
			<zipfileset dir="tutorials" prefix="tutorials"/>
			<zipfileset dir="css" prefix="css"/>
		</zip>
	</target>

	<!-- new target -->
	<target name="build.index" depends="init" description="Builds search index for
the plug-in" if="eclipse.running"> 
		<help.buildHelpIndex manifest="plugin.xml" destination="."/>
	</target>

The part I missed, which doesn't seem to appear in the patch files, is that you
need to actually include the <zipfileset dir="index" prefix="index"/> part when
zipping the doc.zip archive. Again, seems obvious now, but I thought I'd
document this gotcha for anyone else that *might* hit the same wall I did in
manually copying over patched code into their customized build.xml scripts.

The complete EMF/SDO/XSD build.xml scripts are here:

http://dev.eclipse.org/viewcvs/indextools.cgi/%7Echeckout%7E/org.eclipse.emf/doc/org.eclipse.emf.doc/
(etc.)