Red Hat Bugzilla – Bug 1249961
error in the table on Security-related commands usable with yum updateinfo
Last modified: 2015-09-15 06:45:53 EDT
Document URL: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Security_Guide/chap-Keeping_Your_System_Up-to-Date.html#sec-Planning_and_Configuring_Security_Updates
Section Number and Name: 3.1.1. Planning and Configuring Security Updates
Describe the issue:
Table 3.1. Security-related commands usable with yum updateinfo contains several commands and their syntax however the syntax of this table is inconsistent and the description of the advisory command contains an incorrect reference.
Incorrect reference: the optional argument to the advisory command is written as [advisories] while the description refers to this argument as "Replace advisory with an advisory number or numbers." When taken literally this will result in an error.
Syntax issue: the optional argument to the advisory command is written as [advisories] while the optional argument to the severity command command is written without brackets and in italic font.
Suggestions for improvement:
- use standard formatting for commands, and (optional) arguments
- use the correct reference "Replace advisories with an advisory number or numbers."
The information on how to report errors in documentation appears to be missing from ALL documents I checked (both RHEL6 and RHEL7). I suggest that you add this section again.
Thanks for reporting this. I fixed both the syntax and the description. It'll take probably about a week for the guide to get updated on the Customer Portal.
As for the information about bug reporting, I'll inquire about the possibility of putting it back into the guides.
Again, thanks for taking the time to report a bug even if the instructions were missing.
The updated guide has been published as a part of the RHEL 7.2 Beta documentation set.