This file is indexed.

/usr/share/doc/git-buildpackage/manual-html/man.gbp.rpm.ch.html is in git-buildpackage 0.9.8.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gbp-rpm-ch: Building Debian Packages with git-buildpackage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Building Debian Packages with git-buildpackage">
<link rel="up" href="man.reference.html" title="Appendix A. Command Reference">
<link rel="prev" href="man.gbp.pq.rpm.html" title="gbp-pq-rpm">
<link rel="next" href="gbp.copyleft.html" title="Appendix B. Copyright">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="man.reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="man.gbp.pq.rpm.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gbp.copyleft.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="man.gbp.rpm.ch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">gbp-rpm-ch</span></h2>
<p>gbp-rpm-ch; — Generate the RPM changelog from git commit messages</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p><code class="command">gbp rpm-ch</code>  [<code class="option">--version</code>] [<code class="option">--help</code>] [<code class="option">--verbose</code>] [<code class="option">--color=</code>[auto|on|off]] [<code class="option">--color-scheme=</code><em class="replaceable"><code>COLOR_SCHEME</code></em>] [<code class="option">--tmp-dir</code>=<em class="replaceable"><code>DIRECTORY</code></em>] [<code class="option">--vendor</code>=<em class="replaceable"><code>VENDOR</code></em>] [<code class="option">--packaging-branch=</code><em class="replaceable"><code>BRANCH-NAME</code></em>] [<code class="option">--packaging-tag=</code><em class="replaceable"><code>TAG-FORMAT</code></em>] [<code class="option">--ignore-branch</code>] [<code class="option">--packaging-dir=</code><em class="replaceable"><code>DIRECTORY</code></em>] [<code class="option">--changelog-file=</code><em class="replaceable"><code>FILEPATH</code></em>] [<code class="option">--spec-file=</code><em class="replaceable"><code>FILEPATH</code></em>] [<code class="option">--since=</code><em class="replaceable"><code>COMMITISH</code></em>] [<code class="option">--no-release</code>] [<code class="option">--[no-]git-author</code>] [<code class="option">--[no-]full</code>] [<code class="option">--id-length=</code><em class="replaceable"><code>NUMBER</code></em>] [<code class="option">--ignore-regex=</code><em class="replaceable"><code>REGEX</code></em>] [<code class="option">--changelog-revision=</code><em class="replaceable"><code>REV-FORMAT</code></em>] [<code class="option">--git-log=</code><em class="replaceable"><code>GIT-LOG-OPTIONS</code></em>] [<code class="option">--spawn-editor=<em class="replaceable"><code>[always|release|no]</code></em></code>] [<code class="option">--editor-cmd=</code><em class="replaceable"><code>EDITOR</code></em>] [<code class="option">--customizations=</code><em class="replaceable"><code>CUSTOMIZATION-FILE</code></em>]  <em class="replaceable"><code>[PATH1 PATH2]</code></em> </p></div>
</div>
<div class="refsect1">
<a name="id-1.9.21.5"></a><h2>DESCRIPTION</h2>
<p>
    <span class="command"><strong>gbp rpm-ch</strong></span> reads git commit messages up to the current tip of the current
    branch and updates the RPM changelog from them.
    </p>
<p>
    By default, <span class="command"><strong>gbp rpm-ch</strong></span> tries to guess the last <span class="productname">Git</span>™ commit documented in
    the changelog. Alternatively, <code class="option">--since</code> can be used to
    tell <span class="command"><strong>gbp rpm-ch</strong></span> at which point it should start in the <span class="productname">Git</span>™ history, or,
    <code class="option">--all</code> to use all commits from the <span class="productname">Git</span>™ history.
    </p>
<p>
    The additional path arguments can be used to restrict the repository paths
    <span class="command"><strong>gbp rpm-ch</strong></span> looks at. For even more detailed control, you can use
    <code class="option">--git-log</code> to restrict the generated changelog entries
    further. E.g. by using
    <code class="option">--git-log=</code><em class="replaceable"><code>"--author=Foo Bar"</code></em>.
    </p>
</div>
<div class="refsect1">
<a name="id-1.9.21.6"></a><h2>OPTIONS</h2>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">--version</code></span></p></td>
<td><p>
          Print version of the program, i.e. version of the git-buildpackage
          suite
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">-v</code>, </span><span class="term"><code class="option">--verbose</code></span></p></td>
<td><p>
          Verbose execution
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span></p></td>
<td><p>
          Print help and exit
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--color=</code>[auto|on|off]
        </span></p></td>
<td><p>
          Whether to use colored output.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--color-scheme=</code><em class="replaceable"><code>COLOR_SCHEME</code></em>
        </span></p></td>
