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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>EDUARD</firstname>">
<!ENTITY dhsurname "<surname>BLOCH</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>October 2007</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>blade@debian.org</email>">
<!ENTITY dhusername "Eduard Bloch">
<!ENTITY dhucpackage "<refentrytitle>svn-buildpackage</refentrytitle>">
<!ENTITY dhpackage "svn-buildpackage">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>build Debian packages from SVN repository</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage; [ OPTIONS... ] [ OPTIONS for dpkg-buildpackage ]</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
Builds a Debian package from a Subversion repository. The source code
repository must be in the format created by svn-inject, and this script
must be executed from
the working directory (trunk/package).
</para>
<para>
By default, the working directory is used as the main source directory (assuming
the whole upstream source is being stored in the repository). The alternative is
so called "merge mode". With this method, only the debian directory (and maybe
some other modified files) are stored in the repository. At build time, the contents
of the svn trunk are copied to the extracted tarball contents (and can overwrite
parts of it). To choose this working model, set the svn property mergeWithUpstream
on the Debian directory ("svn propset mergeWithUpstream 1 debian").
</para>
<para>
The default behaviour is as follows:
</para>
<para>Check the working directory, complain on uncommited files (also see <emphasis>--svn-ignore-new</emphasis>)</para>
<para>Copy the orig tarball to the build area if necessary (also see <emphasis>--svn-no-links</emphasis>)</para>
<para>Extract the tarball (in merge mode) or export the svn work directory to the build directory (also see below and <emphasis>--svn-no-links</emphasis>)</para>
<para>Build with dpkg-buildpackage (also see <emphasis>--svn-builder</emphasis>, <emphasis>--svn-lintian</emphasis>, etc.)</para>
<para>Create a changelog entry for the future version</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para><command>&dhpackage;</command> accepts the following options on the
command-line:</para>
<glosslist>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-builder=COMMAND</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Specifies alternative build command instead of dpkg-buildpackage, eg. debuild, pdebuild, etc. Every parameters that svn-buildpackage doesn't know (<emphasis>--svn-*</emphasis>) are passed to COMMAND. There is no difference between the command line and config file parameters . They are used at the same time.</para>
<para>WARNING: shell quotation rules do not completely apply here, better use wrappers for complex constructs. Using this option may break <emphasis>--svn-lintian</emphasis>, <emphasis>--svn-linda</emphasis> and <emphasis>--svn-move</emphasis> functionality. Some functions may be disabled when a custom build command is used because the output file location is not predictable.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-ignore-new</option></arg>
<arg><option>--svn-ignore</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Don't stop on svn conflicts or new/changed files. To set this behaviour for single files set the "deb:ignoreM" property to 1 on them. Also see documentation of the svn:ignore property in the SVN book.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-dont-clean</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Don't run debian/rules clean (default: clean first)</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-no-links</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Don't use file links but try to export or do hard copies of the working directory (default: use links where possible). This is useful if your package fails to build because some files, empty directories, broken links, ... cannot not be transported with in the default link-copy mode.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-dont-purge</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Don't remove the build directory when the build is done. (Default: remove after successful build)</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-reuse</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>If possible, reuse an existing build directory in subsequent builds. The build directory is not purged after the build, it is not renamed when a build starts and the files are just copied over into it. Useful in mergeWithUpstream mode with large packages.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-rm-prev-dir</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>If a previous build directory is found, remove it before building instead of renaming it. if --svn-reuse is also given in the same line, the reuse behaviour occurs.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-export</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Just export the working directory and do neccessary code merge operations, then exit.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-tag</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Final build: Tag, export, build cleanly & make new changelog entry</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-tag-only</option></arg>
<arg><option>--svn-only-tag</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Don't build the package, do only the tag copy</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-retag</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>If an existing target directory has been found while trying to create the tag copy, remove the target directory first.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-noautodch</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>No new Debian changelog entry is added automatically.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-lintian</option></arg>
<arg><option>--svn-linda</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Run lintian or linda on the resulting changes file when done.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-move</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>When done, move the created files (as listed in .changes) to the parent directory, relative to the one where svn-buildpackage was started.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-move-to=...</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Specifies the target directory to move generated files to.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-pkg=packagename</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Overrides the detected package name. Use with caution since it could be set too late during the processing (eg. still have the old value when expanding shell variables).</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-override=var=value,anothervar=value</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Overrides any config variable that has been autodetected or found in <emphasis>.svn/deb-layout</emphasis>.</para>
</glossdef>
</glossentry>
<!--varlistentry>
<term><option> -\-svn-pass-diff</option></term>
<listitem>
<para>Experimental function to generate the .diff.gz contents using svn and pass it to dpkg-buildpackage. Requires a hacked dpkg-buildpackage script.</para>
</listitem>
</varlistentry-->
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-prebuild</option></arg>
<arg><option>--svn-postbuild</option></arg>
<arg><option>--svn-pretag</option></arg>
<arg><option>--svn-posttag</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Commands (hooks) to be executed before/after the build/tag
command invocations, e.g. to download the orig tarballs from the
archive. Shell code can be emdded here though it is not
recommended. Various helping variables are available in the
environment, see ENVIRONMENT VARIABLES below for detailed explanation.
</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-noninteractive</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>With this parameter svn-buildpackage will not interact with the user</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-savecfg</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>By default, svn-buildpackage used to create <emphasis>.svn/deb-layout</emphasis> on every invocation.
Since version 0.6.22 this behaviour is deprecated.</para>
<para>With this parameter svn-buildpackage
will (partly) replicate the old behaviour. In contrast to the deprecated behaviour,
the <emphasis>.svn/deb-layout</emphasis> is regarded as a local override; the old behaviour simply ignored any
versioned layout information if it found <emphasis>.svn/deb-layout</emphasis>.</para>
<para>This option was provided since it can be useful when creating a local override file.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>--svn-verbose</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>More verbose program output</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<cmdsynopsis><group>
<arg><option>-h</option></arg>
<arg><option>--help</option></arg>
</group></cmdsynopsis>
</glossterm>
<glossdef>
<para>Show the help message</para>
</glossdef>
</glossentry>
</glosslist>
</refsect1>
<refsect1>
<title>CONFIGURATION FILE</title>
<para>svn-buildpackage's behaviour can be modified using the file
~/.svn-buildpackage.conf. Additional parts can be added in each package
working directory using the file .svn/svn-buildpackage.conf. It is
essentially a list of the long command line options (without leading
minus signs), one argument per line (without quotes surrounding
multi-word arguments). The variables are expanded with the system shell
if shell variables are found there. Avoid ~ sign because of unreliable
expansion: it is better to use $HOME instead. Example:</para>
<screen>
svn-builder=debuild -EPATH
svn-no-links
svn-override=origDir=$HOME/debian/upstream/$PACKAGE
# svn-ignore-new
#svn-lintian
</screen>
</refsect1>
<refsect1>
<title>DIRECTORY LAYOUT HANDLING</title>
<para>By default, <emphasis>svn-buildpackage</emphasis> expects a configuration file with path/url
declaration, <emphasis>.svn/deb-layout</emphasis>. The values there can be overridden with the
<emphasis>--svn-override</emphasis> option, see above. If a config file could not be found, the
settings are autodetected following the usual assumptions about local
directories and repository layout. In addition, the contents of a custom
file <emphasis>debian/svn-deblayout</emphasis> will be imported during the initial
configuration. Package maintainers can store this file in the repository to
pass correct defaults to new svn-buildpackage users. The format is the same
as in the file <emphasis>.svn/deb-layout</emphasis>. As an alternative to the
<emphasis>debian/svn-deblayout</emphasis> file, maintainers can set Subversion properties for
the <emphasis>debian/</emphasis> directory; any properties of <emphasis>debian/</emphasis> which have a name of the
form <emphasis>svn-bp:PROP</emphasis> will be the source of a PROP setting which has the value
indicated by the first line of the property value.</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The following environment variables are exported by svn-buildpackage and can be used in hook commands or the package build system.</para>
<variablelist>
<varlistentry>
<term>PACKAGE</term>
<term>package</term>
<listitem>
<para>The source package name</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SVN_BUILDPACKAGE</term>
<listitem>
<para>Version of svn-buildpackage</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TAG_VERSION</term>
<term>debian_version</term>
<listitem>
<para>The complete Debian version string, also used for the tag copy</para>
</listitem>
</varlistentry>
<varlistentry>
<term>non_epoch_version</term>
<listitem>
<para>Same as debian_version but without any epoch strings</para>
</listitem>
</varlistentry>
<varlistentry>
<term>upstream_version</term>
<listitem>
<para>Same as debian_version but without Debian extensions</para>
</listitem>
</varlistentry>
<varlistentry>
<term>guess_loc</term>
<listitem>
<para>Guessed upstream source package name in the pool, something like libm/libmeta-html-perl_3.2.1.0.orig.tar.g</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DIFFSRC</term>
<listitem>
<para>(experimental) shows the location of generated diff file</para>
</listitem>
</varlistentry>
</variablelist>
<para>All the layout properties are exported to the environment, too. The following ones have meaning to svn-buildpackage.</para>
<variablelist>
<varlistentry>
<term>buildArea</term>
<listitem>
<para>the location of build area directory</para>
</listitem>
</varlistentry>
<varlistentry>
<term>trunkUrl</term>
<listitem>
<para>the URL of the trunk directory for the current package.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>tagsUrl</term>
<listitem>
<para>the URL of the tags base directory for the current package.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>origDir</term>
<listitem>
<para>the local directory where the orig tarball should be located.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>origUrl</term>
<listitem>
<para>the URL from where the orig tarball for the current package can be pulled from.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The following variables are understood by svn-buildpackage:</para>
<variablelist>
<varlistentry>
<term>FORCETAG</term>
<listitem>
<para>Ignore the signs of an incomplete changelog and tag the repository anyway
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FORCEEXPORT</term>
<listitem>
<para>Export upstream source from the repository even if mergeWithUpstream property is set</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DEBIAN_FRONTEND</term>
<listitem>
<para>If DEBIAN_FRONTEND is set to 'noninteractive' <emphasis>--svn-noninteractive</emphasis> is called silently</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RECOMMENDATIONS</title>
<para>Use shell aliases. Here are some examples for Bash:</para>
<screen>
alias svn-b="svn-buildpackage -us -uc -rfakeroot --svn-ignore"; alias svn-br="svn-b --svn-dont-purge --svn-reuse"; alias svn-bt="svn-buildpackage --svn-tag -rfakeroot";
</screen>
<para>Those commands have respective meanings: build regardless of new or
changed files; build regardless of new or changed files and reuse the
build directory; build (for upload) and tag.</para>
<para>SSH is the easiest way to access remote repositories, although it
usually requires entering a password more frequently with
svn-buildpackage. Workarounds include using an ssh key without a
passphrase (although this is insecure and still relatively slow), or the
SSH connection caching feature present in recent versions of
SSH. For details, see the svn-buildpackage manual.</para>
<para>Another way to get a remote link is using the Subversion DAV module
(with SSL and Apache user authentication), see the svn-buildpackage
HOWTO manual for details.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<glosslist>
<glossentry>
<glossterm>
<citerefentry> <refentrytitle>/usr/share/doc/svn-buildpackage/</refentrytitle></citerefentry>
</glossterm>
<glossdef>
<para>The svn-buildpackage HOWTO manual</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<citerefentry> <refentrytitle>svn-inject</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
</glossterm>
<glossdef>
<para>puts a Debian source package into Subversion repository</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<citerefentry> <refentrytitle>svn-upgrade</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
</glossterm>
<glossdef>
<para>upgrade source package from a new upstream revision</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<citerefentry> <refentrytitle>svn</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
</glossterm>
<glossdef>
<para>Subversion command line client tool</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<citerefentry> <refentrytitle>dpkg-buildpackage</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
</glossterm>
<glossdef>
<para>Debian source package tools</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<citerefentry> <refentrytitle>lintian</refentrytitle> <manvolnum>1</manvolnum> </citerefentry>
</glossterm>
<glossdef>
<para>Debian package checker</para>
</glossdef>
</glossentry>
</glosslist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>&dhpackage; was written by Eduard Bloch with contributions
from others. You can contact the current maintainers by joining the IRC channel <emphasis>#debian-svn-bp</emphasis> on the OFTC network (via <emphasis>irc.debian.org</emphasis>).</para>
<para>This manual page was written by &dhusername; in roff and converted to SGML by Goneri Le Bouder.</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
