Note: This bug is displayed in read-only format because
the product is no longer active in Red Hat Bugzilla.
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.
Description of problem:
Currently, we have lorax-composer documentation available in the source, but is not included in the final built RPM manifest. Specifically, the following files are not included in an RPM:
docs/composer-cli.rst
docs/html/composer-cli.html
docs/html/lorax-composer.html
docs/lorax-composer.rst
It would be beneficial to include these docs in a lorax-composer-docs subpackage. This way, end users will know what documentation is applicable to their particular composer revision.
Version-Release number of selected component (if applicable):
lorax-28.14.23-2.el8
How reproducible:
Easily
Steps to Reproduce:
1. Install all lorax packages
# yum install lorax lorax-*
2. Verify if the above documents are located in the traditional /usr/share/doc/ directory
# find /usr/share/doc -name *composer*
Actual results:
Nothing returned
Expected results:
/usr/share/doc/lorax/composer/composer-cli.rst
/usr/share/doc/lorax/composer/html/composer-cli.html
/usr/share/doc/lorax/composer/html/lorax-composer.html
/usr/share/doc/lorax/composer/lorax-composer.rst
Additional info:
Though I would ordinarily file this as an RFE, the lack of documentation that we specifically include and maintain in the source is more in the bug territory. Especially when we already have the precedent of including documentation in this way for the rest of the lorax component.
The documentation isn't just for lorax-composer, and we really cannot split it out so it should probably just be lorax-docs and include everything under docs
(In reply to Brian Lane from comment #1)
> The documentation isn't just for lorax-composer, and we really cannot split
> it out so it should probably just be lorax-docs and include everything under
> docs
That makes a lot of sense. Just having a lorax-docs subpackage would definitely cover the need. Thanks for the feedback!
Comment 5Alexander Todorov
2019-08-20 09:35:50 UTC
I don't see a lorax-docs package but the lorax rpm contains the following files (among others):
/usr/share/doc/lorax/composer-cli.rst
/usr/share/doc/lorax/lorax-composer.rst
so moving to Verified.
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://access.redhat.com/errata/RHBA-2019:3328
Description of problem: Currently, we have lorax-composer documentation available in the source, but is not included in the final built RPM manifest. Specifically, the following files are not included in an RPM: docs/composer-cli.rst docs/html/composer-cli.html docs/html/lorax-composer.html docs/lorax-composer.rst It would be beneficial to include these docs in a lorax-composer-docs subpackage. This way, end users will know what documentation is applicable to their particular composer revision. Version-Release number of selected component (if applicable): lorax-28.14.23-2.el8 How reproducible: Easily Steps to Reproduce: 1. Install all lorax packages # yum install lorax lorax-* 2. Verify if the above documents are located in the traditional /usr/share/doc/ directory # find /usr/share/doc -name *composer* Actual results: Nothing returned Expected results: /usr/share/doc/lorax/composer/composer-cli.rst /usr/share/doc/lorax/composer/html/composer-cli.html /usr/share/doc/lorax/composer/html/lorax-composer.html /usr/share/doc/lorax/composer/lorax-composer.rst Additional info: Though I would ordinarily file this as an RFE, the lack of documentation that we specifically include and maintain in the source is more in the bug territory. Especially when we already have the precedent of including documentation in this way for the rest of the lorax component.