Jump to: navigation, search

Difference between revisions of "Extending or Contributing to Buckminster"

Line 1: Line 1:
 
{{Backlink|Buckminster Project}}
 
{{Backlink|Buckminster Project}}
  
If you are going to be working with Buckminster itself, writing your own extensions, or provide patches, you should first install Buckminster as described in [[Installing Buckminster]]. As Buckminster source is stored in a Subversion repository, you need to install either a Subversive or a Subclipse client, as described on the [[Installing Buckminster]] page.
+
If you are going to be working with Buckminster itself, writing your own extensions, or provide patches, you should first install Buckminster as described in [http://www.eclipse.org/downloads/download.php?file=/tools/buckminster/doc/BuckyBook.pdf The Definitive Guide]. As Buckminster source is stored in a Subversion repository, you need to install either a Subversive or a Subclipse client.
  
 
=Installation for Buckminster contributors=
 
=Installation for Buckminster contributors=
In addition to a regular install of Eclipse, and Buckminster, you will also need to install the RCP Delta Pack. Once the delta pack is in place, you can use Buckminster to get all of the source for Buckminster itself.
+
==Set up a platform agnostic target platform==
 +
Prior to resolving this query you MUST ensure that your workspace is set up with a target platform containing the Eclipse SDK and the delta pack.
 +
#Go to ''Window'' -> ''Preferences'' -> ''Plugin-In Development'' -> ''Target Platform'' and select ''Add...''
 +
#A wizard pops up. On the first page, check ''Nothing: Start with an empty target definition''
 +
#On the next page, give you definition a ''Name'' such as "Eclipse SDK with delta pack".
 +
#Click ''Add...'' (under the Locations tab).
 +
#An ''Add Content'' Dialog pops up. Select ''Software Site''
 +
#Select ''The Eclipse Project Updates'' site and the ''Eclipse SDK'' feature for install.
 +
#Uncheck the ''Include required software''
 +
#Check the ''Include all environmnents''
 +
#Click ''Finish'' to get back to the Target Content page
 +
#Click ''Finish'' to get back to the Preferences page
 +
#Select (put a check mark in) the new platform to make it current.
 +
#Click ''OK''
  
 +
We recommend that you restart your Eclipse at this point although it should not be strictly necessary.
  
When resolving this query you MUST ensure that your Eclipse installation is 3.4 and contains the RCP delta pack.
+
==Populating the workspace==
#Go to [http://download.eclipse.org/eclipse/downloads/ http://download.eclipse.org/eclipse/downloads/].
+
#Execute one of the following component queries - (Select "File" > "Open a Component Query", and paste in out of these URL's depending on which version you want:
#Select the latest release.
+
#Navigate to the '''''RCP SDK''''' section where you will find a download link for the ''"RCP delta pack"'' zip.
+
#Download and unpack into your Eclipse installation directory. (unzip it in the eclipse install-directory that holds "plugins" and "features")
+
#Restart Eclipse and execute one of the following component queries - (Select "File" > "Open a Component Query", and paste in out of these URL's depending on which version you want:
+
 
:* For '''head development''' [http://www.eclipse.org/buckminster/samples/queries/buckminster-dev.cquery http://www.eclipse.org/buckminster/samples/queries/buckminster-dev.cquery]  
 
:* For '''head development''' [http://www.eclipse.org/buckminster/samples/queries/buckminster-dev.cquery http://www.eclipse.org/buckminster/samples/queries/buckminster-dev.cquery]  
:* For '''eclipse 3.4.x''' [http://www.eclipse.org/buckminster/samples/queries/buckminster.cquery http://www.eclipse.org/buckminster/samples/queries/buckminster.cquery]  
+
:* For '''eclipse 3.5.x''' [http://www.eclipse.org/buckminster/samples/queries/buckminster-3.4.cquery http://www.eclipse.org/buckminster/samples/queries/buckminster.cquery]  
 
# Press "Resolve & Materialize" in the CQUERY editor that appears
 
# Press "Resolve & Materialize" in the CQUERY editor that appears
 
# Buckminster will now fetch and build Buckminster from source.
 
# Buckminster will now fetch and build Buckminster from source.

Revision as of 01:53, 27 July 2009

< To: Buckminster Project

If you are going to be working with Buckminster itself, writing your own extensions, or provide patches, you should first install Buckminster as described in The Definitive Guide. As Buckminster source is stored in a Subversion repository, you need to install either a Subversive or a Subclipse client.

Installation for Buckminster contributors

Set up a platform agnostic target platform

Prior to resolving this query you MUST ensure that your workspace is set up with a target platform containing the Eclipse SDK and the delta pack.

  1. Go to Window -> Preferences -> Plugin-In Development -> Target Platform and select Add...
  2. A wizard pops up. On the first page, check Nothing: Start with an empty target definition
  3. On the next page, give you definition a Name such as "Eclipse SDK with delta pack".
  4. Click Add... (under the Locations tab).
  5. An Add Content Dialog pops up. Select Software Site
  6. Select The Eclipse Project Updates site and the Eclipse SDK feature for install.
  7. Uncheck the Include required software
  8. Check the Include all environmnents
  9. Click Finish to get back to the Target Content page
  10. Click Finish to get back to the Preferences page
  11. Select (put a check mark in) the new platform to make it current.
  12. Click OK

We recommend that you restart your Eclipse at this point although it should not be strictly necessary.

Populating the workspace

  1. Execute one of the following component queries - (Select "File" > "Open a Component Query", and paste in out of these URL's depending on which version you want:
  1. Press "Resolve & Materialize" in the CQUERY editor that appears
  2. Buckminster will now fetch and build Buckminster from source.

More elaborate patches to Buckminster

If you are going to contribute code to Buckminster in the form of patches, you may want to look at some of the coding policies and conventions used by Buckminster Committers.