Bug 1915353
| Summary: | composer-cli needs to have some decent examples | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 8 | Reporter: | Renaud Métrich <rmetrich> |
| Component: | weldr-client | Assignee: | Brian Lane <bcl> |
| Status: | CLOSED MIGRATED | QA Contact: | Release Test Team <release-test-team-automation> |
| Severity: | medium | Docs Contact: | Eliane Ramos Pereira <elpereir> |
| Priority: | medium | ||
| Version: | 8.6 | CC: | bcl, elpereir, joerg.kastning |
| Target Milestone: | rc | Keywords: | MigratedToJIRA, Triaged |
| Target Release: | 8.0 | Flags: | pm-rhel:
mirror+
|
| Hardware: | All | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2023-09-18 12:03:24 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Renaud Métrich
2021-01-12 14:00:30 UTC
Hi @bcl, are you going to include the manpage composer-cli(1) as it could be found at https://www.mankier.com/1/composer-cli in the RPM package? That would IMHO be great because chapter 3.5 of [Composing a customized RHEL system image](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/composing_a_customized_rhel_system_image/index) is referencing it as well. Kind regards, Joerg (In reply to Joerg K from comment #1) > Hi @bcl, are you going to include the manpage composer-cli(1) as > it could be found at https://www.mankier.com/1/composer-cli in the RPM > package? That would IMHO be great because chapter 3.5 of [Composing a > customized RHEL system > image](https://access.redhat.com/documentation/en-us/ > red_hat_enterprise_linux/8/html-single/ > composing_a_customized_rhel_system_image/index) is referencing it as well. The manpage is already included in /usr/share/man/man1/ (In reply to Brian Lane from comment #2) > The manpage is already included in /usr/share/man/man1/ Sorry, if I may be mistaken, but there is no manpage in /usr/share/man/man1/ on my RHEL 8 box. I have installed: composer-cli.x86_64 28.14.55-2.el8 osbuild-composer.x86_64 20.1-1.el8 I also checked the older package versions and lorax-composer but none of these packages seems to include the manpage. ~~~ $ man -k composer-cli composer-cli: nothing appropriate. ~~~ Here is how I checked the RPM contents: ~~~ $ for VERSION in 42-1.el8 30-1.el8 23-7.el8_0 23-5.el8_0 23-1.el8; do sudo repoquery -l composer-cli-28.14.${VERSION} | grep /usr/share/man; done Last metadata expiration check: 0:02:48 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:02:51 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:02:54 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:02:58 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:03:01 ago on Mon Feb 15 20:28:43 2021. $ for VERSION in 42-1.el8 30-1.el8 23-7.el8_0 23-5.el8_0 23-1.el8; do sudo repoquery -l lorax-composer-28.14.${VERSION} | grep /usr/share/man; done Last metadata expiration check: 0:04:11 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:04:14 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:04:18 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:04:21 ago on Mon Feb 15 20:28:43 2021. Last metadata expiration check: 0:04:24 ago on Mon Feb 15 20:28:43 2021. $ ~~~ Is there a package missing? Sorry, I know that a bug tracker is no place for support and I may be mistaken but I believe that the manpage is missing in the current RPMs for RHEL 8. So in case I'm a layer 8 problem I would appreciate you pointing me in the right direction. And in case the manpage is really missing in the RPMs I would appreciate when you add them in an upcoming version. Kind regards, Joerg Ah! I see what happened. All the manpages are part of the lorax package. That didn't used to be a problem since lorax and lorax-composer were installed at the same time. I'll file a bug for the next release and see if we can move it to the composer-cli package. (In reply to Brian Lane from comment #4) [...] > I'll file a bug for the next release and see if > we can move it to the composer-cli package. Thank you Brain for putting this on the list. That's good news. Please let me know the bugzilla, in case it's public, so I could subscribe and keep myself up to date. Thanks, Joerg (In reply to Joerg K from comment #5) > (In reply to Brian Lane from comment #4) > [...] > > I'll file a bug for the next release and see if > > we can move it to the composer-cli package. > > Thank you Brain for putting this on the list. > That's good news. Please let me know the bugzilla, in case it's public, so I > could subscribe and keep myself up to date. > > Thanks, > Joerg https://bugzilla.redhat.com/show_bug.cgi?id=1928962 weldr-client has manpages for all the commands, but they haven't really been expanded to include examples. Currently the best documentation is upstream at: https://www.osbuild.org/guides/user-guide/building-an-image-from-cli.html Upstream documentation improvements - https://github.com/osbuild/weldr-client/pull/80 Issue migration from Bugzilla to Jira is in process at this time. This will be the last message in Jira copied from the Bugzilla bug. This BZ has been automatically migrated to the issues.redhat.com Red Hat Issue Tracker. All future work related to this report will be managed there. Due to differences in account names between systems, some fields were not replicated. Be sure to add yourself to Jira issue's "Watchers" field to continue receiving updates and add others to the "Need Info From" field to continue requesting information. To find the migrated issue, look in the "Links" section for a direct link to the new issue location. The issue key will have an icon of 2 footprints next to it, and begin with "RHEL-" followed by an integer. You can also find this issue by visiting https://issues.redhat.com/issues/?jql= and searching the "Bugzilla Bug" field for this BZ's number, e.g. a search like: "Bugzilla Bug" = 1234567 In the event you have trouble locating or viewing this issue, you can file an issue by sending mail to rh-issues. You can also visit https://access.redhat.com/articles/7032570 for general account information. |