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 1465661 - openscap ships with outdated documentation
Summary: openscap ships with outdated documentation
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: openscap
Version: 7.4
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: rc
: ---
Assignee: Jan Černý
QA Contact: Matus Marhefka
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-06-27 21:23 UTC by Marek Haicman
Modified: 2020-11-14 07:42 UTC (History)
5 users (show)

Fixed In Version: openscap-1.2.17-10.el7
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-09-29 19:53:30 UTC
Target Upstream Version:
Embargoed:
lcervako: mirror+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2020:3914 0 None None None 2020-09-29 19:53:43 UTC

Description Marek Haicman 2017-06-27 21:23:01 UTC
Description of problem:
Current openscap version ships with only README.md file as a documentation. This README.md file contains links to Manual and Contributors page, which is no longer available, as it points to maint-1.0 version (the branch has been removed few weeks ago).

Also I would expect to have manual being part of the package, not just reference to the web (because of air-gapped systems, and because the upstream changes might reference features and options not available in the shipped version)

Version-Release number of selected component (if applicable):
openscap-1.2.14-2.el7.x86_64

How reproducible:
reliably

Steps to Reproduce:
1. ls /usr/share/doc/openscap-1.2.14
2. less /usr/share/doc/openscap-1.2.14/README.md
3.

Actual results:
1) only README.md is there
2) README.md contains links to manual and contributors page with maint-1.0, thus inaccessible.

Expected results:
1) Generated manual is shipped
2) README contains working links, with both being properly marked as upstream, and thus possibly for newer version than what is installed.

Additional info:

Comment 1 Martin Preisler 2017-11-15 19:45:57 UTC
Upstream has merged a patch for this: https://github.com/OpenSCAP/openscap/commit/e7947d0701

Comment 2 Martin Preisler 2017-11-15 20:45:55 UTC
The posted patch is only for 2), a patch for 1) hasn't been posted yet.

Comment 3 Jan Černý 2018-10-25 10:57:30 UTC
Patch for expected result 1) https://github.com/OpenSCAP/openscap/pull/1254/files has been merged upstream as well.

Comment 4 Matěj Týč 2018-10-25 14:17:42 UTC
Remark: To fix this bug for good, a downstream patch is required that adds the manual and image to the doc folder.

Comment 5 Matěj Týč 2018-10-25 14:18:47 UTC
Mark, could you please grant this a PM ACK? This feature is a small, but pleasant addition for users with air-gapped systems.

Comment 12 errata-xmlrpc 2020-09-29 19:53:30 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 (openscap bug fix and enhancement update), 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://access.redhat.com/errata/RHBA-2020:3914


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