1DH_INSTALLCHANGELOGS(1)            Debhelper           DH_INSTALLCHANGELOGS(1)
2
3
4

NAME

6       dh_installchangelogs - install changelogs into package build
7       directories
8

SYNOPSIS

10       dh_installchangelogs [debhelper options] [-k] [-Xitem] [upstream]
11

DESCRIPTION

13       dh_installchangelogs is a debhelper program that is responsible for
14       installing changelogs into package build directories.
15
16       An upstream changelog file may be specified as an option. If none is
17       specified, dh_installchangelogs may look for files with names that seem
18       likely to be changelogs as described in the next paragraphs.
19
20       In non-native packages, dh_installchangelogs will first look for
21       changelog files installed by the upstream build system into
22       usr/share/doc/package (of the package build directory) and rename the
23       most likely candidate (if any) to usr/share/doc/package/changelog.
24       Note that dh_installchangelogs does not look into any source directory
25       (such as debian/tmp). Otherwise, dh_installchangelogs (at compatibility
26       level 7 or any later) will look for changelog files in the source
27       directory (e.g. the root or the docs subdirectory).  It will look for
28       changelog, changes and history optionally with common extensions (such
29       as .txt, .md and .rst).
30
31       If a changelog file is specified and is an html file (determined by
32       file extension), it will be installed as
33       usr/share/doc/package/changelog.html instead. If the html changelog is
34       converted to plain text, that variant can be specified as a second
35       parameter. When no plain text variant is specified, a short
36       usr/share/doc/package/changelog is generated, pointing readers at the
37       html changelog file.
38

FILES

40       debian/changelog
41       debian/NEWS
42       debian/package.changelog
43       debian/package.NEWS
44           Automatically installed into usr/share/doc/package/ in the package
45           build directory.
46
47           Use the package specific name if package needs a different NEWS or
48           changelog file.
49
50           The changelog file is installed with a name of changelog for native
51           packages, and changelog.Debian for non-native packages.  The NEWS
52           file is always installed with a name of NEWS.Debian.
53

OPTIONS

55       -k, --keep
56           Keep the original name of the upstream changelog. This will be
57           accomplished by installing the upstream changelog as changelog, and
58           making a symlink from that to the original name of the changelog
59           file. This can be useful if the upstream changelog has an unusual
60           name, or if other documentation in the package refers to the
61           changelog file.
62
63       -Xitem, --exclude=item
64           Exclude upstream changelog files that contain item anywhere in
65           their filename from being installed.
66
67           Note that directory name of the changelog is also part of the
68           match.
69
70       upstream
71           Install this file as the upstream changelog.
72

SEE ALSO

74       debhelper(7)
75
76       This program is a part of debhelper.
77

AUTHOR

79       Joey Hess <joeyh@debian.org>
80
81
82
8313.3.4                            2021-05-13           DH_INSTALLCHANGELOGS(1)