Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 332296 - Update Help for the Builder Framework
Summary: Update Help for the Builder Framework
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Resources (show other bugs)
Version: 3.7   Edit
Hardware: PC All
: P3 normal (vote)
Target Milestone: 3.7 RC1   Edit
Assignee: James Blackburn CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 325489 329338
Blocks:
  Show dependency tree
 
Reported: 2010-12-10 06:33 EST by Szymon Brandys CLA
Modified: 2011-05-09 06:14 EDT (History)
1 user (show)

See Also:
Szymon.Brandys: review+

Attachments
patch 1 (14.29 KB, patch)
2011-04-27 04:50 EDT, James Blackburn CLA 		no flags Details | Diff
patch 2 (15.85 KB, patch)
2011-05-09 05:15 EDT, James Blackburn CLA 		no flags Details | Diff
Show Obsolete (1) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Szymon Brandys CLA 2010-12-10 06:33:02 EST 
These newly introduced concepts should be documented in Eclipse Help.
Comment 1 Szymon Brandys CLA 2011-03-22 13:08:49 EDT 
Just a reminder.
Comment 2 James Blackburn CLA 2011-04-27 04:50:32 EDT 
Created attachment 194135 [details]
patch 1
Comment 3 James Blackburn CLA 2011-04-27 04:56:25 EDT 
Szymon if you could review/tweak/commit the attached documentation that would be appreciated.  Ping back to me if any larger changes are required.

I've checked that it passes the w3c validator, and I believe all the links to the reference javadoc API are correct (though javadoc fails to build the platform documentation in my workspace...)
Comment 4 Szymon Brandys CLA 2011-05-09 04:49:06 EDT 
Comments:
1) You need to update topics_Guide.xml. You should add a new topic for Build Configs under Advanced Res Concepts and link it to resAdv_buildconfigs.htm
2) I think we should leave </p> tag in resAdv_builders.htm line 341
3) resAdv_buildconfigs.htm line 148, I would use IncrementalprojectDelta#getDelta(IProject) instead of #getDelta(IProject)

Otherwise looks good.
Comment 5 James Blackburn CLA 2011-05-09 05:15:30 EDT 
Created attachment 195049 [details]
patch 2

(In reply to comment #4)
> Comments:
> 1) You need to update topics_Guide.xml. You should add a new topic for Build
> Configs under Advanced Res Concepts and link it to resAdv_buildconfigs.htm

Done

> 2) I think we should leave </p> tag in resAdv_builders.htm line 341

I removed this as it upsets the w3c validator: http://validator.w3.org/check
I've removed the <p> at line 326 which was matched by line 341.

> 3) resAdv_buildconfigs.htm line 148, I would use
> IncrementalprojectDelta#getDelta(IProject) instead of #getDelta(IProject)

Done. Made it explicit: IncrementalProjectBuilder#...
Comment 6 Szymon Brandys CLA 2011-05-09 05:45:54 EDT 
In resAdv_buildconfigs.htm line 56, there is "We distinguish between client API sand builder API.". Should be "and", not "sand". Otherwise looks good.
Comment 7 Szymon Brandys CLA 2011-05-09 06:00:45 EDT 
I fixed the "sand" and release the update. 
It seems that James does not have rights to update the doc. I thought that all committers can do it. Kim, could you explain?
Comment 8 James Blackburn CLA 2011-05-09 06:14:14 EDT 
(In reply to comment #7)
> I fixed the "sand" and release the update. 
> It seems that James does not have rights to update the doc. I thought that all
> committers can do it. Kim, could you explain?

I think I wasn't correctly logged in for my checkout of doc.isv... 

Also Not sure which projects I have commit permission on, Portal shows:
  eclipse.platform.resources
  eclipse.platform.runtime
And the project summary doesn't say which repositories this corresponds to:
  http://www.eclipse.org/projects/project_summary.php?projectid=eclipse.platform.resources