[PATCH 1/2] Install uncompressed man pages

[PATCH 1/2] Install uncompressed man pages

[Mike Gilbert]

Build systems do not typically compress man pages when installing them.
This is generally left to distro packaging mechanisms, which may end up
recompressing them using a different compressor.
---
 Documentation/Makefile.in | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/Makefile.in b/Documentation/Makefile.in
index 184647c4..c4c843cb 100644
--- a/Documentation/Makefile.in
+++ b/Documentation/Makefile.in
@@ -37,9 +37,9 @@ MAN3_TXT += btrfs-ioctl.asciidoc
 MAN_TXT = $(MAN3_TXT) $(MAN8_TXT) $(MAN5_TXT)
 MAN_XML = $(patsubst %.asciidoc,%.xml,$(MAN_TXT))
 MAN_HTML = $(patsubst %.asciidoc,%.html,$(MAN_TXT))
-GZ_MAN3 = $(patsubst %.asciidoc,%.3.gz,$(MAN3_TXT))
-GZ_MAN5 = $(patsubst %.asciidoc,%.5.gz,$(MAN5_TXT))
-GZ_MAN8 = $(patsubst %.asciidoc,%.8.gz,$(MAN8_TXT))
+MAN3 = $(patsubst %.asciidoc,%.3,$(MAN3_TXT))
+MAN5 = $(patsubst %.asciidoc,%.5,$(MAN5_TXT))
+MAN8 = $(patsubst %.asciidoc,%.8,$(MAN8_TXT))
 
 mandir ?= $(prefix)/share/man
 man3dir = $(mandir)/man3
@@ -86,9 +86,9 @@ endif
 
 all: man
 man: man3 man5 man8
-man3: $(GZ_MAN3)
-man5: $(GZ_MAN5)
-man8: $(GZ_MAN8)
+man3: $(MAN3)
+man5: $(MAN5)
+man8: $(MAN8)
 html: $(MAN_HTML)
 
 install: install-man
@@ -96,15 +96,15 @@ install: install-man
 install-man: man
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
-	$(INSTALL) -m 644 $(GZ_MAN5) $(DESTDIR)$(man5dir)
+	$(INSTALL) -m 644 $(MAN5) $(DESTDIR)$(man5dir)
 	# the source file name of btrfs.5 clashes with section 8 page, but we
 	# want to keep the code generic
-	$(MV) $(DESTDIR)$(man5dir)/btrfs-man5.5.gz $(DESTDIR)$(man5dir)/btrfs.5.gz
-	$(INSTALL) -m 644 $(GZ_MAN8) $(DESTDIR)$(man8dir)
-	$(LN_S) -f btrfs-check.8.gz $(DESTDIR)$(man8dir)/btrfsck.8.gz
+	$(MV) $(DESTDIR)$(man5dir)/btrfs-man5.5 $(DESTDIR)$(man5dir)/btrfs.5
+	$(INSTALL) -m 644 $(MAN8) $(DESTDIR)$(man8dir)
+	$(LN_S) -f btrfs-check.8 $(DESTDIR)$(man8dir)/btrfsck.8
 
 uninstall:
-	cd $(DESTDIR)$(man8dir); rm -f btrfs-check.8.gz $(GZ_MAN8)
+	cd $(DESTDIR)$(man8dir); rm -f btrfs-check.8 $(MAN8)
 	$(RMDIR) -p --ignore-fail-on-non-empty $(DESTDIR)$(man8dir)
 
 clean:
-- 
2.18.0

[PATCH 2/2] Install btrfs-ioctl.3 man page

[Mike Gilbert]

---
 Documentation/Makefile.in | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/Makefile.in b/Documentation/Makefile.in
index c4c843cb..5bc0d80d 100644
--- a/Documentation/Makefile.in
+++ b/Documentation/Makefile.in
@@ -94,8 +94,10 @@ html: $(MAN_HTML)
 install: install-man
 
 install-man: man
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man3dir)
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
+	$(INSTALL) -m 644 $(MAN3) $(DESTDIR)$(man3dir)
 	$(INSTALL) -m 644 $(MAN5) $(DESTDIR)$(man5dir)
 	# the source file name of btrfs.5 clashes with section 8 page, but we
 	# want to keep the code generic
-- 
2.18.0

Re: [PATCH 2/2] Install btrfs-ioctl.3 man page

[David Sterba]

On Mon, Aug 06, 2018 at 04:54:32PM -0400, Mike Gilbert wrote:
> ---
>  Documentation/Makefile.in | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/Makefile.in b/Documentation/Makefile.in
> index c4c843cb..5bc0d80d 100644
> --- a/Documentation/Makefile.in
> +++ b/Documentation/Makefile.in
> @@ -94,8 +94,10 @@ html: $(MAN_HTML)
>  install: install-man
>  
>  install-man: man
> +	$(INSTALL) -d -m 755 $(DESTDIR)$(man3dir)
>  	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
>  	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
> +	$(INSTALL) -m 644 $(MAN3) $(DESTDIR)$(man3dir)

MAN3_TXT += btrfs-ioctl.asciidoc

The section 3 page is not ready to be published so it's intentionally
left out of installation.

Re: [PATCH 1/2] Install uncompressed man pages

[David Sterba]

On Mon, Aug 06, 2018 at 04:54:31PM -0400, Mike Gilbert wrote:
> Build systems do not typically compress man pages when installing them.
> This is generally left to distro packaging mechanisms, which may end up
> recompressing them using a different compressor.

Makes sense. I've tested this on openSUSE and there's a post-build step
that indeed recompresses the manual pages. It does not work for me here
with the uncompressed pages yet for some reason, also the symlinked
pages would need to be reworked to the manual page links, but that can
be fixed.

I'll queue this patch for a major release, expecting that some breakage
might happen. Thanks.

Re: [PATCH 1/2] Install uncompressed man pages

[David Sterba]

On Tue, Aug 07, 2018 at 04:09:57PM +0200, David Sterba wrote:
> On Mon, Aug 06, 2018 at 04:54:31PM -0400, Mike Gilbert wrote:
> > Build systems do not typically compress man pages when installing them.
> > This is generally left to distro packaging mechanisms, which may end up
> > recompressing them using a different compressor.
> 
> Makes sense. I've tested this on openSUSE and there's a post-build step
> that indeed recompresses the manual pages. It does not work for me here
> with the uncompressed pages yet for some reason, also the symlinked
> pages would need to be reworked to the manual page links, but that can
> be fixed.
> 
> I'll queue this patch for a major release, expecting that some breakage
> might happen. Thanks.

FYI, the patches are now in devel. Expected release is in 4.18.