Bug 278879 - [doc] No Debug doc if JDT is not installed
Summary: [doc] No Debug doc if JDT is not installed
Status: ASSIGNED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Debug (show other bugs)
Version: 3.5   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Platform-Debug-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation, helpwanted
: 209606 (view as bug list)
Depends on:
Blocks:
 
Reported: 2009-06-02 18:11 EDT by John Arthorne CLA
Modified: 2020-01-07 22:36 EST (History)
12 users (show)

See Also:


Attachments
Screen shot (22.23 KB, image/png)
2009-06-02 18:38 EDT, John Arthorne CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description John Arthorne CLA 2009-06-02 18:11:02 EDT
Build: 3.5 RC3

The JDT user doc contains information on the import/export wizards for launch configurations and breakpoints. This information should be moved to the platform user doc because these wizards are defined outside JDT in the Eclipse platform. The import wizards should be added to org.eclipse.platform.doc.user/reference/ref-70.htm, and the export wizards in ref-71.htm.
Comment 1 John Arthorne CLA 2009-06-02 18:38:31 EDT
Created attachment 138073 [details]
Screen shot

I happened to be creating screen shots of this for the doc, so for reference here are the wizards available in the platform runtime binary download (no JDT or PDE installed).
Comment 2 Dani Megert CLA 2009-06-04 06:49:41 EDT
The whole Debug doc is in jdt.doc mainly because it describes the JDT case and the pictures also reflect that. As a result there is no doc at all for any debug component including F1/context help if JDT is not installed.

Definitely too late to change for 3.5.
Comment 3 John Arthorne CLA 2009-06-04 08:42:55 EDT
I can understand some of the generic platform debug would be hard to document without using a concrete case like JDT. I think the way to approach this is that it doesn't have to be all or nothing. For example the import/export wizard docs don't seem to have any JDT content, so we could move them to platform doc so that someone using CDT for example would have the documentation available.
Comment 4 Darin Wright CLA 2009-06-04 09:14:36 EDT
I think Pawel is interested in splitting up the debug doc a bit - so CDT can share. I agree this it is too late for such a restructuring in 3.5.
Comment 5 Pawel Piech CLA 2009-06-04 14:20:02 EDT
(In reply to comment #3)
Yes, I agree.  Even for features that have a platform and a JDT component, such as the Debug view, I think it would make sense to document the common functionality in platform.  I would like to investigate this post 3.5.
Comment 6 Pawel Piech CLA 2011-06-03 16:01:45 EDT
*** Bug 209606 has been marked as a duplicate of this bug. ***
Comment 7 Helmut J. Haigermoser CLA 2011-09-05 11:45:44 EDT
(In reply to comment #5)
> (In reply to comment #3)
> Yes, I agree.  Even for features that have a platform and a JDT component, such
> as the Debug view, I think it would make sense to document the common
> functionality in platform.  I would like to investigate this post 3.5.
Pawel, 
what's the status of this, did you get time to look into it for 3.6 or 3.7?
Thanks! :)
Helmut
Comment 8 Pawel Piech CLA 2011-09-07 00:26:31 EDT
Back in June I looked at what it would take to tease out the generic from JDT-specific documentation in debug and I thought it would take me about a week.  So I moved onto other problems.
Comment 9 Helmut J. Haigermoser CLA 2011-09-07 04:41:58 EDT
(In reply to comment #8)
> Back in June I looked at what it would take to tease out the generic from
> JDT-specific documentation in debug and I thought it would take me about a
> week.  So I moved onto other problems.

Thanks Pawel :)
Sounds like this is unlikely to happen, the reason being the quite big effort, right? 
Is there any way we could help you splitting things?
Helmut
Comment 10 Pawel Piech CLA 2011-09-08 11:20:34 EDT
(In reply to comment #9)
> Thanks Pawel :)
> Sounds like this is unlikely to happen, the reason being the quite big effort,
> right? 
> Is there any way we could help you splitting things?
> Helmut

Of course :-), contributions are most welcome.  I estimated 40 hours, but this may be a little optimistic if we have multiple contributors.  Since these changes would involve a lot of file creation/destruction CVS patches would not be the most convenient way of communicating.  Let's at least wait until we move JDT to git later this month then fork the doc plugin on github.
Comment 11 Martin Oberhuber CLA 2012-11-13 17:04:28 EST
CQ:WIND00091153
Comment 12 Eclipse Genie CLA 2020-01-07 14:06:51 EST
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.
Comment 13 Sarika Sinha CLA 2020-01-07 22:36:30 EST
Anyone interested in helping us out?