1247737 – turbostat 1.2-7 man page verbose flag incorrect

RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1247737 - turbostat 1.2-7 man page verbose flag incorrect

Summary: turbostat 1.2-7 man page verbose flag incorrect

Keywords:
Status:	CLOSED ERRATA
Alias:	None
Product:	Red Hat Enterprise Linux 6
Classification:	Red Hat
Component:	cpupowerutils
Sub Component:
Version:	6.7
Hardware:	All
OS:	Linux
Priority:	unspecified
Severity:	medium
Target Milestone:	rc
Target Release:	---
Assignee:	Neil Horman
QA Contact:	Erik Hamera
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:	1172231 1269638 1270066
TreeView+	depends on / blocked

Reported:	2015-07-28 17:46 UTC by Matthew Whitehead
Modified:	2019-11-14 06:50 UTC (History)
CC List:	2 users (show)
Fixed In Version:
Doc Type:	Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:	2016-05-10 20:29:05 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)
new turbostat man page (11.10 KB, text/plain) 2015-07-31 19:08 UTC, Neil Horman	no flags	Details
View All

Links
System	ID	Private	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHBA-2016:0785	0	normal	SHIPPED_LIVE	cpupowerutils bug fix update	2016-05-10 22:36:22 UTC

Description Matthew Whitehead 2015-07-28 17:46:33 UTC

Description of problem: upgrading to turbostat 1.2-7 in RHEL6.7 changed the -v flag from 'verbose' to 'version', but the man page was not updated.


Version-Release number of selected component (if applicable): upgrading from turbostat 1.2-5 to 1.2-7

How reproducible: 100%


Steps to Reproduce:
1. run 'turbostat -v', it will return the version information, not put the command in verbose mode.

Actual results:

Below is a partial diff of the changed code:

+               case 'D':
+                       dump_only++;
                        break;
-               case 'v':
-                       verbose++;
+               case 'd':
+                       debug++;
                        break;

...

-               default:
-                       usage();
+               case 'v':
+                       print_version();
+                       exit(0);
+                       break


Expected results:

Man page should reflect program behavior.

Additional info:

Comment 2 Neil Horman 2015-07-28 20:25:37 UTC

way too late for 6.7, needs to wait for 6.8

Comment 3 Frank Hirtz 2015-07-28 21:16:27 UTC

Heh, we just had a mid-air collision as I was setting the flags for 6.8. That should be fine.

Comment 4 Neil Horman 2015-07-31 19:08:11 UTC

Created attachment 1058111 [details]
new turbostat man page

Dow that look about right to you Frank?

Comment 5 Matthew Whitehead 2015-08-18 19:24:27 UTC

Looks correct to me. Too bad they removed the 'verbose' flag completely.

Comment 6 Neil Horman 2015-08-18 20:19:02 UTC

ok, I'll commit this if it gets approved for 6.8

Comment 7 Frank Hirtz 2015-10-27 19:34:31 UTC

ACK, it looks fine to me.

Comment 9 Erik Hamera 2016-03-10 16:18:39 UTC

Hi Neil,
there is no '-v' parameter mentioned neither in the man page nor in turbostat --help output. So is isn't misleading now.

My personal opinion is, that all existing parameters should be described in the man page. OTOH I can accept is as deprecated parameter and let is pass.

What do you think about?

Comment 10 Erik Hamera 2016-03-10 16:19:32 UTC

# turbostat --help 2>&1|grep -- '-v'
--version       print version information
# man turbostat|grep -- '-v'
       --version displays the version.
# turbostat -v sleep 1
turbostat version 4.8 26-Sep, 2015 - Len Brown <lenb>

Comment 11 Neil Horman 2016-03-14 14:41:32 UTC

yes, please accept it as deprecated

Comment 12 Erik Hamera 2016-03-14 19:14:11 UTC

O.K., thanks for the info.

Comment 14 errata-xmlrpc 2016-05-10 20:29:05 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHBA-2016-0785.html

Note You need to log in before you can comment on or make changes to this bug.