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 1225937 - /usr/share/doc/openscap-1.1.1/README update
Summary: /usr/share/doc/openscap-1.1.1/README update
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: openscap
Version: 7.2
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: rc
: ---
Assignee: Šimon Lukašík
QA Contact: Marek Haicman
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-05-28 13:41 UTC by Martin Žember
Modified: 2015-11-19 12:09 UTC (History)
4 users (show)

Fixed In Version: openscap-1.2.4-1.el7
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-11-19 12:09:38 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHEA-2015:2356 0 normal SHIPPED_LIVE openscap bug fix and enhancement update 2015-11-19 10:41:25 UTC

Description Martin Žember 2015-05-28 13:41:51 UTC 
Description of problem:
/usr/share/doc/openscap-1.1.1/README may need some polishing

Version-Release number of selected component (if applicable):
openscap-1.1.1-3.el7

How reproducible:
100%

Steps to Reproduce:
-

Actual results:
Run 'scap'

Expected results:
Run 'oscap'
Mention openscap-scanner subpackage
Mention an existing profile or a way how to find one
Comment 2 Šimon Lukašík 2015-06-17 12:47:20 UTC 
I agree that current README file is slightly outdated. We have greatly
improved README.md file in the upstream repository and it will go to RHEL-7.

However, I am afraid that we will not meet "Expected results" such:
> Mention openscap-scanner subpackage
This is an upstream README file. It is not possible to get there any information regarding downstream packaging. Does other components have documentation wrt downstream sub-packages?

> Mention an existing profile or a way how to find one
There are now profiles in OpenSCAP. Profiles are within scap-security-guide project.

The best information wrt profiles can be found in `man scap-security-guide`.
Comment 3 Petr Lautrbach 2015-06-17 13:04:27 UTC 
Would it make sense to add e.g. README.RHEL describing RHEL packaging and downstream changes?
Comment 4 Martin Žember 2015-06-17 14:40:02 UTC 
The expected result is not strict, let's reformulate it as high-level specifications what I would guess a user might expect:

The information that is needed to run the oscap binary
What is typically done when openscap is used

There can be a link to a website or to a README.RHEL file but without it, I am not sure it makes much sense. Given that READMEs are often useless, I would personally not want to traverse through READMEs when looking for practical information.

The user needs to know that there is a connection with SSG and that further information can be found by running `man scap-security-guide` (after he had installed it first).

How about having a patch that adds all RHEL-specific information to the file?
Comment 5 Šimon Lukašík 2015-06-18 08:29:53 UTC 
Does not make sense to me, Petr. Neither I want not add README.RHEL, nor I want a RHEL specific patch in the README.

This is not how we do things here. Red Hat spends a lot of time writing extensive documentation for each product. We want users to use this documentation. We have extra teams that make sure this documentation is well written, polished and makes overall sense.

You are right that readme's are often useless. That's why we try to build high quality prose.

Last year, I have spent a lot of time writing a verbose documentation for our RHEL customers. It is part of RHEL6 and RHEL7 Security Guide. You can find it at 

    https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Security_Guide/chap-Compliance_and_Vulnerability_Scanning.html

It contains a lot of useful information on how to use OpenSCAP in context of Red Hat products. Please file a bugs against this documentation if anything is missing.
Comment 6 Martin Žember 2015-06-19 16:57:42 UTC 
(In reply to Šimon Lukašík from comment #5)
> ...
> Last year, I have spent a lot of time writing a verbose documentation for
> our RHEL customers. It is part of RHEL6 and RHEL7 Security Guide. You can
> find it at 
> 
>    
> https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/
> html/Security_Guide/chap-Compliance_and_Vulnerability_Scanning.html
> 
> It contains a lot of useful information on how to use OpenSCAP in context of
> Red Hat products. Please file a bugs against this documentation if anything
> is missing.

What a great document!

It is a pity that I did not know about it. How to make it more visible?

BTW it says "To install oscap to your system, run the following command as root:
~]# yum install openscap-utils" which is in openscap-scanner currently.
Comment 7 Šimon Lukašík 2015-06-19 18:59:01 UTC 
Nice catch. Could you please file a bug against Security Guide? (Please review rhel6 Security Guide as well and clone the bug if needed.

Please also review existing bugs against this document. It might be know issue already.
Comment 9 Martin Žember 2015-06-25 12:41:25 UTC 
(In reply to Šimon Lukašík from comment #7)
> Nice catch. Could you please file a bug against Security Guide? (Please
> review rhel6 Security Guide as well and clone the bug if needed.

Done, filed bz#1235647 and bz#1235648.
Comment 10 Martin Žember 2015-06-25 14:17:10 UTC 
Reviewed the new README.md file, minor changes suggested upstream.
https://github.com/OpenSCAP/openscap/compare/maint-1.2...zemb:patch-1
Comment 11 Šimon Lukašík 2015-06-26 08:21:35 UTC 
Merged to upstream. Thanks Martin!
Comment 13 Marek Haicman 2015-09-01 13:23:51 UTC 
Verified, README now does not contain obvious flaws. Regression suite passed.
Comment 14 errata-xmlrpc 2015-11-19 12:09:38 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-2015-2356.html
Note You need to log in before you can comment on or make changes to this bug.