<td><p>
          Colors to use in output (when color is enabled). The format for
          COLOR_SCHEME is
          '&lt;debug&gt;:&lt;info&gt;:&lt;warning&gt;:&lt;error&gt;'.
          Numerical values and color names are accepted, empty fields imply
          the default color. For example,
          <code class="option">--git-color-scheme=</code><code class="literal">'cyan:34::'</code> would
          show debug messages in cyan, info messages in blue and other messages
          in default (i.e. warning and error messages in red).
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--git-tmp-dir</code>=<em class="replaceable"><code>DIRECTORY</code></em>
        </span></p></td>
<td><p>
          Base directory under which temporary directories are created.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--vendor</code>=<em class="replaceable"><code>VENDOR</code></em>
        </span></p></td>
<td><p>
          Distribution vendor name.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--packaging-branch</code>=<em class="replaceable"><code>BRANCH-NAME</code></em>
        </span></p></td>
<td><p>
          The branch in the Git repository the package is being developed on,
          default is <em class="replaceable"><code>master</code></em>.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--ignore-branch</code>
        </span></p></td>
<td><p>
          Don't check if the current branch matches
          <em class="replaceable"><code>PACKAGING-BRANCH</code></em>.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--packaging-tag=</code><em class="replaceable"><code>TAG-FORMAT</code></em>
        </span></p></td>
<td><p>
          Tag format used, when tagging releases,
          default is <em class="replaceable"><code>%(vendor)s/%(version)s</code></em>
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--packaging-dir=</code><em class="replaceable"><code>DIRECTORY</code></em>
        </span></p></td>
<td><p>
          Subdirectory that contains the RPM packaging files.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--changelog-file=</code><em class="replaceable"><code>FILEPATH</code></em>
        </span></p></td>
<td><p>
          Relative path to the changelog file to use. Special value
          <em class="replaceable"><code>auto</code></em> causes <span class="command"><strong>gbp</strong></span> to guess,
          <em class="replaceable"><code>SPEC</code></em> uses the spec file,
          <em class="replaceable"><code>CHANGES</code></em> uses a separate changelog file
          (name derived spec file name with .spec suffix replaced by .changes).
          Guessing logic is simple: use separate changelog file if it is found,
          otherwise use the spec file.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--spec-file=</code><em class="replaceable"><code>FILEPATH</code></em>
        </span></p></td>
<td><p>
          Relative path to the spec file to use. Special value
          <em class="replaceable"><code>auto</code></em> causes <span class="command"><strong>gbp</strong></span> to search and guess.
          Other values cause the <code class="option">--packaging-dir</code> option to be
          ignored: the directory of the spec file is used, instead.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--since=</code><em class="replaceable"><code>COMMITTISH</code></em>
        </span></p></td>
<td><p>
          Start reading commit messages at
          <em class="replaceable"><code>COMMITTISH</code></em>.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--no-release</code>
        </span></p></td>
<td><p>
           Do not create a new changelog section, just update the last
           changelog section.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--[no-]full</code>
        </span></p></td>
<td><p>
          Include the full commit message in the changelog output.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--git-log=</code><em class="replaceable"><code>GIT-LOG-OPTIONS</code></em>
        </span></p></td>
<td><p>
          Options passed on verbatim to git-log(1).
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--id-length=</code><em class="replaceable"><code>N</code></em>
        </span></p></td>
<td><p>
          Include <em class="replaceable"><code>N</code></em> digits of the commit id in the
          changelog entry. Default is to not include any commit ids at all.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--ignore-regex=</code><em class="replaceable"><code>REGEX</code></em>
        </span></p></td>
<td><p>
          Ignore lines in commit message matching
          <em class="replaceable"><code>REGEX</code></em> when generating the changelog.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--changelog-revision=</code><em class="replaceable"><code>REV-FORMAT</code></em>
        </span></p></td>
<td><p>
          Format string to use for revision field in the changelog header.  The
          following string fields are accepted:
          <em class="replaceable"><code>%(upstreamversion)s</code></em> the upstream version;
          <em class="replaceable"><code>%(release)s</code></em> the rpm patchlevel, i.e.
          Release; <em class="replaceable"><code>%(version)s</code></em> full rpm package
          version; <em class="replaceable"><code>%(tagname)s</code></em> tag/commit, i.e.
          basically what <span class="command"><strong>git-describe</strong></span> would give.
          If empty or not defined the default from packaging policy is used.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--ignore-regex=</code><em class="replaceable"><code>REGEX</code></em>
        </span></p></td>
