buildr-bnd 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,21 +1,25 @@
-0.0.5 (September 8, 2010)
-* Added: The bnd parameter "Include-Resource" defaults to project.resources.target if it exists.
-* Added: The bnd.classpath setting was added.
-* Changed: The extension no longer defaults the bnd parameters "Import-Package" and "Export-Package" to *
-* Changed: Stop using absolute paths in requires.
-* Changed: Renamed main.rb to core.rb.
-
-0.0.4 (July 5, 2010)
-* Changed: Separated code into separate files, moved project extension code into a separate module and moved
-  the code into a hierarchy matching the module hierarchy.
-* Added: Add class containing version information about the plugin.  
-
-0.0.3 (June 1, 2010)
-* Added: Buildr::Bnd.remote_repository method to get remote repository for bnd dependency.
-* Deprecated: Buildr::Bnd.remote_repositories method that returned an array of repositories for bnd dependency.
-
-0.0.2 (April 17, 2010)
-* Added: Supported classpath_element method on package task
-
-0.0.1 (April 16, 2010)
-* Initial Release
+0.0.6 (October 12, 2010)
+* Added: The bnd directive "-removeheaders" defaults to "Include-Resource,Bnd-LastModified,Created-By,Implementation-Title,Tool".
+  This removes several *uninteresting* manifest headers.
+
+0.0.5 (September 8, 2010)
+* Added: The bnd parameter "Include-Resource" defaults to project.resources.target if it exists.
+* Added: The bnd.classpath setting was added.
+* Changed: The extension no longer defaults the bnd parameters "Import-Package" and "Export-Package" to *
+* Changed: Stop using absolute paths in requires.
+* Changed: Renamed main.rb to core.rb.
+
+0.0.4 (July 5, 2010)
+* Changed: Separated code into separate files, moved project extension code into a separate module and moved
+  the code into a hierarchy matching the module hierarchy.
+* Added: Add class containing version information about the plugin.  
+
+0.0.3 (June 1, 2010)
+* Added: Buildr::Bnd.remote_repository method to get remote repository for bnd dependency.
+* Deprecated: Buildr::Bnd.remote_repositories method that returned an array of repositories for bnd dependency.
+
+0.0.2 (April 17, 2010)
+* Added: Supported classpath_element method on package task
+
+0.0.1 (April 16, 2010)
+* Initial Release

data/LICENSE

@@ -1,176 +1,176 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.rdoc

@@ -1,230 +1,230 @@
-= buildr-bnd
-
-This is a Buildr extension for packaging OSGi bundles using Bnd (See
-http://www.aqute.biz/Code/Bnd). The extension allows the user to define
-properties/directives to be supplied to the Bnd tool and provides
-reasonable defaults for those that can be derived from the project
-model. Please see the bnd tool for documentation on the available
-properties.
-
-The 'bnd' setting is used to provide directives to the bnd tool that
-are not inherited by subprojects while the standard 'manifest' setting is
-used to define properties that inherited by subprojects.
-
-A typical project that uses the extension may look something like;
-
-  define 'myProject' do
-    ...
-    package(:bundle).tap do |bnd|
-      bnd['Import-Package'] = "*;resolution:=optional"
-      bnd['Export-Package'] = "*;version=#{version}"
-    end
-    ...
-  end
-
-== Installation
-
-The extension is packaged as a gem named "buildr-iidea", consult the ruby gems installation
-steps but typically it is either
-
-  sudo gem install buildr-bnd
-
-for MRI ruby or
-
-  jgem install buildr-bnd
-
-for jruby.
-
-The user then needs to add the following require into the build file:
-
-  require 'buildr_bnd'
-
-If the local maven repository does not contain the required bnd jars they can be downloaded
-but you will need to register the remote repository by adding the following to the build file:
-
-repositories.remote << Buildr::Bnd.remote_repository
-
-== Defaults
-
-The extension sets the following bnd parameters;
-
-* <tt>"Bundle-Version"</tt> defaults to the project version.
-* <tt>"Bundle-SymbolicName"</tt> defaults to the concatenation of the project group
-  and project id, replacing ':' characters with '.'.
-* <tt>"Bundle-Name"</tt> defaults to the project description if present else the project
-  name
-* <tt>"Bundle-Description"</tt> defaults to the project description.
-* <tt>"-classpath"</tt> is set to the compile target directory and any compile time
-  dependencies.
-* <tt>"Include-Resource"</tt> defaults to the dir project.resources.target if it exists.
-
-== Parameters
-
-=== classpath_element
-
-The user can also specify additional elements that are added to the classpath
-using the 'classpath_element' method. If the parameter to this element is a
-task, artifact, artifact namespace etc. then it will be resolved prior to invoking
-bnd.
-
-  define 'foo' do
-    ...
-    package(:bundle).tap do |bnd|
-      # This dependency will be added to classpath
-      bnd.classpath_element 'someOtherExistingFile.zip'
-      # All of these dependencies will be invoked and added to classpath 
-      bnd.classpath_element artifact('com.sun.messaging.mq:imq:jar:4.4')
-      bnd.classpath_element project('bar') # Adds all the packages
-      bnd.classpath_element 'org.apache.ant:ant:jar:1.8.0'
-      bnd.classpath_element file('myLocalFile.jar')
-      ...
-    end
-
-    project 'bar' do
-      ...
-    end
-  end
-
-=== classpath
-
-The user can specify the complete classpath using the 'classpath' method. The classpath
-should be an array of elements. If the element is a task, artifact, artifact namespace etc.
-then it will be resolved prior to invoking bnd. 
-
-  define 'foo' do
-    ...
-    package(:bundle).tap do |bnd|
-      bnd.classpath [ project.compile.target,
-                      'someOtherExistingFile.zip',
-                      artifact('com.sun.messaging.mq:imq:jar:4.4'),
-                      project('bar'),
-                      'org.apache.ant:ant:jar:1.8.0',
-                      file('myLocalFile.jar') ]
-      ...
-    end
-
-    project 'bar' do
-      ...
-    end
-  end
-
-
-== Examples
-
-=== Including non-class resources in a bundle
-
-Bnd can be used to include non-class resources in a bundle. The following
-example includes all resources in 'src/etc' into the bundle.
-
-  require 'buildr_bnd'
-
-  desc 'Including resources example'
-  define 'myproject' do
-    ...
-    package(:bundle).tap do |bnd|
-      bnd['Include-Resource'] = project._('src/etc') + '/'
-      ...
-    end
-  end
-
-=== Using bnd to wrap an existing jar
-
-Bnd can be used to wrap an existing jar as an OSGi bundle. The following
-example wraps the OpenMQ JMS provider as an OSGi bundle.
-
-  require 'buildr_bnd'
-
-  # Add repository for OpenMQ
-  repositories.remote << 'http://download.java.net/maven/2'
-
-  desc 'OSGi bundle for OpenMQ JMS provider client library'
-  define 'com.sun.messaging.mq.imq' do
-    project.version = '4.4'
-    project.group = 'iris'
-    package(:bundle).tap do |bnd|
-      bnd['Import-Package'] = "*;resolution:=optional"
-      bnd['Export-Package'] = "com.sun.messaging.*;version=#{version}"
-      bnd.classpath_element 'com.sun.messaging.mq:imq:jar:4.4'
-    end
-  end
-
-=== Create an OSGi bundle with an Activator
-
-The following example presents a basic buildfile for building an OSGi bundle with
-an activator.
-
-  require 'buildr_bnd'
-
-  # repository for OSGi core bundle
-  repositories.remote << 'https://repository.apache.org/content/repositories/releases'
-
-  desc 'Hello World bundle'
-  define 'helloworld' do
-    project.version = '1.0'
-    project.group = 'org.example'
-    compile.with 'org.apache.felix:org.osgi.core:jar:1.4.0'
-    package(:bundle).tap do |bnd|
-      bnd['Export-Package'] = "org.example.helloworld.api.*;version=#{version}"
-      bnd['Bundle-Activator'] = "org.example.helloworld.Activator"
-    end
-  end
-
-=== Inheriting parameters for bnd tool
-
-The following example shows how you can use 'manifest' to define a bnd parameter that is inherited
-to all child subprojects. The "Bundle-License" defined in the top level project is passed to the bnd
-tool when generating both the 'fe' and 'fi' subprojects but the 'fo' subproject overrides this
-parameter withy a local value.
-
-  require 'buildr_bnd'
-
-  define 'myproject' do
-    manifest['Bundle-License'] = "http://www.apache.org/licenses/LICENSE-2.0"
-    ...
-    define 'fe' do
-      ...
-      package(:bundle).tap do |bnd|
-        ...
-      end
-    end
-
-    define 'fi' do
-      ...
-      package(:bundle).tap do |bnd|
-        ...
-      end
-    end
-
-    define 'fo' do
-      ...
-      package(:bundle).tap do |bnd|
-        bnd['Bundle-License'] = "http://www.apache.org/licenses/LICENSE-1.1"
-      end
-    end
-  end
-
-== Future Work
-
-The following is a list of feature requests for future versions of the extension. Feel free to
-jump in and supply a patch if you have gone ahead and implemented the feature.
-
-=== Support Embed-Dependency equivalent
-
-The maven-bundle-plugin supports Embed-Dependency which can include a jar inside the bundle,
-add manifest directives to include it in the export calculations. One "Embed-Dependency"
-directive may turn into something like
-
-  -classpath=com.ibm.mq.jar
-  Include-Resource=com.ibm.mq.jar
-  Bundle-Classpath=.,com.ibm.mq.jar
-  Private-Package=!*
-  -exportcontents: com.ibm.mq.*
-
-For further discussion on this see;
-* http://www.mail-archive.com/users@felix.apache.org/msg06625.html
-* http://www.mail-archive.com/users@felix.apache.org/msg06626.html
-
-== Credit
-
-The plugin was heavily inspired by the bnd tasks originally authored by Rhett Sutphin. It began
-life as a fork but has been rewritten from scratch to use a different approach.
+= buildr-bnd
+
+This is a Buildr extension for packaging OSGi bundles using Bnd (See
+http://www.aqute.biz/Code/Bnd). The extension allows the user to define
+properties/directives to be supplied to the Bnd tool and provides
+reasonable defaults for those that can be derived from the project
+model. Please see the bnd tool for documentation on the available
+properties.
+
+The 'bnd' setting is used to provide directives to the bnd tool that
+are not inherited by subprojects while the standard 'manifest' setting is
+used to define properties that inherited by subprojects.
+
+A typical project that uses the extension may look something like;
+
+  define 'myProject' do
+    ...
+    package(:bundle).tap do |bnd|
+      bnd['Import-Package'] = "*;resolution:=optional"
+      bnd['Export-Package'] = "*;version=#{version}"
+    end
+    ...
+  end
+
+== Installation
+
+The extension is packaged as a gem named "buildr-iidea", consult the ruby gems installation
+steps but typically it is either
+
+  sudo gem install buildr-bnd
+
+for MRI ruby or
+
+  jgem install buildr-bnd
+
+for jruby.
+
+The user then needs to add the following require into the build file:
+
+  require 'buildr_bnd'
+
+If the local maven repository does not contain the required bnd jars they can be downloaded
+but you will need to register the remote repository by adding the following to the build file:
+
+repositories.remote << Buildr::Bnd.remote_repository
+
+== Defaults
+
+The extension sets the following bnd parameters;
+
+* <tt>"Bundle-Version"</tt> defaults to the project version.
+* <tt>"Bundle-SymbolicName"</tt> defaults to the concatenation of the project group
+  and project id, replacing ':' characters with '.'.
+* <tt>"Bundle-Name"</tt> defaults to the project description if present else the project
+  name
+* <tt>"Bundle-Description"</tt> defaults to the project description.
+* <tt>"-classpath"</tt> is set to the compile target directory and any compile time
+  dependencies.
+* <tt>"Include-Resource"</tt> defaults to the dir project.resources.target if it exists.
+
+== Parameters
+
+=== classpath_element
+
+The user can also specify additional elements that are added to the classpath
+using the 'classpath_element' method. If the parameter to this element is a
+task, artifact, artifact namespace etc. then it will be resolved prior to invoking
+bnd.
+
+  define 'foo' do
+    ...
+    package(:bundle).tap do |bnd|
+      # This dependency will be added to classpath
+      bnd.classpath_element 'someOtherExistingFile.zip'
+      # All of these dependencies will be invoked and added to classpath 
+      bnd.classpath_element artifact('com.sun.messaging.mq:imq:jar:4.4')
+      bnd.classpath_element project('bar') # Adds all the packages
+      bnd.classpath_element 'org.apache.ant:ant:jar:1.8.0'
+      bnd.classpath_element file('myLocalFile.jar')
+      ...
+    end
+
+    project 'bar' do
+      ...
+    end
+  end
+
+=== classpath
+
+The user can specify the complete classpath using the 'classpath' method. The classpath
+should be an array of elements. If the element is a task, artifact, artifact namespace etc.
+then it will be resolved prior to invoking bnd. 
+
+  define 'foo' do
+    ...
+    package(:bundle).tap do |bnd|
+      bnd.classpath [ project.compile.target,
+                      'someOtherExistingFile.zip',
+                      artifact('com.sun.messaging.mq:imq:jar:4.4'),
+                      project('bar'),
+                      'org.apache.ant:ant:jar:1.8.0',
+                      file('myLocalFile.jar') ]
+      ...
+    end
+
+    project 'bar' do
+      ...
+    end
+  end
+
+
+== Examples
+
+=== Including non-class resources in a bundle
+
+Bnd can be used to include non-class resources in a bundle. The following
+example includes all resources in 'src/etc' into the bundle.
+
+  require 'buildr_bnd'
+
+  desc 'Including resources example'
+  define 'myproject' do
+    ...
+    package(:bundle).tap do |bnd|
+      bnd['Include-Resource'] = project._('src/etc') + '/'
+      ...
+    end
+  end
+
+=== Using bnd to wrap an existing jar
+
+Bnd can be used to wrap an existing jar as an OSGi bundle. The following
+example wraps the OpenMQ JMS provider as an OSGi bundle.
+
+  require 'buildr_bnd'
+
+  # Add repository for OpenMQ
+  repositories.remote << 'http://download.java.net/maven/2'
+
+  desc 'OSGi bundle for OpenMQ JMS provider client library'
+  define 'com.sun.messaging.mq.imq' do
+    project.version = '4.4'
+    project.group = 'iris'
+    package(:bundle).tap do |bnd|
+      bnd['Import-Package'] = "*;resolution:=optional"
+      bnd['Export-Package'] = "com.sun.messaging.*;version=#{version}"
+      bnd.classpath_element 'com.sun.messaging.mq:imq:jar:4.4'
+    end
+  end
+
+=== Create an OSGi bundle with an Activator
+
+The following example presents a basic buildfile for building an OSGi bundle with
+an activator.
+
+  require 'buildr_bnd'
+
+  # repository for OSGi core bundle
+  repositories.remote << 'https://repository.apache.org/content/repositories/releases'
+
+  desc 'Hello World bundle'
+  define 'helloworld' do
+    project.version = '1.0'
+    project.group = 'org.example'
+    compile.with 'org.apache.felix:org.osgi.core:jar:1.4.0'
+    package(:bundle).tap do |bnd|
+      bnd['Export-Package'] = "org.example.helloworld.api.*;version=#{version}"
+      bnd['Bundle-Activator'] = "org.example.helloworld.Activator"
+    end
+  end
+
+=== Inheriting parameters for bnd tool
+
+The following example shows how you can use 'manifest' to define a bnd parameter that is inherited
+to all child subprojects. The "Bundle-License" defined in the top level project is passed to the bnd
+tool when generating both the 'fe' and 'fi' subprojects but the 'fo' subproject overrides this
+parameter withy a local value.
+
+  require 'buildr_bnd'
+
+  define 'myproject' do
+    manifest['Bundle-License'] = "http://www.apache.org/licenses/LICENSE-2.0"
+    ...
+    define 'fe' do
+      ...
+      package(:bundle).tap do |bnd|
+        ...
+      end
+    end
+
+    define 'fi' do
+      ...
+      package(:bundle).tap do |bnd|
+        ...
+      end
+    end
+
+    define 'fo' do
+      ...
+      package(:bundle).tap do |bnd|
+        bnd['Bundle-License'] = "http://www.apache.org/licenses/LICENSE-1.1"
+      end
+    end
+  end
+
+== Future Work
+
+The following is a list of feature requests for future versions of the extension. Feel free to
+jump in and supply a patch if you have gone ahead and implemented the feature.
+
+=== Support Embed-Dependency equivalent
+
+The maven-bundle-plugin supports Embed-Dependency which can include a jar inside the bundle,
+add manifest directives to include it in the export calculations. One "Embed-Dependency"
+directive may turn into something like
+
+  -classpath=com.ibm.mq.jar
+  Include-Resource=com.ibm.mq.jar
+  Bundle-Classpath=.,com.ibm.mq.jar
+  Private-Package=!*
+  -exportcontents: com.ibm.mq.*
+
+For further discussion on this see;
+* http://www.mail-archive.com/users@felix.apache.org/msg06625.html
+* http://www.mail-archive.com/users@felix.apache.org/msg06626.html
+
+== Credit
+
+The plugin was heavily inspired by the bnd tasks originally authored by Rhett Sutphin. It began
+life as a fork but has been rewritten from scratch to use a different approach.