aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2018-10-19 10:24:46 +0200
committerJussi Pakkanen <jpakkane@gmail.com>2018-10-20 13:16:28 +0300
commite8232c7825fdb3783ffa84e90f3ab8f2224a1399 (patch)
tree8df75e076d71065e92db84cb59083d2a625debaf /docs/markdown
parent066060e8c9402b3ae510de7fbddeeb3b528247c9 (diff)
downloadmeson-e8232c7825fdb3783ffa84e90f3ab8f2224a1399.zip
meson-e8232c7825fdb3783ffa84e90f3ab8f2224a1399.tar.gz
meson-e8232c7825fdb3783ffa84e90f3ab8f2224a1399.tar.bz2
Remove implicit compression of man pages
Remove the code responsible for implicitly compressing manpages as .gz files. It has been established that manpage compression is a distro packager's task, with existing distros already having their own implementations of compression. Fixes #4330
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Installing.md2
-rw-r--r--docs/markdown/Reference-manual.md3
-rw-r--r--docs/markdown/snippets/manpage_compression.md7
3 files changed, 9 insertions, 3 deletions
diff --git a/docs/markdown/Installing.md b/docs/markdown/Installing.md
index 8348d4a..1aa444a 100644
--- a/docs/markdown/Installing.md
+++ b/docs/markdown/Installing.md
@@ -26,7 +26,7 @@ Other install commands are the following.
```meson
install_headers('header.h', subdir : 'projname') # -> include/projname/header.h
-install_man('foo.1') # -> share/man/man1/foo.1.gz
+install_man('foo.1') # -> share/man/man1/foo.1
install_data('datafile.dat', install_dir : join_paths(get_option('datadir'), 'progname')) # -> share/progname/datafile.dat
```
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 44545c5..69d895e 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -909,8 +909,7 @@ An example value could be `['rwxr-sr-x', 'root', 'root']`.
Installs the specified man files from the source tree into system's
man directory during the install step. This directory can be
overridden by specifying it with the `install_dir` keyword
-argument. All man pages are compressed during installation and
-installed with a `.gz` suffix.
+argument.
The `install_mode` argument can be used to specify the file mode in symbolic
format and optionally the owner/uid and group/gid for the installed files.
diff --git a/docs/markdown/snippets/manpage_compression.md b/docs/markdown/snippets/manpage_compression.md
new file mode 100644
index 0000000..8c96807
--- /dev/null
+++ b/docs/markdown/snippets/manpage_compression.md
@@ -0,0 +1,7 @@
+## Manpages are no longer compressed implicitly
+
+Earlier, the `install_man` command has automatically compressed installed
+manpages into `.gz` format. This collided with manpage compression hooks
+already used by various distributions. Now, manpages are installed uncompressed
+and distributors are expected to handle compressing them according to their own
+compression preferences.