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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="embug">
<refentryinfo>
<productname>embug</productname>
<productnumber/>
</refentryinfo>
<refmeta>
<refentrytitle>embug</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">EMDEBIAN-TOOLS</refmiscinfo>
<refmiscinfo class="manual">EMDEBIAN-TOOLS</refmiscinfo>
</refmeta>
<refnamediv id="name">
<refname>embug</refname>
<refpurpose>Track Emdebian cross-building bugs from within package builds.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-f</arg>
<arg>--flag</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-g</arg>
<arg>--get-number</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-r</arg>
<arg>--remove</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-d</arg>
<arg>--debian</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-o</arg>
<arg>--outdated</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<arg>--lintian</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-p</arg>
<arg>--package</arg>
<replaceable> PACKAGE</replaceable>
</group>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<arg>--failed</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-l</arg>
<arg>--list</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<arg>--list-bugs</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<arg>--list-newer</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>--prepare</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-u</arg>
<arg>--update</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-v</arg>
<arg>--verbose</arg>
</group>
<group>
<arg>-q</arg>
<arg>--quiet</arg>
</group>
<group>
<arg>-m</arg>
<arg>--missing</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>embug</command>
<group>
<arg>-?</arg>
<arg>-h</arg>
<arg>--help</arg>
<arg>--version</arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para><command>embug</command> helps track cross-building bugs when
preparing Emdebian builds. When trying to prepare a package set, it can
be easy to lose track of which packages need to have changes within
Debian to support cross-building. <command>embug</command> also keeps
track of current crossbuilt bugs using SOAP.
</para>
</refsect1>
<refsect1 id="commands">
<title>COMMANDS</title>
<variablelist remap="TP">
<varlistentry>
<term><option>-f</option>|<option>--flag</option></term>
<listitem>
<para>Mark the current package as needing a cross-building bug
report.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-g</option>|<option>--get-number</option></term>
<listitem>
<para>Output the bug number for the cross-building bug
filed against the current package, if any.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option>|<option>--remove</option></term>
<listitem>
<para>In case of error, <option>--remove</option> removes
the flag - providing no bug report has been filed in the
meantime. Use <option>-p</option> to specify a package
name outside the source directory of the package itself.
(Alternatively, just edit <filename>~/.apt-cross/embug</filename>.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--lintian</option>
</term>
<listitem>
<para><command>lintian</command> support in <emphasis>emdebian-tools</emphasis> uses
a specialised set of Emdebian-only checks that supplement or replace the
standard Debian check sets. See <ulink url="http://wiki.debian.org/EmdebianPolicy">http://wiki.debian.org/EmdebianPolicy</ulink>.
</para>
<para>To check an Emdebian package only for compliance with Emdebian
Policy use:</para>
<programlisting>
$ lintian -C em $changes_file
</programlisting>
<para>(<command>emsource</command>, <command>emdebuild</command> and
<command>embuildstats</command> use this mode.)</para>
<para>To check an Emdebian package as a standard Debian package
(so that any upstream lintian warnings and errors show through):</para>
<programlisting>
$ lintian -X man $changes_file
</programlisting>
<para>Once a few things are solved in lintian, the <option>-X man</option>
will be dropped. Naturally, it is imperative that any Emdebian changes to
lintian support do not impact on normal Debian builds. All these Emdebian
lintian errors and warnings will remain within the emdebian-tools package
so that Emdebian can update them whenever necessary.
</para>
<para>Note that emdebuild and em_autobuild will expect
<computeroutput>lintian -C em $changes_file</computeroutput> to return
zero or the build will fail. i.e. <emphasis>lintian errors
within the Emdebian check set are fatal</emphasis> and will cause a
failure to build the package form source so this is a bit more strict
than Debian. (Warnings are non fatal.) This has been done because the
results of putting an amd64 ELF binary into <filename>/usr/bin</filename> on
an ARM device are quite hard to debug, especially if that binary is part
of the boot process.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option>|<option>--debian</option></term>
<listitem>
<para>See FLAGS. Records that a newer version of this package exists
in Debian.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option>|<option>--outdated</option></term>
<listitem>
<para>See FLAGS. Records that at least one patch (except
<filename>emdebian-changelog.patch</filename>) failed to apply.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--failed</option>
</term>
<listitem>
<para>Record that the package failed to crossbuild, despite the
patches being applied correctly. This flag overrides all other
flags except <option>--outdated</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>|<option>--list</option></term>
<listitem>
<para>List the current set of cross-building bugs, including
gaps where a patch needs to be prepared and a bug filed. Also
lists the packages with outdated patches or newer versions
in Debian.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--list-bugs</option>
</term>
<listitem>
<para>List the current set of cross-building bugs, including
gaps where a patch needs to be prepared and a bug filed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--list-newer</option>
</term>
<listitem>
<para>List the packages with outdated patches or newer versions
in Debian.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option>|<option>--update</option></term>
<listitem>
<para>Update the offline bug list using SOAP to query
<emphasis>bugs.debian.org</emphasis>. If a bug is closed
by the Debian maintainer, the report is removed from the
offline cache.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option>|<option>--missing</option></term>
<listitem>
<para>List only the source packages that have been flagged as
needing bugs where no bug has yet been filed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--prepare</option>
</term>
<listitem>
<para>Creates a temporary directory in <filename>../../branches</filename>,
copies the Debian and Emdebian source into the new directory and unpacks
each, ready for you to use <command>meld</command> to prepare a patch to
be filed against the Debian package. See
<ulink url="http://www.emdebian.org/emdebian/intro.html#filing">
http://www.emdebian.org/emdebian/intro.html#filing</ulink>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</option>|<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 id="options">
<title>OPTIONS</title>
<variablelist remap="TP">
<varlistentry>
<term><option>-p</option>|<option>--package</option></term>
<listitem>
<para>Specify a different package instead of looking for
<filename>debian/control</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>|<option>--verbose</option></term>
<listitem>
<para>be verbose.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option>|<option>--quiet</option></term>
<listitem>
<para>be quiet.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="flags">
<title>FLAGS</title>
<para>Various scripts within <emphasis>emdebian-tools</emphasis> set flags
using <command>embug</command> based on cache data, build failures, lintian
updates etc. The flags are set in a hierarchy:
</para>
<itemizedlist>
<listitem><option>--debian</option> is the lowest priority - the package
could still build cleanly in this state if it built cleanly last time and
if the changes in the new version are unrelated to the Emdebian patches.
</listitem>
<listitem><option>--outdated</option> is medium priority - a package
has been updated in Debian <emphasis>and</emphasis> the current patches
now fail to apply. This could be because a cross-building bug has been fixed,
it could just be a change to a section of the file that is specified in the
patch.</listitem>
<listitem><option>--lintian</option> is the highest priority - the package
requires work on the Emdebian patches to restore a clean build. Note that
packages can fail on lintian even if the Debian package has not changed,
dependent on changes within the lintian support in Emdebian. Packages must
<emphasis>NOT</emphasis> be uploaded with lintian errors in the Emdebian
check set - lintian errors from the standard Debian checks are ignored.
</listitem>
<listitem><option>--failed</option> is a virtual priority - it is only
set if the patches are up to date, otherwise most packages listed as
"Failed" would just be failed patches. "Failed" also replaces "lintian"
if the patches are up to date.
</listitem>
</itemizedlist>
<para>Attempting to set a flag of lower priority than the currently set
flag will silently fail, leaving the original flag in place.</para>
<para>Removing flags is not automated - use '<command>embug</command>
<option>--remove</option> <option>--package</option>
<userinput>$PACKAGE</userinput>' to remove all flags once all issues are
resolved.</para>
</refsect1>
<refsect1 id="files">
<title>FILES</title>
<para><command>embug</command> stores the flags and offline SOAP
results in <filename>~/.apt-cross/embug</filename>.
</para>
</refsect1>
<refsect1>
<title>Author</title>
<para><command>embuildstats</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="embuildstatsseealso">
<title>SEE ALSO</title>
<para>See also <filename>emdebuild</filename> (1), <filename>empdebuild</filename> (1),
<filename>emsource</filename> (1), <filename>emdebuild</filename> (1),
<filename>emtargetcmp</filename> (1),
<filename>dpkg-cross</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>
|
