man/deb-changelog.man

   1 .\" dpkg manual page - deb-changelog(5)
   2 .\"
   3 .\" Copyright © 1996-1998 Ian Jackson and Christian Schwarz
   4 .\" Copyright © 1998, 2001 Manoj Srivastava <srivasta@debian.org>
   5 .\" Copyright © 2001 Julian Gilbey <jdg@debian.org>
   6 .\" Copyright © 2003 Josip Rodin <joy@debian.org>
   7 .\" Copyright © 2008, 2010 Russ Allbery <rra@debian.org>
   8 .\" Copyright © 2010 Charles Plessy <plessy@debian.org>
   9 .\" Copyright © 2014 Bill Allombert <ballombe@debian.org>
  10 .\" Copyright © 2015-2017 Guillem Jover <guillem@debian.org>
  11 .\"
  12 .\" This is free software; you can redistribute it and/or modify
  13 .\" it under the terms of the GNU General Public License as published by
  14 .\" the Free Software Foundation; either version 2 of the License, or
  15 .\" (at your option) any later version.
  16 .\"
  17 .\" This is distributed in the hope that it will be useful,
  18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 .\" GNU General Public License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU General Public License
  23 .\" along with this program.  If not, see <https://www.gnu.org/licenses/>.
  24 .
  25 .TH deb-changelog 5 "%RELEASE_DATE%" "%VERSION%" "dpkg suite"
  26 .nh
  27 .SH NAME
  28 deb\-changelog \- dpkg source packages' changelog file format
  29 .
  30 .SH SYNOPSIS
  31 changelog
  32 .
  33 .SH DESCRIPTION
  34 Changes in the packaged version of a project are explained in the
  35 changelog file \fIdebian/changelog\fP.
  36 This includes modifications made in the source package compared to the
  37 upstream one as well as other changes and updates to the package.
  38 .PP
  39 The format of the \fIdebian/changelog\fP allows the package building
  40 tools to discover which version of the package is being built and find
  41 out other release-specific information.
  42 .PP
  43 That format is a series of entries like this:
  44
  45 .nf
  46 \fIpackage\fP (\fIversion\fP) \fIdistributions\fP; \fImetadata\fP
  47           [optional blank line(s), stripped]
  48   * \fIchange-details\fP
  49     \fImore-change-details\fP
  50           [blank line(s), included in output of \fBdpkg\-parsechangelog\fP(1)]
  51   * \fIeven-more-change-details\fP
  52           [optional blank line(s), stripped]
  53  \-\- \fImaintainer-name\fP <\fIemail-address\fP>  \fIdate\fP
  54 .fi
  55
  56 .PP
  57 \fIpackage\fP and \fIversion\fP are the source package name and version
  58 number.
  59 .PP
  60 \fIdistributions\fP lists one or more space-separated distributions where
  61 this version should be installed when it is uploaded; it is copied to the
  62 \fBDistribution\fP field in the \fI.changes\fP file.
  63 .PP
  64 \fImetadata\fP is a comma-separated list of \fIkeyword\fP=\fIvalue\fP items.
  65 The only \fIkeyword\fPs currently supported by \fBdpkg\fP are \fBurgency\fP
  66 and \fBbinary\-only\fP.
  67 \fBurgency\fP's value is used for the \fBUrgency\fP field in the
  68 \fI.changes\fP file for the upload.
  69 \fBbinary\-only\fP with a \fByes\fP value, is used to denote that this
  70 changelog entry is for a binary-only non-maintainer upload (an automatic
  71 binary rebuild with the only change being the changelog entry).
  72 .PP
  73 The change details may in fact be any series of lines starting with
  74 at least two spaces, but conventionally each change starts with an
  75 asterisk and a separating space and continuation lines are indented
  76 so as to bring them in line with the start of the text above.
  77 Blank lines may be used here to separate groups of changes, if desired.
  78 .PP
  79 If this upload resolves bugs recorded in the distribution bug tracking
  80 system, they may be automatically closed on the inclusion of this
  81 package into the distribution archive by including the string:
  82 .nf
  83   \fBCloses: Bug#\fP\fInnnnn\fP
  84 .fi
  85 in the change details (the exact Perl regular expression is
  86 \fB/closes:\\s*(?:bug)?\\#?\\s?\\d+(?:,\\s*(?:bug)?\\#?\\s?\\d+)*/i\fP).
  87 This information is conveyed via the \fBCloses\fP field in the \fI.changes\fP
  88 file.
  89 .PP
  90 The maintainer name and email address used in the changelog should be the
  91 details of the person who prepared this release of the package.
  92 They are \fBnot\fP necessarily those of the uploader or usual package
  93 maintainer.
  94 The information here will be copied to the \fBChanged\-By\fP field in the
  95 \fI.changes\fP file, and then later might be used to send an acknowledgement
  96 when the upload has been installed in the distribution archive.
  97 .PP
  98 The \fIdate\fP has the following format (compatible and with the same
  99 semantics of RFC2822 and RFC5322, or what «date \-R» generates):
 100 .IP
 101 \fIday-of-week\fP\fB,\fP \fIdd\fP \fImonth\fP \fIyyyy\fP \fIhh\fP\fB:\fP\fImm\fP\fB:\fP\fIss\fP \fB+\fP\fIzzzz\fP
 102 .PP
 103 where:
 104 .TP
 105 .I day-of-week
 106 Is one of:
 107 .BR Mon ", " Tue ", " Wed ", " Thu ", " Fri ", " Sat ", " Sun .
 108 .TP
 109 .I dd
 110 Is a one- or two-digit day of the month (\fB01\fP-\fB31\fP).
 111 .TP
 112 .I month
 113 Is one of:
 114 .BR Jan ", " Feb ", " Mar ", " Apr ", " May ", " Jun ", " Jul ", " Aug ", "
 115 .BR Sep ", " Oct ", " Nov ", " Dec .
 116 .TP
 117 .I yyyy
 118 Is the four-digit year (e.g. 2010).
 119 .TP
 120 .I hh
 121 Is the two-digit hour (\fB00\fP-\fB23\fP).
 122 .TP
 123 .I mm
 124 Is the two-digit minutes (\fB00\fP-\fB59\fP).
 125 .TP
 126 .I ss
 127 Is the two-digit seconds (\fB00\fP-\fB60\fP).
 128 .TP
 129 .RI [\fB+-\fP] zzzz
 130 Is the time zone offset from Coordinated Universal Time (UTC).
 131 ‘\fB+\fP’ indicates that the time is ahead of (i.e., east of) UTC and
 132 ‘\fB\-\fP’ indicates that the time is behind (i.e., west of) UTC.
 133 The first two digits indicate the hour difference from UTC and the last
 134 two digits indicate the number of additional minutes difference from UTC.
 135 The last two digits must be in the range \fB00\fP-\fB59\fP.
 136 .PP
 137 The first “title” line with the package name must start at the left
 138 hand margin.
 139 The “trailer” line with the maintainer and date details must be
 140 preceded by exactly one space.
 141 The maintainer details and the date must be separated by exactly two
 142 spaces.
 143 .PP
 144 Any line that consists entirely (i.e., no leading whitespace) of \fB#\fP
 145 or \fB/* */\fP style comments or RCS keywords.
 146 .PP
 147 Vim modelines or Emacs local variables, and ancient changelog entries with
 148 other formats at the end of the file should be accepted and preserved on
 149 output, but their contents might be otherwise ignored and parsing stopped
 150 at that point.
 151 .PP
 152 The entire changelog must be encoded in UTF-8.
 153 .SH FILES
 154 .TP
 155 .I debian/changelog
 156 .SH EXAMPLES
 157 .nf
 158 dpkg (1.17.18) unstable; urgency=low
 159
 160   [ Guillem Jover ]
 161   * Handle empty minimum versions when initializing dependency versions,
 162     as the code is mapping the minimum version 0 to '' to avoid outputting
 163     useless versions. Regression introduced in dpkg 1.17.17. Closes: #764929
 164
 165   [ Updated programs translations ]
 166   * Catalan (Guillem Jover).
 167
 168   [ Updated dselect translations ]
 169   * Catalan (Guillem Jover).
 170   * German (Sven Joachim).
 171
 172  \-\- Guillem Jover <guillem@debian.org>  Sun, 12 Oct 2014 15:47:44 +0200
 173 .fi
 174 .
 175 .SH SEE ALSO
 176 .BR deb\-version (7),
 177 .BR deb\-changes (5),
 178 .BR dpkg\-parsechangelog (1).