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] [--no-trim]
11       [upstream]
12

DESCRIPTION

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

FILES

46       debian/changelog
47       debian/NEWS
48       debian/package.changelog
49       debian/package.NEWS
50           Automatically installed into usr/share/doc/package/ in the package
51           build directory.
52
53           Use the package specific name if package needs a different NEWS or
54           changelog file.
55
56           The changelog file is installed with a name of changelog for native
57           packages, and changelog.Debian for non-native packages.  The NEWS
58           file is always installed with a name of NEWS.Debian.
59

OPTIONS

61       -k, --keep
62           Keep the original name of the upstream changelog. This will be
63           accomplished by installing the upstream changelog as changelog, and
64           making a symlink from that to the original name of the changelog
65           file. This can be useful if the upstream changelog has an unusual
66           name, or if other documentation in the package refers to the
67           changelog file.
68
69       -Xitem, --exclude=item
70           Exclude upstream changelog files that contain item anywhere in
71           their filename from being installed.
72
73           Note that directory name of the changelog is also part of the
74           match.
75
76       --no-trim
77           Install the full changelog, not its trimmed version that includes
78           only recent entries.
79
80       upstream
81           Install this file as the upstream changelog.
82

SEE ALSO

84       debhelper(7)
85
86       This program is a part of debhelper.
87

AUTHOR

89       Joey Hess <joeyh@debian.org>
90
91
92
9313.11.6                           2023-09-02           DH_INSTALLCHANGELOGS(1)
Impressum