This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 55077 - The profiler help set does not merge into the IDE help on JDK 1.4.2
Summary: The profiler help set does not merge into the IDE help on JDK 1.4.2
Status: CLOSED FIXED
Alias: None
Product: platform
Classification: Unclassified
Component: Help System (show other bugs)
Version: 4.x
Hardware: PC All
: P2 blocker (vote)
Assignee: Stanislav Aubrecht
URL:
Keywords:
Depends on:
Blocks: 48525
  Show dependency tree
 
Reported: 2005-02-16 16:44 UTC by iformanek
Modified: 2008-12-22 23:19 UTC (History)
3 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description iformanek 2005-02-16 16:44:41 UTC
Milestone 5 of the profiler adds its own helpset 
into the Services/JavaHelp folder.

If the IDE runs on JDK 1.5, the Help | Help 
Contents correctly has the profiler help merged 
in, if the IDE runs on JDK 1.4.2, it does not.

I've spent about a day trying to figure out what 
is happening, but ws not able to make any 
progress => filing an issue against the help 
system, as I believe we declare everything 
correct.

Reproducible in NB 4.0, and all build (EA2, 
recent qbuild) of 4.1
Comment 1 iformanek 2005-02-18 12:43:19 UTC
Bumping up the priority, as currently this does not have any 
workaround, and if not resolved for 4.1, th eprofiler, once released, 
would not be able to provide any JavaHelp help.
Comment 2 Jan Chalupa 2005-02-21 10:59:03 UTC
Stan, as discussed, re-assigning to you.

Patrick, any ideas? Have you encountered any JDK specific issues when
merging help sets?
Comment 3 Patrick Keegan 2005-02-21 14:43:09 UTC
Ian, are you using version 2.0_02 when building Javahelp?
Comment 4 iformanek 2005-02-21 14:49:50 UTC
I am using JK 2.0_01
Comment 5 Patrick Keegan 2005-02-21 14:52:37 UTC
It doesn't seem like this should make a difference, but I think I
heard of another case where it does. Try _02.
Comment 6 iformanek 2005-02-21 15:09:08 UTC
Just tried, but it does not help.
(Nonetheless will modify the build to use _02 from now on)
Comment 7 Stanislav Aubrecht 2005-02-25 11:00:49 UTC
i found out that the problem is in profiler's helpset-decl.xml file.
the xml is correct but the file contains three bytes at its beginning
(ef bb bf) identifying it as an utf-8 encoded file.

it seems that the xml parser cannot digest this under jdk 1.4 as it
reports an xml parsing error.

removing these three bytes makes the helpset merge correctly into the
main helpset.
Comment 8 iformanek 2005-02-25 11:16:05 UTC
Cool, thanks!
BTW, can you please modify the code so that it provides some 
meaningful error reporting in this case? Figuring this out took much 
larger amount of time than it should.
Comment 9 Stanislav Aubrecht 2005-02-25 11:21:11 UTC
unfortunatelly javahelp module cannot report such an error as it
happens deep inside the fileobjects/dataobjects/loaders code so these
mangled helpset declarations won't even arrive to the javahelp module.
Comment 10 Jaroslav Tulach 2005-02-25 15:24:33 UTC
We already have validation for menu, toolbar, windowsystem and it is
possible to add also one for javahelp. The javahelp module tests can
just scan the folder dedicated to its XML files and verify that all of
them represent HelpSet. Possible, however this is going to help only
modules  in standard CVS as you need to run commit validation to
invoke this test, which I doubt profiler runs.
Comment 11 _ rkubacki 2005-02-28 12:33:19 UTC
Another possibility is to write a sanity-check task into
nbbuild/build.xml for validating of XML files in CVS tree. See the
comment at the beggining of this file.
Comment 12 Stanislav Aubrecht 2005-03-01 09:53:08 UTC
fixed

i added a sanity check for the Services/JavaHelp folder.
module developers are encouraged to use this test to validate their
helpset declarations.

Checking in
test/unit/src/org/netbeans/core/javahelp/ValidateLayerJavaHelpTest.java;
/cvs/core/javahelp/test/unit/src/org/netbeans/core/javahelp/ValidateLayerJavaHelpTest.java,v
 <--  ValidateLayerJavaHelpTest.java
initial revision: 1.1
done
Comment 13 Tomas Hurka 2005-03-02 08:03:05 UTC
Unfortunately the fix was to correct and caused commit validation to fail. The change in 
master-config.xml was rolled back. 

[thurka-mac:nb_all/xtest/instance] thurka% cvs commit -m "rollback of last change to fix 
broken commit validation" master-config.xml
Checking in master-config.xml;
/cvs/xtest/instance/master-config.xml,v  <--  master-config.xml
new revision: 1.127; previous revision: 1.126
done
 
Comment 14 Stanislav Aubrecht 2005-03-03 10:59:56 UTC
fixed the broken properties file

Checking in project.properties;
/cvs/core/javahelp/nbproject/project.properties,v  <--  project.properties
new revision: 1.5; previous revision: 1.4
done
Comment 15 Jesse Glick 2005-03-31 21:22:08 UTC
ValidateLayerJavaHelpTest.java should not be in core/javahelp/test/unit/src; it
should be in ide/test/qa-functional/src. It is not a unit test of the JavaHelp
API; it is a functional test of the complete IDE build. (Yes I know there are
ValidateLayer*Test.java in core/test/unit/src but those should be moved too, we
just haven't gotten to it yet.)
Comment 16 Jaroslav Tulach 2005-04-05 08:26:28 UTC
I've added Jesse's comment to issue 41356.