865694 – yum-security man page has errors

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 865694 - yum-security man page has errors

Summary: yum-security man page has errors

Keywords:
Status:	CLOSED ERRATA
Alias:	None
Product:	Red Hat Enterprise Linux 6
Classification:	Red Hat
Component:	yum-utils
Sub Component:
Version:	6.3
Hardware:	Unspecified
OS:	Unspecified
Priority:	low
Severity:	low
Target Milestone:	rc
Target Release:	---
Assignee:	Valentina Mukhamedzhanova
QA Contact:	Eva Mrakova
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+	depends on / blocked

Reported:	2012-10-12 07:22 UTC by Karel Srot
Modified:	2016-05-10 21:31 UTC (History)
CC List:	8 users (show)
Fixed In Version:	yum-utils-1.1.30-33.el6
Doc Type:	Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:	2016-05-10 21:31:02 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)
yum-security.8 update plus display enhancement (2.28 KB, patch) 2014-06-18 07:40 UTC, Jan Chaloupka	no flags	Details \| Diff
View All

Links
System	ID	Private	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHEA-2016:0837	0	normal	SHIPPED_LIVE	yum-utils bug fix update	2016-05-10 22:42:01 UTC

Description Karel Srot 2012-10-12 07:22:44 UTC

Description of problem:

There are some errors in yum-security man page. 

* Description for "list" command is listed twice
* Description for the "summary" command is missing
* 3 possible use cases for updateinfo are listed
        yum updateinfo info
        yum updateinfo list
        yum updateinfo summary
  It should be mentioned that "yum updateinfo" is working too, i.e. that the "summary" is the default.

* There should be one blank before "yum updateinfo list", now it looks like the description of "yum update-minimal" belongs to the "yum updateinfo" command. See below:

       added yum commands are:
        yum update-minimal

       This works like the update command, but if you have the the package foo-1 installed and have
       foo-2  and foo-3 available with updateinfo.xml then update-minimal will update you to foo-3.
        yum updateinfo info
        yum updateinfo list
        yum updateinfo summary




Package version:
yum-utils-1.1.30-14.el6

Comment 2 RHEL Program Management 2013-10-14 00:22:53 UTC

This request was evaluated by Red Hat Product Management for
inclusion in the current release of Red Hat Enterprise Linux.
Because the affected component is not scheduled to be updated
in the current release, Red Hat is unable to address this
request at this time.

Red Hat invites you to ask your support representative to
propose this request, if appropriate, in the next release of
Red Hat Enterprise Linux.

Comment 3 Jan Chaloupka 2014-06-18 07:40:19 UTC

Created attachment 909871 [details]
yum-security.8 update plus display enhancement

> * Description for the "summary" command is missing
$ yum --security summary
Loaded plugins: product-id, refresh-packagekit, security, subscription-manager
No such command: summary. Please use /usr/bin/yum --help

$ /usr/bin/yum --help | grep summary | wc -l
0

- list removed
- yum updateinfo added
- some rearranging and display enhancement of lines

Comment 4 Jan Chaloupka 2014-06-18 07:40:55 UTC

Added yum commands are:
            yum update-minimal
                   This  works like the update command, but if you have the the package foo-1 installed and have foo-2 and foo-3 available with updateinfo.xml then update-
                   minimal will update you to foo-3.

            yum updateinfo info <sub-command>

            yum updateinfo list <sub-command>

            yum updateinfo summary <sub-command>

            yum updateinfo <sub-command>
                   Defaults to yum updateinfo summary

       where <sub-command> is:
            yum updateinfo * all
            yum updateinfo * available
            yum updateinfo * installed
            yum updateinfo * updates

Comment 5 Jan Chaloupka 2014-06-18 07:43:20 UTC

yum --security summary is missing, was it removed? The rest of the changes, is it ok fo you?

Comment 6 Karel Srot 2014-06-18 19:39:53 UTC

(In reply to Jan Chaloupka from comment #5)
> yum --security summary is missing, was it removed? The rest of the changes,
> is it ok fo you?

This is documented in man yum-security which is provided by yum-plugin-security.

Comment 8 Karel Srot 2014-06-19 07:03:35 UTC

Hi Jan, I am sorry, I misunderstood your comment.

What I mean by 

> * Description for the "summary" command is missing

is that the "summary" is not documented in the Description section, beside "info" and "list" and other commands/options. It is only mentioned in "yum updateinfo summary" without further explanation and in examples.

$ yum --security summary

This is of course wrong. Must be run as "yum updateinfo summary".

Comment 9 Jan Chaloupka 2014-06-19 09:03:54 UTC

Karel, I should have been more verbose. Thank you for explanation.

Using the grep output, summary could be commented as:

summary
        Is used to get a summary of advisories not yet installed.

James, what do you think?

Comment 10 Karel Srot 2014-06-19 11:02:32 UTC

Hi Jan, 
summary is not specific for installed advisories. Commands info/list/summary can be provided with subcommands all/available/installed/updates. Therefore I would propose to make the "summary" description similar to the current description of "info" and "list" commands.

E.g.
summary   Is  used  to show the summary of errata notice information, from the updateinfo.xml data in yum. This includes bugzillas, CVEs, security updates and new.

Comment 19 errata-xmlrpc 2016-05-10 21:31:02 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/RHEA-2016-0837.html

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