Jump to: navigation, search

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

Line 14: Line 14:
  
 
== Adding a library for the first time ==
 
== Adding a library for the first time ==
TBD
+
Use this approach when you have a library (i.e., JAR) that you want to convert into a bundle.
 +
# Start the '''New > Project > Plugin Development > Plug-in from existing JAR''' wizard to effectively import the library into a new project. 
 +
# Enter the new bundle name etc.
 +
# Ensure that the '''Analyze library contents and add dependencies''' checkbox is selected.
 +
# Ensure that the '''Unzip the JAR into the project''' checkbox is selected. 
 +
# Click '''Finish'''
  
 
== Adding a library that is already a bundle ==
 
== Adding a library that is already a bundle ==

Revision as of 11:16, 18 November 2006

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. 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 
    
version of the library being maintained. For example, if you are looking for javax.servlet version 2.3, check out the v2_3 branch of the javax.servlet project.
  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. Since all real content in Orbit is maintained in branches, immediately create a 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. Check out the existing version of the library using 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
  5. 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.
  6. Commit the changes to the new project (e.g., com.example.foo) to create an exact copy of the original bundle project in a branch in the Orbit repository.

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. Start the New > Project > Plugin Development > Plug-in from existing JAR wizard to effectively import the library into a new project.
  2. Enter the new bundle name etc.
  3. Ensure that the Analyze library contents and add dependencies checkbox is selected.
  4. Ensure that the Unzip the JAR into the project checkbox is selected.
  5. Click Finish

Adding a library that is already a bundle

TBD