Xilinx / dma_ip_drivers

Xilinx QDMA IP Drivers
https://xilinx.github.io/dma_ip_drivers/
581 stars 421 forks source link

cmd-ctrl man page doesn't work after installed. #197

Open busfault opened 1 year ago

busfault commented 1 year ago

After installing the apps which does a copy of dma-ctl.8.gz to the /usr/shared/man/man8/ directory. The command man dma-ctl returns the compressed data (trimmed example below)

$ man dma-ctl

PK^C^D^HБÊTqÜ<U+0086>G     ¡2      dma‐ctl.8UT
...

When I did sudo gunzip /usr/share/man/man8/dma-ctl.8.gz then a sudo gunzip /usr/share/man/man8/dma-ctl.8 a man dma-ctl works properly.

A solution I have to this to keep the dma-ctl.8 unzipped in source then apply a gzip during the install in the Makefile. Adding the line @gzip -kf docs/dma-ctl.8 to QDMA/linux-kernel/Makefile fixes this on my system (Ubuntu 18.04)

.PHONY: install-apps
install-apps:
        @echo "installing apps to $(apps_install_path) ..."
        @mkdir -p -m 755 $(apps_install_path)
        @install -v -m 755 bin/dma-ctl* $(apps_install_path)
        @install -v -m 755 bin/dma-xfer* $(apps_install_path)
        @install -v -m 755 bin/dma-from-device $(apps_install_path)
        @install -v -m 755 bin/dma-to-device $(apps_install_path)
        @install -v -m 755 bin/dma-perf $(apps_install_path)
        @install -v -m 755 bin/dma-latency $(apps_install_path)
        @echo "MAN PAGES:"
        @mkdir -p -m 755 $(docs_install_path)
        @gzip -kf docs/dma-ctl.8
        @install -v -m 644 docs/dma-ctl.8.gz $(docs_install_path)
busfault commented 1 year ago

Ubuntu, kernel, and affected tool versions

$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 18.04.5 LTS
Release:        18.04
Codename:       bionic

$ uname -r
5.4.0-42-generic

$ gzip --version
gzip 1.6
Copyright (C) 2007, 2010, 2011 Free Software Foundation, Inc.
Copyright (C) 1993 Jean-loup Gailly.
This is free software.  You may redistribute copies of it under the terms of
the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
There is NO WARRANTY, to the extent permitted by law.

Written by Jean-loup Gailly.

$ man --version
man 2.8.3

$ install --version
install (GNU coreutils) 8.28
Copyright (C) 2017 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Written by David MacKenzie.