From: Roman Storozhenko <romeusmeister@gmail.com>
To: Thomas Renninger <trenn@suse.com>, Shuah Khan <shuah@kernel.org>
Cc: Javier Carrasco <javier.carrasco.cruz@gmail.com>,
linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
Roman Storozhenko <romeusmeister@gmail.com>
Subject: [PATCH v2] cpupower: Make help command available for custom install dir
Date: Sat, 22 Jun 2024 15:01:07 +0200 [thread overview]
Message-ID: <20240622-fix-help-issue-v2-1-6c19e28a4ec1@gmail.com> (raw)
When the 'cpupower' utility installed in the custom dir, it fails to
render appropriate help info for a particular subcommand:
$ LD_LIBRARY_PATH=lib64/ bin/cpupower help monitor
with error message like 'No manual entry for cpupower-monitor.1'
The issue is that under the hood it calls 'exec' function with
the following args: 'man cpupower-monitor.1'. In turn, 'man' search
path is defined in '/etc/manpath.config'. Of course it contains only
standard system man paths.
Make subcommands help available for a user by setting up 'MANPATH'
environment variable to the custom installation man pages dir. That
variable value will be prepended to the man pages standard search paths
as described in 'SEARCH PATH' section of MANPATH(5).
Signed-off-by: Roman Storozhenko <romeusmeister@gmail.com>
---
Changes in v2:
- Fixed spelling errors
- Simplified man pages search approach by the 'MANPATH' variable usage
- Link to v1: https://lore.kernel.org/r/20240621-fix-help-issue-v1-1-7906998d46eb@gmail.com
---
tools/power/cpupower/utils/cpupower.c | 41 ++++++++++++++++++++++++++++++-----
1 file changed, 35 insertions(+), 6 deletions(-)
diff --git a/tools/power/cpupower/utils/cpupower.c b/tools/power/cpupower/utils/cpupower.c
index 9ec973165af1..1b1b79c572ad 100644
--- a/tools/power/cpupower/utils/cpupower.c
+++ b/tools/power/cpupower/utils/cpupower.c
@@ -12,6 +12,8 @@
#include <unistd.h>
#include <errno.h>
#include <sched.h>
+#include <libgen.h>
+#include <limits.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/utsname.h>
@@ -80,14 +82,17 @@ static void print_help(void)
static int print_man_page(const char *subpage)
{
- int len;
- char *page;
+ char *page, *man_path, *exec_dir;
+ char exec_path[PATH_MAX];
+ int subpage_len;
- len = 10; /* enough for "cpupower-" */
- if (subpage != NULL)
- len += strlen(subpage);
+ if (!subpage)
+ return -EINVAL;
- page = malloc(len);
+ subpage_len = 10; /* enough for "cpupower-" */
+ subpage_len += strlen(subpage);
+
+ page = malloc(subpage_len);
if (!page)
return -ENOMEM;
@@ -97,6 +102,30 @@ static int print_man_page(const char *subpage)
strcat(page, subpage);
}
+ /* Get current process image name full path */
+ if (readlink("/proc/self/exe", exec_path, PATH_MAX) > 0) {
+ exec_dir = strdup(exec_path);
+ if (!exec_dir) {
+ free(page);
+ free(man_path);
+ return -ENOMEM;
+ }
+
+ /* Prepend standard search path for man pages with relative path
+ * to custom install man directory
+ */
+ if (asprintf(&man_path, "%s/../man:", dirname(exec_dir)) > 0) {
+ setenv("MANPATH", man_path, 1);
+ free(exec_dir);
+ free(man_path);
+ } else {
+ free(page);
+ free(exec_dir);
+ free(man_path);
+ return -ENOMEM;
+ }
+ }
+
execlp("man", "man", page, NULL);
/* should not be reached */
---
base-commit: 2102cb0d050d34d50b9642a3a50861787527e922
change-id: 20240619-fix-help-issue-573c40bb6427
Best regards,
--
Roman Storozhenko <romeusmeister@gmail.com>
next reply other threads:[~2024-06-22 13:01 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-22 13:01 Roman Storozhenko [this message]
2024-06-25 19:29 ` [PATCH v2] cpupower: Make help command available for custom install dir Shuah Khan
2024-06-26 7:29 ` Roman Storozhenko
2024-06-26 15:36 ` Shuah Khan
2024-06-26 18:43 ` Roman Storozhenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240622-fix-help-issue-v2-1-6c19e28a4ec1@gmail.com \
--to=romeusmeister@gmail.com \
--cc=javier.carrasco.cruz@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=shuah@kernel.org \
--cc=trenn@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox