[pkg-java] r9728 - trunk/bnd/debian

Fri Aug 7 23:08:33 UTC 2009

Author: ludovicc-guest
Date: 2009-08-07 23:08:33 +0000 (Fri, 07 Aug 2009)
New Revision: 9728

Added:
   trunk/bnd/debian/bnd.pod
   trunk/bnd/debian/manpages
   trunk/bnd/debian/maven.rules
Modified:
   trunk/bnd/debian/TODO
   trunk/bnd/debian/changelog
   trunk/bnd/debian/orig-tar.sh
   trunk/bnd/debian/rules
Log:
Add man page for bnd script

Modified: trunk/bnd/debian/TODO
===================================================================

--- trunk/bnd/debian/TODO	2009-08-07 16:15:24 UTC (rev 9727)
+++ trunk/bnd/debian/TODO	2009-08-07 23:08:33 UTC (rev 9728)
@@ -1,3 +1,2 @@
-* Man page
 * Build the full jar with the OSGi and Eclipse dependencies (runtime and eclipse sub-packages)
 * Clarify the licensing issues for some files (BndScanner.java and Filter.java)

Added: trunk/bnd/debian/bnd.pod
===================================================================
--- trunk/bnd/debian/bnd.pod	                        (rev 0)
+++ trunk/bnd/debian/bnd.pod	2009-08-07 23:08:33 UTC (rev 9728)
@@ -0,0 +1,99 @@
+=head1 NAME
+
+bnd - Create and diagnose OSGi R4 bundles.
+
+=head1 SYNOPSIS
+
+B<bnd> [S<I<general-options>>] [S<I<cmd>>] [S<I<cmd-options>>]
+
+B<bnd> [S<I<general-options>>] E<lt>fileE<gt>.jar
+
+B<bnd> [S<I<general-options>>] E<lt>fileE<gt>.bnd
+
+=head1 DESCRIPTION
+
+The bnd tool helps you create and diagnose OSGi R4 bundles. The key functions are:
+
+ * Show the manifest and JAR contents of a bundle
+ * Wrap a JAR so that it becomes a bundle
+ * Create a Bundle from a specification and a class path
+ * Verify the validity of the manifest entries 
+
+=head1 GENERAL OPTIONS
+
+=over
+
+=item -failok
+
+Same as the property -failok. The current run will create a JAR file even if there were errors.
+
+=item -exceptions
+
+Will print the exception when the software has ran into a bad exception and bails out. Normally only a message is printed. For debugging or diagnostic reasons, the exception stack trace can be very helpful.
+
+=back
+
+=head1 COMMANDS
+
+=over
+
+=item print ( -verify | -manifest | -list | - all ) * E<lt>fileE<gt>.jar +
+
+The print function will take a list of JAR file and print one or more aspect of the JAF riles. The following aspects can be added.
+
+    * -verify - Verify the JAR for consistency with the specification
+      The print will exit with an error if the verify fails.
+    * -manifest - Show the manifest
+    * -list - List the entries in the JAR file
+    * -all - Do all (this is the default. 
+
+C<bnd print -verify *.jar>
+
+=item build ( -classpath LIST | -eclipse <lt>fileE<gt> | -noeclipse | -output E<lt>fileE<gt> ) * E<lt>fileE<gt>.bnd +
+
+The build function will assemble a bundle from the bnd specification. The default name of the output bundle is the name of the bnd file with a .jar extension.
+
+    * -classpath - A list of JAR files and/or directories that should
+      be placed on the class path before the calculation starts.
+    * -eclipse - Parse the file as an Eclipse .classpath file, use
+      the information to create an Eclipse's project class path.
+      If this option is used, the default .classpath file is not read
+    * -noeclipse - Do not parse the .classpath file of an Eclipse
+      project.
+    * -output - Override the default output name of the bundle or the
+      directory. If the output is a directory, the name will be
+      derived from the bnd file name. 
+
+C<bnd build -classpath bin -noeclipse -output test.jar xyz.bnd>
+
+=item wrap ( -classpath (<lt>fileE<gt>(','<lt>fileE<gt>)*)-output <lt>fileE|dir<gt> | -properties <lt>fileE<gt> ) *
+-ignoremanifest? <lt>fileE<gt>.jar *
+
+The wrap command takes an existing JAR file and guesses the manifest headers that will make this JAR useful for an OSGi Service Platform. If the output file is not overridden, the name of the input file is used with a .bar extension. The default bnd file for the header calculation is:
+
+ Export-Package: * 
+ Import-Package: <packages inside the target jar>
+
+If the target bundle has a manifest, the headers are merged with the properties.
+
+The defaults can be overridden with a specific properties file.
+
+    * -output - Set the output file or directory
+    * -classpath - Sets the classpath as a comma separated list
+    * -properties - Use a special property file for the manifest
+      calculation.
+    * -ignoremanifest - Do not include the manifest headers from
+      the target bundle 
+
+C<bnd wrap -classpath osgi.jar *.jar>
+
+=back
+
+=head1 SEE ALSO
+
+L<http://www.aqute.biz/Code/Bnd>
+
+=head1 AUTHOR
+
+Ludovic Claude <ludovic.claude at laposte.net>
+

Modified: trunk/bnd/debian/changelog
===================================================================
--- trunk/bnd/debian/changelog	2009-08-07 16:15:24 UTC (rev 9727)
+++ trunk/bnd/debian/changelog	2009-08-07 23:08:33 UTC (rev 9728)
@@ -1,5 +1,9 @@
-bnd (0.0.337.2-2) UNRELEASED; urgency=low
+bnd (0.0.337.2-2) unstable; urgency=low
 
+  [Ludovic Claude]
+  * Add man page for bnd script
+
+  [Damien Raude-Morvan]
   * Add myself as Uploaders
   * Install a "bnd" shell script to execute BND command line interface
     - Add debian/bnd.sh script
@@ -7,7 +11,7 @@
   * Add debian/watch
   * Remove duplicate Section declaration on first binary package
 
- -- Damien Raude-Morvan <drazzib at drazzib.com>  Tue, 04 Aug 2009 22:43:11 +0200
+ -- Ludovic Claude <ludovic.claude at laposte.net>  Fri, 07 Aug 2009 14:12:23 +0100
 
 bnd (0.0.337.2-1) experimental; urgency=low
 

Added: trunk/bnd/debian/manpages
===================================================================
--- trunk/bnd/debian/manpages	                        (rev 0)
+++ trunk/bnd/debian/manpages	2009-08-07 23:08:33 UTC (rev 9728)
@@ -0,0 +1 @@
+debian/bnd.1

Added: trunk/bnd/debian/maven.rules
===================================================================
--- trunk/bnd/debian/maven.rules	                        (rev 0)
+++ trunk/bnd/debian/maven.rules	2009-08-07 23:08:33 UTC (rev 9728)
@@ -0,0 +1 @@
+biz.aQute s/bnd/bndlib/

Modified: trunk/bnd/debian/orig-tar.sh
===================================================================
--- trunk/bnd/debian/orig-tar.sh	2009-08-07 16:15:24 UTC (rev 9727)
+++ trunk/bnd/debian/orig-tar.sh	2009-08-07 23:08:33 UTC (rev 9728)
@@ -5,7 +5,7 @@
 DIR=bnd-$VERSION
 
 DATE=20090701
-cvs -z3 -d:pserver:anonymous at bnd.cvs.sourceforge.net:/cvsroot/bnd co -D $DATE -d bnd-cvs .
+cvs -z3 -d:pserver:anonymous at bnd.cvs.sourceforge.net:/cvsroot/bnd checkout -D $DATE -d bnd-cvs .
 
 # Use a script to transform the current codebase.
 # Hopefully the next release of BND will adopt this layout

Modified: trunk/bnd/debian/rules
===================================================================
--- trunk/bnd/debian/rules	2009-08-07 16:15:24 UTC (rev 9727)
+++ trunk/bnd/debian/rules	2009-08-07 23:08:33 UTC (rev 9728)
@@ -11,6 +11,11 @@
 DEB_ANT_BUILDFILE    := debian/build.xml
 DEB_ANT_ARGS         := -Dpackage=$(PACKAGE) -Dbin.package=$(PACKAGE) -Dversion=$(VERSION)
 
+install/$(PACKAGE)::
+	pod2man -c 'BND for Debian GNU/Linux' \
+	  -r $(PACKAGE)-$(VERSION) \
+	  debian/bnd.pod > debian/bnd.1
+
 binary-post-install/$(PACKAGE)::
 	mh_installpoms -p$(PACKAGE)
 	mh_installjar -p$(PACKAGE) -l src/main/resources/pom.xml target/bnd.jar
@@ -19,6 +24,7 @@
 
 clean::
 	-rm -rf debian/tmp
+	-rm -f debian/bnd.1
 
 get-orig-source:
 	#-uscan --download-version $(DEB_UPSTREAM_VERSION) --force-download --rename


