summaryrefslogtreecommitdiff
path: root/dh_elpa.in
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2018-08-19 18:01:29 -0700
committerSean Whitton <spwhitton@spwhitton.name>2018-08-19 18:01:29 -0700
commit3bf960baad82b528151a21eb420ae3808dc0e80d (patch)
tree4d27111fb8418ee823dbe189add3efcda6f061fd /dh_elpa.in
parent559f40b11b5b8dd6882bb5b08f58816b87eb5491 (diff)
wordsmithing with regard to the Emacs package name
Diffstat (limited to 'dh_elpa.in')
-rwxr-xr-xdh_elpa.in28
1 files changed, 17 insertions, 11 deletions
diff --git a/dh_elpa.in b/dh_elpa.in
index c53373d..28596fe 100755
--- a/dh_elpa.in
+++ b/dh_elpa.in
@@ -386,18 +386,24 @@ 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
+=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:
+C<tetris>). For a simple package this is the filename without the
+'.el' extension; for a multi-file package, it is given in the
+C<*-pkg.el> file. The Emacs package name is often distinct from the
+name of the upstream repository or the name of the Debian source
+package. B<dh_elpa> needs to know what the Emacs package name is.
+
+B<dh_elpa> needs to know what the Emacs package name is, but it does
+not examine the upstream source code to find it. Instead, by default,
+it assumes that the Emacs package name is the name of the binary
+package, stripped of any 'elpa-' prefix (which will be present for
+packages compliant with the Debian Emacsen Team addons policy
+(L<https://wiki.debian.org/EmacsenTeam>).
+
+To override that assumption, you can export the B<ELPA_NAME>
+environment variable in debian/rules:
=over 4
@@ -407,4 +413,4 @@ environment variable B<ELPA_NAME> in debian/rules:
=back
You can also specify the name on a per binary package basis with
-C<ELPA_NAME_binary-package-name>.
+C<ELPA_NAME_binary-package-name>=tpp-mode.