document ELPA_NAME

1 files changed, 23 insertions, 0 deletions

diff --git a/dh_elpa.in b/dh_elpa.in
index 9ff665e..9308d58 100755
--- a/dh_elpa.in
+++ b/dh_elpa.in
@@ -370,3 +370,26 @@ version strings Emacs will accept (see the docstring for the Emacs
 function `version-to-list' for details).  dh_elpa will error out if
 the version cannot be translated.  You should resort to patching in a
 Package-Version header or adding a *-pkg.el file.
+
+=head2 Specifying the (Emacs) package name
+
+Every Emacs package has a name (e.g. C<magit>, C<circe>, or
+C<tetris>). This name is encoded in the source, either using a special
+comment or the C<*-pkg.el> file.  B<dh_elpa> needs to know what this name
+is. For packages compliant with the Debian Emacsen Team addons policy
+(L<https://wiki.debian.org/EmacsenTeam>) this will prefixed with
+'elpa-' to become the Debian (apt/dpkg) package name. For Debian
+packages not following this naming convention, B<dh_elpa> will by
+default try using the Debian package name as the Emacs package name.
+If this does not work for your package, you can specify
+environment variable B<ELPA_NAME> in debian/rules:
+
+=over 4
+
+    ELPA_NAME=tpp-mode
+    export ELPA_NAME
+
+=back
+
+You can also specify the name on a per binary package basis with
+C<ELPA_NAME_binary-package-name>.