Tarball on download.gnome.org includes broken man pages
Affected version
gnome-shell 40.1 (and 40.0)
Tested on Fedora 34.
Bug summary
In the source tarball provided on the gnome-shell web site:
https://download.gnome.org/sources/gnome-shell/40/gnome-shell-40.1.tar.xz
There are two man pages that are included that are not part of the git repository: man/gnome-shell.1 subprojects/extensions-tool/man/gnome-extensions.1
Those files are not nroff documents, but instead HTML. They appear to be a product of an old man page documentation project, because the latest man pages are generated by a2x
from man/gnome-shell.txt and subprojects/extensions-tool/man/gnome-extensions.txt.
Unfortunately, because these files are included in the download tarball, they are being distributed as the man pages for gnome-shell
and gnome-extensions
on Fedora, since the build environment doesn't detect that they need to rebuild them. A solution on Fedora is to delete the .1 files before compiling (and adding the asciidoc
BuildRequires), but the better solution would be to fix the GNOME Shell pipeline to remove those files from the tarballs.
Steps to reproduce
1.) Compile and build gnome-shell using the tarball instead of the git repository 2.) Run 'man gnome-shell' using the included man page
What happened
The man page is not an nroff-encoded file, but raw HTML, so you get
$ man gnome-shell
<?xml version="1.0" encoding="UTF‐8"?> <!DOCTYPE html PUBLIC
"‐//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta
http‐equiv="Content‐Type" content="application/xhtml+xml;
charset=UTF‐8" /> <meta name="generator" content="AsciiDoc
8.6.10" /> <title>GNOME‐SHELL(1)</title> <style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
[...]
Similar results for man gnome-extensions
.
What did you expect to happen
'man gnome-shell' and 'man gnome-extensions' should return their man pages.