ServiceMix
  1. ServiceMix
  2. SM-2038

add <Bundle-Description> osgi header to manifest

    Description

    To make our bundles more self-documenting we should add the osgi header "Bundle-Description" to the manifest of our bundles. This header should be filled with the pom description. If the description is not existing or not sufficient it should be added/improved as well.

    In the pom:
       <description>PUT IN A SUFFICIENT DESCRIPTION HERE WHICH DESCRIBES THE FEATURES THIS BUNDLE OFFERS...</description>
    
    In the Felix plugin configuration:
       <Bundle-Description>${project.description}</Bundle-Description>
    

    The header has been already added to all poms, but the description needs attention everywhere!

      Activity

      Hide
      Gert Vanthienen added a comment -

      Added descriptions for all the NMR bundles in http://svn.apache.org/viewvc?view=revision&revision=1060269

      Show
      Gert Vanthienen added a comment - Added descriptions for all the NMR bundles in http://svn.apache.org/viewvc?view=revision&revision=1060269
      Hide
      Lars Heinemann added a comment - - edited

      added description for smx4 features.
      added description for components.
      Servicemix-Utils already had a description.

      Show
      Lars Heinemann added a comment - - edited added description for smx4 features. added description for components. Servicemix-Utils already had a description.
      Hide
      Jean-Baptiste Onofré added a comment -

      I add it into ServiceMix Bundles.

      Show
      Jean-Baptiste Onofré added a comment - I add it into ServiceMix Bundles.
      Hide
      Jean-Baptiste Onofré added a comment -

      I began to add enhanced Bundle-Description is ServiceMix Bundles: revision 1060829.

      I keep on running

      Show
      Jean-Baptiste Onofré added a comment - I began to add enhanced Bundle-Description is ServiceMix Bundles: revision 1060829. I keep on running
      Hide
      Jean-Baptiste Onofré added a comment -

      Regarding KARAF-403, I'm gonna:

      • update the bundles-pom to handle filtered resource
      • add OSGI-INF/bundle.info resource that will be read by Karaf
      • the <description/> will contain only the bundle synopsis

      The same change will be performed on NMR, components, etc.

      Show
      Jean-Baptiste Onofré added a comment - Regarding KARAF-403 , I'm gonna: update the bundles-pom to handle filtered resource add OSGI-INF/bundle.info resource that will be read by Karaf the <description/> will contain only the bundle synopsis The same change will be performed on NMR, components, etc.
      Hide
      Jean-Baptiste Onofré added a comment -

      First bundles which use the "new" Karaf OSGI-INF/bundle.info: revision 1061317.

      Show
      Jean-Baptiste Onofré added a comment - First bundles which use the "new" Karaf OSGI-INF/bundle.info: revision 1061317.
      Hide
      Jean-Baptiste Onofré added a comment -

      Usage of ASCII formatting (bold and color): revision 1061726.

      Show
      Jean-Baptiste Onofré added a comment - Usage of ASCII formatting (bold and color): revision 1061726.
      Hide
      Jean-Baptiste Onofré added a comment -

      Resuming OSGI-INF/bundle.info addition: revision 1061880.

      Show
      Jean-Baptiste Onofré added a comment - Resuming OSGI-INF/bundle.info addition: revision 1061880.
      Hide
      Jean-Baptiste Onofré added a comment -

      ServiceMix Bundles now contain the OSGI-INF/bundle.info entry: revision 1063183.

      Show
      Jean-Baptiste Onofré added a comment - ServiceMix Bundles now contain the OSGI-INF/bundle.info entry: revision 1063183.
      Hide
      Jean-Baptiste Onofré added a comment -

      I checked the descriptor and added OSGI-INF/bundle.info in ServiceMix Utils:

      Committing to https://svn.apache.org/repos/asf/servicemix/utils/trunk ...
      M pom.xml
      A src/main/resources/OSGI-INF/bundle.info
      Committed r1129667

      Show
      Jean-Baptiste Onofré added a comment - I checked the descriptor and added OSGI-INF/bundle.info in ServiceMix Utils: Committing to https://svn.apache.org/repos/asf/servicemix/utils/trunk ... M pom.xml A src/main/resources/OSGI-INF/bundle.info Committed r1129667

        People

        • Assignee:
          Jean-Baptiste Onofré
          Reporter:
          Lars Heinemann
        • Votes:
          0 Vote for this issue
          Watchers:
          0 Start watching this issue

          Dates

          • Created:
            Updated:
            Resolved:

            Development