File: emdebuild.1.xml

package info (click to toggle)
emdebian-tools 1.4.3
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 1,112 kB
  • ctags: 274
  • sloc: perl: 6,297; xml: 4,828; sh: 1,902; php: 406; ansic: 189; makefile: 15
file content (237 lines) | stat: -rw-r--r-- 9,348 bytes parent folder | download
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="emdebuild">
  <refentryinfo>
    <productname>emdebuild</productname>
    <productnumber/>
  </refentryinfo>
  <refmeta>
    <refentrytitle>emdebuild</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="source">EMDEBIAN-TOOLS</refmiscinfo>
    <refmiscinfo class="manual">EMDEBIAN-TOOLS</refmiscinfo>
  </refmeta>
  <refnamediv id="name">
    <refname>emdebuild</refname>
    <refpurpose>emdebuild is the emdebian version of debuild.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>emdebuild</command>
      <group>
        <arg>-a</arg>
        <arg>--arch</arg>
        <replaceable> ARCH</replaceable>
      </group>
      <group>
        <arg>-n</arg>
        <arg>--next</arg>
      </group>
      <arg>--svn</arg>
      <arg>--sign</arg>
      <group>
        <arg>-v</arg>
        <arg>--verbose</arg>
      </group>
      <group>
        <arg>-q</arg>
        <arg>--quiet</arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>emdebuild</command>
      <arg>--svn-only</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>emdebuild</command>
      <arg>--build-dep</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>emdebuild</command>
      <group>
        <arg>-h</arg>
        <arg>--help</arg>
      </group>
      <group>
        <arg>--version</arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>After a Debian package has been 'emdebianised' with
        <command>em_make</command>, <command>emdebuild</command>
        provides a convenient wrapper around dpkg-buildpackage.
        </para>
    <para><command>emdebuild</command> needs to be run in the source directory
        of the package.</para>
    <para>By default, <command>emdebuild</command> cross-builds the package
        for the <command>dpkg-cross</command> default architecture.
        Specify other architectures with <option>-a|--arch</option>. Ensure the current
        toolchain is installed for the chosen architecture.
        </para>
    <note>
      <title>running debian/rules alone is unsupported</title>
      <para>There is no equivalent for the
          <command>fakeroot debian/rules binary</command> type shorthand for a quick
          rebuild of the package due to the needs of the cross-build.</para>
    </note>
  </refsect1>
  <refsect1 id="commands">
    <title>COMMANDS</title>
    <variablelist remap="TP">
      <varlistentry>
        <term>
          <option>--svn-only</option>
        </term>
        <listitem>
          <para>Commit modifications to the emdebian patch files back to
              Emdebian SVN <emphasis role="bold">without</emphasis> rebuilding,
              e.g. once a failed build has been repaired.
              Requires a subversion working directory which can
              be provided by unpacking the source with <command>emsource</command>.
              The working copy must have been checked out with developer access.
              <command>emsource</command> will use developer access if a valid
              Emdebian SVN username is available.
              </para>
          <para>Note that the build log will need to be added to svn and
              checked in separately.</para>
          <para><option>--svn-only</option> is disabled when using machine:variant
          customisation patches via <command>emsource</command> <option>-m</option>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--build-dep</option>
        </term>
        <listitem>
          <para>Read the <filename>debian/xcontrol</filename> file (if any)
          and parse the list of <emphasis>Build-Cross-Depends:</emphasis>
          and call <command>apt-cross</command> to install the
          cross dependencies.
          </para>
          <para>See <command>emdebuild</command> support for <filename>debian/xcontrol</filename>.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="options">
    <title>OPTIONS</title>
    <variablelist remap="TP">
      <varlistentry>
        <term><option>-a</option>|<option>--arch</option> ARCH</term>
        <listitem>
          <para>Override the default architecture
              (set by <command>dpkg-cross</command>).
              </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option>|<option>--next</option></term>
        <listitem>
          <para>Increment the emdebian version before building. Note that, in
          most cases, it is advisable to edit <filename>debian/changelog</filename>
          and add an explanatory message before uploading the built package.
          <command>emdebuild</command> merely adds a very brief comment.</para>
          <para>When building a package that has been updated upstream, the
          <option>-n</option> option can be used to restore the effect of a
          default Emdebian version if the <filename>emdebian-changelog.patch</filename>
          could not be applied.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--svn</option>
        </term>
        <listitem>
          <para>Commit modifications to the emdebian patch files back to
              Emdebian SVN upon a successful build. Requires a subversion working
              directory which can be provided by unpacking the source
              with <command>emsource</command>. The working copy must have
              been checked out with developer access. <command>emsource</command> will
              use developer access if a valid Emdebian SVN username is available.
              </para>
          <para>If the build fails, <command>emdebuild</command> can be restarted
           and the patches committed to Emdebian SVN once the build has been fixed
           using the <option>-svn-only</option> option.</para>
          <para><option>--svn</option> will abort the SVN commit when using machine:variant
          customisation patches via <command>emsource</command> <option>-m</option>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--sign</option>
        </term>
        <listitem>
          <para>Sign the changes file created by the underlying
              <command>dpkg-buildpackage</command>. Many repositories require
              changes files to be signed with an authorised GnuPG key. If
              <filename>~/.devscripts</filename> is configured so that
              <emphasis>DEBUILD_DPKG_BUILDPACKAGE_OPTS</emphasis> options specify
              that <command>dpkg-buildpackage</command> should not sign the
              changes file directly, this option can be used to call
              <command>debsign</command> with the generated changes
              file at the end of the build. Experience has shown that even when
              <command>dpkg-buildpackage</command> is unable to sign the changes
              file, running <command>debsign</command> directly succeeds.
              </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>|<option>--verbose</option></term>
        <listitem>
          <para>be verbose - repeat once for extra verbosity.
              Most users are highly recommended to use at least one
              level of verbosity.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-q</option>|<option>--quiet</option></term>
        <listitem>
          <para>be quiet. <command>emdebuild</command> will be very
              quiet with this option, only essential warnings and messages
              from the build process itself are output. Intended for
              automated buildd purposes.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option>|<option>--help</option></term>
        <listitem>
          <para>print the usage message and exit.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>--version</option>
        </term>
        <listitem>
          <para>print the usage message and exit.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Author</title>
    <para><command>emdebuild</command> was written
      by Neil Williams <email>codehelp@debian.org</email>.
    </para>
    <para>This  manual  page  was  written by Neil Williams
      <email>codehelp@debian.org</email>
    </para>
  </refsect1>
  <refsect1 id="emdebuildseealso">
    <title>SEE ALSO</title>
    <para>See also <filename>apt-cross</filename> (1), <filename>dpkg-cross</filename> (1),
         <filename>emsource</filename> (1), <filename>emsetup</filename> (1),
         <filename>em_make</filename> (1),
         <filename>empdebuild</filename> (1), <filename>xcontrol</filename> (1),
         <emphasis>emdebian-tools</emphasis> (1).
         </para>
    <para><ulink url="http://www.emdebian.org/emdebian/intro.html">General Introduction</ulink>
    to crossbuilding Debian.
    </para>
  </refsect1>
</refentry>