This is an automated email from the git hooks/post-receive script.

guillem pushed a commit to branch master
in repository dpkg.

View the commit online:
https://git.dpkg.org/cgit/dpkg/dpkg.git/commit/?id=c1636078026746d530d2cc6127f8e90abaea74be

commit c1636078026746d530d2cc6127f8e90abaea74be
Author: Guillem Jover <[email protected]>
AuthorDate: Thu Oct 4 07:35:50 2018 +0200

    man: Improve documentation on vendor-specific series files in dpkg-source(1)
    
    Turn the reference to the vendor-specific series file vendor-neutral,
    and specify the order and default name. Explain one of the reasons for
    the feature, and where it is particularly helpful.
---
 debian/changelog    |  1 +
 man/dpkg-source.man | 25 +++++++++++++++++++------
 2 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 752bcff86..e37084c5e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -7,6 +7,7 @@ dpkg (1.19.2) UNRELEASED; urgency=medium
       Prompted by Mattia Rizzolo <[email protected]>.
     - dsc(5): Add a reference to where the source formats are described.
       Prompted by Manuel A. Fernandez Montecelo <[email protected]>.
+    - dpkg-source(1): Improve documentation on vendor-specific series files.
 
   [ Updated man pages translations ]
   * German (Helge Kreutzmann).
diff --git a/man/dpkg-source.man b/man/dpkg-source.man
index 2233d7a8d..e96fd26a7 100644
--- a/man/dpkg-source.man
+++ b/man/dpkg-source.man
@@ -486,13 +486,21 @@ debian tarball must contain a \fBdebian\fP sub-directory 
but it
 can also contain binary files outside of that directory (see
 \fB\-\-include\-binaries\fP option).
 .PP
-All patches listed in \fBdebian/patches/debian.series\fP or
-\fBdebian/patches/series\fP are then applied.
+All patches listed in \fBdebian/patches/\fP\fIvendor\fP\fB.series\fP or
+\fBdebian/patches/series\fP are then applied, where \fIvendor\fP will be
+the lowercase name of the current vendor, or \fBdebian\fP if there is
+no vendor defined.
 If the former file is used and the latter one doesn't exist (or is a
-symlink), then the latter is replaced with a symlink to the former. This
-is meant to simplify usage of \fBquilt\fP to manage the set of patches. Note
-however that while \fBdpkg\-source\fP parses correctly series files with
-explicit options used for patch application (stored on each line
+symlink), then the latter is replaced with a symlink to the former.
+This is meant to simplify usage of \fBquilt\fP to manage the set of patches.
+Vendor-specific series files are intended to make it possible to serialize
+multiple development branches based on the vendor, in a declarative way,
+in preference to open-coding this handling in \fBdebian/rules\fP.
+This is particularly useful when the source would need to be patched
+conditionally because the affected files do not have built-in conditional
+occlusion support.
+Note however that while \fBdpkg\-source\fP parses correctly series files
+with explicit options used for patch application (stored on each line
 after the patch filename and one or more spaces), it does ignore those
 options and always expect patches that can be applied with the \fB\-p1\fP
 option of \fBpatch\fP. It will thus emit a warning when it encounters
@@ -848,10 +856,15 @@ the source package is maintained.
 Free form text that is put on top of the automatic patch generated
 in formats “2.0” or “3.0 (quilt)”. \fBlocal\-patch\-header\fP is not
 included in the generated source package while \fBpatch\-header\fP is.
+.SS debian/patches/\fIvendor\fP.series
 .SS debian/patches/series
 This file lists all patches that have to be applied (in the given order)
 on top of the upstream source package. Leading and trailing spaces are
 stripped.
+The \fIvendor\fP will be the lowercase name of the current vendor, or
+\fBdebian\fP if there is no vendor defined.
+If the vendor-specific series file does not exist, the vendor-less series
+file will be used.
 Lines starting with ‘\fB#\fP’ are comments and are skipped.
 Empty lines are ignored.
 Remaining lines start with a patch filename (relative

-- 
Dpkg.Org's dpkg

Reply via email to