summaryrefslogtreecommitdiff
path: root/dh-make-elpa
blob: c0a9af42eb4e12b65f0bb5e0456c2d640e161a64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
#!/usr/bin/perl

=head1 NAME

dh-make-elpa - helper for creating Debian packages from ELPA packages

=cut

use strict;
use warnings;

use DhMakeELPA;

exit DhMakeELPA->run;

__END__

=head1 SYNOPSIS

=over

=item dh-make-elpa [--pkg-emacsen] [make]

=back

=head1 DESCRIPTION

B<dh-make-elpa> will try to create the files required to build a
Debian source package from an unpacked GNU Emacs ELPA package.

B<dh-make-elpa> is an experimental script that performs a lot of
guesswork.  You should throughly verify the contents of the debian/
directory before uploading

=head2 TYPICAL USAGE

=over 4

% git clone -o upstream https://foo.org/foo.git

% cd foo

% git reset --hard 1.0.0    # package latest stable release

% dh-make-elpa --pkg-emacsen

% git add debian && git commit -m "initial Debianisation"

% git deborig

% dpkg-buildpackage -us -uc

=back

=head2 COMMANDS

=over

=item make

Default command if no command is given. Creates debianisation from
scratch.  Fails with an error if F<debian/> directory already
exists.

=back

=head2 OPTIONS

=over

=item B<--pkg-emacsen>

Sets C<Maintainer>, C<Uploaders>, C<Vcs-Git> and C<Vcs-Browser> fields
in F<debian/control> according to the Team's conventions.

This option is useful when preparing a package for the Debian Emacs
Addon Packaging Team L<https://pkg-emacsen.alioth.debian.org>.

=item B<--version>

Specify the ELPA package version.  Useful when upstream failed to
include either a Package-Version: header or a -pkg.el file.

=back

=head2 TIPS

=over

=item Upstream remote

The remote for upstream's git repository should be called 'upstream'.  You can use:

=over 4

% git clone -o upstream https://foo/bar

=back

=back

=cut

=head1 AUTHOR

Written and maintained by Sean Whitton <spwhitton@spwhitton.name>.

A great deal of the library code used by B<dh-make-elpa>, and its
object-oriented structure, comes from dh-make-perl(1), written and
maintained by the Debian Perl Group.

=cut