This bug has been migrated to another issue tracking site. It has been closed here and may no longer be being monitored.

If you would like to get updates for this issue, or to participate in it, you may do so at Red Hat Issue Tracker .
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 1915353 - composer-cli needs to have some decent examples
Summary: composer-cli needs to have some decent examples
Keywords:
Status: CLOSED MIGRATED
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: weldr-client
Version: 8.6
Hardware: All
OS: Linux
medium
medium
Target Milestone: rc
: 8.0
Assignee: Brian Lane
QA Contact: Release Test Team
Eliane Ramos Pereira
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-01-12 14:00 UTC by Renaud Métrich
Modified: 2024-03-25 17:48 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-09-18 12:03:24 UTC
Type: Bug
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker   RHEL-4553 0 None Migrated None 2023-09-18 12:03:20 UTC

Description Renaud Métrich 2021-01-12 14:00:30 UTC
Description of problem:

I don't see any manpage shipped for composer-cli command.
Additionally I don't see any example for basic composer-cli commands such as "composer-cli sources add", which requires a specific undisclosed format to specify your own repository.

Same is expected from "composer-cli blueprints show <Blueprint>" and other commands as well.
This needs to be properly documented.

Additionally, executing "composer-cli sources add" without any file name doesn't report an error.

Very likely more commands behave similarly but I have no time giving an exhaustive list.

Version-Release number of selected component (if applicable):

composer-cli-28.14.55-2.el8.x86_64


How reproducible:

ALWAYS

Comment 1 Joerg K 2021-02-14 11:54:25 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

Comment 2 Brian Lane 2021-02-15 17:00:09 UTC
(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/

Comment 3 Joerg K 2021-02-15 19:46:06 UTC
(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

Comment 4 Brian Lane 2021-02-15 21:34:33 UTC
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.

Comment 5 Joerg K 2021-02-16 12:43:28 UTC
(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

Comment 6 Brian Lane 2021-02-16 17:11:56 UTC
(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

Comment 7 Brian Lane 2022-02-28 21:15:35 UTC
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

Comment 9 Brian Lane 2022-09-23 22:52:23 UTC
Upstream documentation improvements - https://github.com/osbuild/weldr-client/pull/80

Comment 10 RHEL Program Management 2023-09-18 12:01:37 UTC
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.

Comment 11 RHEL Program Management 2023-09-18 12:03:24 UTC
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.


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