<td><p>
          Ignore commit lines matching <em class="replaceable"><code>REGEX</code></em>
          when generating the changelog.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--[no-]git-author</code>
        </span></p></td>
<td><p>
          Use user.name and user.email from
          <span class="application">git-config</span>(1) for the changelog header.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--spawn-editor=<em class="replaceable"><code>[always|release|no]</code></em></code>
        </span></p></td>
<td><p>
          Whether to spawn an editor: always, when doing a release or never.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--editor-cmd=<em class="replaceable"><code>EDITOR</code></em></code>
        </span></p></td>
<td><p>
          The editor to use for editing the changelog.
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--customizations=</code><em class="replaceable"><code>CUSTOMIZATION-FILE</code></em>
        </span></p></td>
<td><p>
          Load Python code from <em class="replaceable"><code>CUSTOMIZATION-FILE</code></em>.
          At the moment, the only useful thing the code can do is define a
          custom ChangelogEntryFormatter class.
          </p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="id-1.9.21.7"></a><h2>META TAGS</h2>
<p>
    Additional to the above options the formatting of the new changelog entries
    (one-per-commit) in the changelog can be modified by special tags (called
    Meta Tags) given in the git commit message. The tags must start at the
    first column of a commit message but can appear on any line.  They are of
    the form <code class="option">Tagname</code>: <em class="replaceable"><code>VALUE</code></em>. Valid
    Meta Tags are:
    </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">Git-Rpm-Ch</code>: <em class="replaceable"><code>ACTION</code></em>
        </span></p></td>
<td><p>
          Supported actions are: <em class="replaceable"><code>Ignore</code></em> which will
          ignore this commit when generating new changelog entries.
          <em class="replaceable"><code>Short</code></em> which will only use the description
          (the first line) of the commit message when generating the changelog
          entry (useful when <code class="option">--full</code> is given) and
          <em class="replaceable"><code>Full</code></em> which will use the full commit
          message when generating the changelog entry (useful when
          <code class="option">--full</code> is not given).
          </p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">[Close|Closes|...]</code>: <em class="replaceable"><code>BUGNUMBER</code></em>
        </span></p></td>
<td><p>
          Indicate in the changelog entry that bug
          <em class="replaceable"><code>BUGNUMBER</code></em> was addressed in this commit.
          </p></td>
</tr>
</tbody>
</table></div>
<p>
    The following git commit message:
    </p>
<pre class="screen">
      Document meta tags

      so one doesn't have to consult the manual

      Git-Rpm-Ch: Short
      Closes: #636088
    </pre>
<p>
    Results in this changelog entry:
    </p>
<pre class="screen">
      - Document meta tags (Closes: #636088)
    </pre>
</div>
<div class="refsect1">
<a name="id-1.9.21.8"></a><h2>CONFIGURATION FILES</h2>
<p>Several <code class="filename">gbp.conf</code> files are parsed 
    to set defaults for the above command-line arguments. See the
    <a class="xref" href="man.gbp.conf.html" title="gbp.conf"><span class="refentrytitle">gbp.conf</span>(5)</a> manpage for details.</p>
</div>
<div class="refsect1">
<a name="id-1.9.21.9"></a><h2>SEE ALSO</h2>
<p>
      <a class="xref" href="man.gbp.buildpackage.rpm.html" title="gbp-buildpackage-rpm"><span class="refentrytitle">gbp-buildpackage-rpm</span>(1)</a>,
      <a class="xref" href="man.gbp.import.srpm.html" title="gbp-import-srpm"><span class="refentrytitle">gbp-import-srpm</span>(1)</a>,
      <a class="xref" href="man.gbp.conf.html" title="gbp.conf"><span class="refentrytitle">gbp.conf</span>(5)</a>,
            <span class="citerefentry"><span class="refentrytitle">debuild</span>(1)</span>,
      <span class="citerefentry"><span class="refentrytitle">git</span>(1)</span>,
      <span class="citerefentry"><span class="refentrytitle">pristine-tar</span>(1)</span>,
      <a class="ulink" href="file:///usr/share/doc/git-buildpackage/manual-html/index.html" target="_top">
      <em class="citetitle">The Git-Buildpackage Manual</em></a>

      <a class="ulink" href="https://honk.sigxcpu.org/cl2vcs" target="_top">
      <em class="citetitle">Cl2vcs</em></a>,
    </p>
</div>
<div class="refsect1">
<a name="id-1.9.21.10"></a><h2>AUTHOR</h2>
<p>
    Markus Lehtonen <code class="email">&lt;<a class="email" href="mailto:markus.lehtonen@linux.intel.com">markus.lehtonen@linux.intel.com</a>&gt;</code>
    </p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc</div>
</body>
</html>