Difference between revisions of "Orbit/Adding Bundles to Orbit"

Revision as of 00:10, 22 November 2006

Setting up CVS for the new bundle

<div id="newProject"/>

Creating a new project for an Orbit bundle

When adding an entirely new library to Orbit, you have to create a project in CVS to house the content. Follow these steps to set this up the first time.

1. In your workspace, create a project with the desired name (see Bundle Naming). For this example we'll use com.example.foo.
2. In the project, create a readme.txt file that alerts users to the fact that the real content of the project is maintained in CVS branches. Something like

   Work in this project happens in various branches according to the 

1. Share the project into the Orbit repository using the Team > Share Project... wizard. There select CVS then the "dev.eclipse.org/cvsroot/tools" repository. In the following page, choose Use specified module name and enter "org.eclipse.orbit/com.example.foo" (remember to fill-in your bundle name). Finish off the wizard steps.
2. Immediately create a new branch of the newly created project following the steps in [[#newBranch|Creating a new branch].

<div id="newBranch"/>

Creating a new branch of an existing Orbit project

Since all real content in Orbit is maintained in branches, HEAD never contains any real content (just the readme.txt file described above). Follow these steps to create a new branch.

1. Check out HEAD of the desired project, or Replace with... HEAD if HEAD of the project is not currently in the workspace.
2. Create a new branch using the Team > Branch... wizard. You will be asked to enter a branch name. The typical pattern for that is "v<version number>" where the version number is that which was assigned by the original library producers with the '.' (period) characters replaced with '_' (underscore) characters. So a library whose version is 2.3 would go in the v2_3 branch. Ensure that the "Work with this branch" option is selected and and finish off the wizard.
3. Delete the readme.txt file
4. Proceed to add the desired content and eventually commit the changes into the branch.

Moving an existing bundle to Orbit

Taking a library that is already bundled in another Eclipse project and adding it to Orbit is quite straightforward.

1. Create a new project or new branch of an existing project to hold the bundle's content.
2. Check out the existing version of the library into a project using a temporary name. You need to do this if the new and old projects have the same name. Use the Team > Check Out As... wizard from the repository navigator. Pick any name you like for the new project. For example, com.example.foo.old helps keep things clear. This project will only be in your workspace for a few minutes.
3. Once the original project is checked out, copy and paste all content from the old project into the project you created at the beginning of these steps and delete the old project. Note that you should use the Resource Navigator to ensure you get all the content.
4. Commit the changes to the destination project to create an exact copy of the original bundle project in a branch in the Orbit repository.

<div id="addingLibrary"/>

Adding a library for the first time

Use this approach when you have a library (i.e., JAR) that you want to convert into a bundle.

1. Create a new project or new branch of an existing project to hold the bundle's content.
2. Start the New > Project > Plugin Development > Plug-in from existing JAR wizard to effectively import the library into a new project.
3. Enter the new bundle name etc.
4. Ensure that the Analyze library contents and add dependencies checkbox is selected.
5. Ensure that the Unzip the JAR into the project checkbox is selected.
6. Click Finish

Adding a library that is already a bundle

TBD

<div id="addingSource"/>

Adding source for Orbit bundles

Adding the associated source for orbit bundles makes it easier to use and debug in situations where logic enters third party libraries. Orbit projects should if possible include the source code and add the related project bindings as follows.

1. Create a zip file named "src.zip" containing the java files and other resources useful for debugging.
2. Place the "src.zip" file at the root of the third party bundle project.
3. Select the project properties and link the src.zip source attachment to your classes on the "Java Build Path" -> "Libraries" tab.
4. Open your project's "build.properties" and switch to the PDE Build tab.
5. Select and check src.zip under "Source Build" and then save your changes.
6. TBD - Add the appropriate entry in about.html

Packaging licensing information

TBD