From 5f5054b93cbe7d4422188adea00ab4e75e5ccfe2 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Mon, 5 Jun 2023 17:18:55 +0200 Subject: [PATCH] chore(linux): Fix lintian warnings - add rudimentary man page for keyman-system-service - remove hashbang for bash completion files - reword description for keyman-system-service This fixes these lintian warnings: keyman-system-service: description-is-pkg-name Keyman system service keyman: bash-completion-with-hashbang /usr/bin/env bash [usr/share/bash-completion/completions/km-config:1] keyman-system-service: no-manual-page [usr/libexec/keyman-system-service] --- linux/debian/control | 2 +- linux/debian/keyman-system-service.manpages | 1 + linux/keyman-config/km-config.bash-completion | 3 ++- linux/keyman-config/km-kvk2ldml.bash-completion | 3 ++- linux/keyman-config/km-package-get.bash-completion | 3 ++- linux/keyman-config/km-package-install.bash-completion | 3 ++- .../km-package-list-installed.bash-completion | 3 ++- .../keyman-config/km-package-uninstall.bash-completion | 3 ++- .../keyman-system-service/man/keyman-system-service.1 | 10 ++++++++++ 9 files changed, 24 insertions(+), 7 deletions(-) create mode 100644 linux/debian/keyman-system-service.manpages create mode 100644 linux/keyman-system-service/man/keyman-system-service.1 diff --git a/linux/debian/control b/linux/debian/control index 02dd064749..624f89fc0a 100644 --- a/linux/debian/control +++ b/linux/debian/control @@ -191,7 +191,7 @@ Depends: libevdev2, ${misc:Depends}, ${shlibs:Depends}, -Description: Keyman system service +Description: System service for Keyman Originally created in 1993 to type Lao on Windows, Keyman is now a free and open source keyboarding platform which allows anyone to write a keyboard layout for their language. Keyman is available for many platforms, including diff --git a/linux/debian/keyman-system-service.manpages b/linux/debian/keyman-system-service.manpages new file mode 100644 index 0000000000..cb4d9f0500 --- /dev/null +++ b/linux/debian/keyman-system-service.manpages @@ -0,0 +1 @@ +linux/keyman-system-service/man/keyman-system-service.1 diff --git a/linux/keyman-config/km-config.bash-completion b/linux/keyman-config/km-config.bash-completion index b1f46c0076..fd0eee394c 100644 --- a/linux/keyman-config/km-config.bash-completion +++ b/linux/keyman-config/km-config.bash-completion @@ -1,4 +1,5 @@ -#!/usr/bin/env bash +# shellcheck disable=SC2148 +# No hashbang for bash completion scripts! They are intended to be sourced, not executed. _km-config_completions() { diff --git a/linux/keyman-config/km-kvk2ldml.bash-completion b/linux/keyman-config/km-kvk2ldml.bash-completion index 3eb2950c39..1e8231a1a1 100644 --- a/linux/keyman-config/km-kvk2ldml.bash-completion +++ b/linux/keyman-config/km-kvk2ldml.bash-completion @@ -1,4 +1,5 @@ -#!/usr/bin/env bash +# shellcheck disable=SC2148 +# No hashbang for bash completion scripts! They are intended to be sourced, not executed. _km-kvk2ldml_completions() { diff --git a/linux/keyman-config/km-package-get.bash-completion b/linux/keyman-config/km-package-get.bash-completion index 9bacb1b8fe..0fb3a4d14c 100644 --- a/linux/keyman-config/km-package-get.bash-completion +++ b/linux/keyman-config/km-package-get.bash-completion @@ -1,4 +1,5 @@ -#!/usr/bin/env bash +# shellcheck disable=SC2148 +# No hashbang for bash completion scripts! They are intended to be sourced, not executed. _km-package-get_completions() { diff --git a/linux/keyman-config/km-package-install.bash-completion b/linux/keyman-config/km-package-install.bash-completion index 1a424e8ea6..06bfeb6aa5 100644 --- a/linux/keyman-config/km-package-install.bash-completion +++ b/linux/keyman-config/km-package-install.bash-completion @@ -1,4 +1,5 @@ -#!/usr/bin/env bash +# shellcheck disable=SC2148 +# No hashbang for bash completion scripts! They are intended to be sourced, not executed. _km-package-install_completions() { diff --git a/linux/keyman-config/km-package-list-installed.bash-completion b/linux/keyman-config/km-package-list-installed.bash-completion index a3758b467e..672353b9a1 100644 --- a/linux/keyman-config/km-package-list-installed.bash-completion +++ b/linux/keyman-config/km-package-list-installed.bash-completion @@ -1,4 +1,5 @@ -#!/usr/bin/env bash +# shellcheck disable=SC2148 +# No hashbang for bash completion scripts! They are intended to be sourced, not executed. _km-package-list-installed_completions() { diff --git a/linux/keyman-config/km-package-uninstall.bash-completion b/linux/keyman-config/km-package-uninstall.bash-completion index 191e709eab..4b81c38dac 100644 --- a/linux/keyman-config/km-package-uninstall.bash-completion +++ b/linux/keyman-config/km-package-uninstall.bash-completion @@ -1,4 +1,5 @@ -#!/usr/bin/env bash +# shellcheck disable=SC2148 +# No hashbang for bash completion scripts! They are intended to be sourced, not executed. _km-package-uninstall_completions() { diff --git a/linux/keyman-system-service/man/keyman-system-service.1 b/linux/keyman-system-service/man/keyman-system-service.1 new file mode 100644 index 0000000000..b506bd1607 --- /dev/null +++ b/linux/keyman-system-service/man/keyman-system-service.1 @@ -0,0 +1,10 @@ +.TH KEYMAN-SYSTEM-SERVICE "1" "May 2023" "keyman-system-service" "User Commands" +.SH NAME +keyman-system-service \- System service for Keyman +.SH DESCRIPTION +\&keyman\-system\-service +.TP +This command should not be run directly. It will be started as a DBUS +system service by systemd. +.SH "SEE ALSO" +.BR ibus-engine-keyman(1)