* document xpi.mk in README

  - update README
* document in changelog
  - update debian/changelog

2 files changed, 50 insertions, 0 deletions

diff --git a/README b/README
index c0a32eb..a8f5e26 100644
--- a/README
+++ b/README
@@ -13,6 +13,9 @@ The package contains rules for the following projects:
  - thunderbird-3.0
  - xulrunner-1.9
 
+In addition there is a xpi.mk which provides standard rules/targets to package
+XPI extensions for mozilla/toolkit based applications.
+
 === mozclient ===
 
 Creates a source tarball from CVS
@@ -105,3 +108,48 @@ Example of COMPARE_FILTER_IN tweak:
 COMPARE_FILTER_IN += \
   -e 's,^usr/lib/seamonkey-2.0/extensions/{f13b157f-b174-47e7-a34d-4815ddfdfeb8}.*,,' \
   $(NULL)
+
+
+=== xpi.mk ===
+
+targets:
+---------
+ install-xpi - unpack and install the contents of the .xpi file to the
+               package named by the MOZ_EXTENSION_PKG parameter
+ clean-xpi   - clean build cruft from install-xpi
+
+parameters:
+------------
+ MOZ_EXTENSION_PKG - the binary package that will ship the extension
+ MOZ_XPI_FILE      - the XPI file to unpack and install to the binary package
+                     named by MOZ_EXTENSION_PKG. If not set, xpi.mk will use
+                     the first |*.xpi| file found in the packages top level
+                     directory
+ MOZ_XPI_EMID      - use the given EMID to name the links in the applications
+                     |extensions| directory. If not set, xpi.mk will try to
+                     guess the right EMID by introspecting the |install.rdf|
+                     shipped by the XPI
+ MOZ_XPI_BUILD_COMMAND
+                   - use the given command _before_ running the normal
+                     |install-xpi| procedure. This parameter is useful for all
+                     those extension sources that have a command/make target
+                     to produce a XPI.
+ MOZ_XPI_MOZILLA_DIRS
+                   - link the extension to the global |extensions| directory
+                     of the given MOZILLAs. The default value is |firefox| and
+                     |firefox-addons|, which will link the extension to the
+                     /usr/lib/firefox/extensions and /usr/lib/firefox-addons/extensions
+                     directories, respectively.
+ 
+cdbs:
+------
+ If you are using cdbs (debhelper.mk) xpi.mk hooks in appropriately.
+ cdbs targets to build the packages without any rule. The only thing required
+ is to include the debhelper.mk from cdbs _before_ including xpi.mk.
+
+
+examples:
+----------
+ A template is available in the branch available under the following URL:
+   https://code.launchpad.net/~mozillateam/firefox-extensions/XPI.TEMPLATE
+ 
diff --git a/debian/changelog b/debian/changelog
index b9fd168..909a2f4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -25,6 +25,8 @@ mozilla-devscripts (0.05) UNRELEASED; urgency=low
   * introduce MOZ_XPI_MOZILLA_DIRS in xpi.mk with default values: "firefox-addons
     firefox"
     - update src/xpi.mk
+  * document xpi.mk in README
+    - update README
 
  -- Fabien Tassin <fta@sofaraway.org>  Fri, 15 Feb 2008 22:02:42 +0100