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 1950015 - Typos in man page for syspurpose
Summary: Typos in man page for syspurpose
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: subscription-manager
Version: 8.5
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: beta
: 8.5
Assignee: Pino Toscano
QA Contact: Red Hat subscription-manager QE Team
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-04-15 15:06 UTC by Archana Pandey
Modified: 2021-11-10 07:55 UTC (History)
1 user (show)

Fixed In Version: subscription-manager-1.28.16-1.el8
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-09 19:37:58 UTC
Type: Bug
Target Upstream Version:
Embargoed:
pm-rhel: mirror+

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github candlepin subscription-manager pull 2604 0 None closed 1950015: fix typos in syspurpose(8) 2021-04-26 15:19:46 UTC
Red Hat Product Errata RHBA-2021:4390 0 None None None 2021-11-09 19:38:19 UTC

Description Archana Pandey 2021-04-15 15:06:51 UTC 
Description of problem:
Man page for syspurpose has few typos that should be fixed.


Version-Release number of selected component (if applicable):
[root@kvm-08-guest13 /]# subscription-manager version
server type: This system is currently not registered.
subscription management server: 3.2.15-1
subscription management rules: 5.41
subscription-manager: 1.28.15-1.el8



How reproducible:


Steps to Reproduce:

search for "TYPO" in output of man command below

[root@kvm-08-guest13 /]# man -P cat syspurpose

SYSPURPOSE(8)                                                                              Subscription Management                                                                              SYSPURPOSE(8)

NAME
       syspurpose - Set the intended purpose for this system

SYNOPSIS
       syspurpose [COMMAND] [OPTION]...

DESCRIPTION
       Syspurpose is a utility for viewing and modifying system purpose properties.

       The  properties (hints) set by syspurpose are passed to a Red Hat subscription management entitlement server (Customer Portal or Satellite 6) to help attach the most appropriate subscriptions to the
       system automatically. The entitlement server also reports whether the attached subscriptions match the specified system purpose. Satisfying system purpose properties depends greatly on the quantity,
       availability, and subscription SKU offerings that have been purchased for the organization that the system is registered to.

       The  set, unset, add, and remove commands modify the local system purpose, and when possible will report the updated settings to the Red Hat subscription management entitlement server (Customer Por‐
       tal or Satellite 6).  The show command displays the current system purpose.

COMMANDS
       syspurpose set-role VALUE
              Set the role property

       syspurpose unset-role VALUE
              Clear the role property

       syspurpose set-sla VALUE
              Set the service level agreement property

       syspurpose unset-sla VALUE
              Clear the service level agreement property

       syspurpose set-usage VALUE
              Set the system usage property

       syspurpose unset-usage VALUE
              Clear the system usage property

       syspurpose add-addons VALUE...
              Add values to the addons property

       syspurpose remove-addons VALUE...
              Remove values from the addons property

       syspurpose unset-addons VALUE...
              Clear set addons property

       syspurpose show VALUE
              Show the current system purpose properties

   Generic Commands
       The following generic commands can be used as well

       syspurpose set PROPERTY VALUE
              Set the value for a specific property. E.g. "syspurpose set usage foo" is functionally identical to "syspurpose set-usage foo".

       syspurpose unset PROPERTY
              Clears the value for a specific property. E.g. "syspurpose unset usage" is functionally identical to "syspurpose unset-usage".

       syspurpose add PROPERTY VALUE
              Add value(s) to a specific list property. E.g. "syspurpose add addons foo bar" is identical to "syspurpose add-addons foo bar".

       syspurpose remove PROPERTY VALUE
              Clear a value from a specific list property. E.g. syspurpose remove addons foo bar is identical to syspurpose remove-addons foo bar.
                                   ^^^^^ TYPO-should be fixed to "syspurpose remove addons foo bar" is identical to "syspurpose remove-addons foo bar"

       syspurpose unset PROPERTY VALUE
              Clear set addons. E.g. syspurpose unset addons foo bar is identical to syspurpose unset-addons foo bar.

                             ^^^^^ TYPO-should be enclosed within "" like above

              Only "addons" acts as a list property.  The other properties only accept a single value.

OPTIONS
       --help Display a summary of the available commands

EXAMPLES
       syspurpose set-role "RHEL Server"  <<< TYPO-can be replaced with a true value e.g. "Red Hat Enterprise Linux Server"
              Indicate that this system should consume a RHEL Server subscription:  <<<< TYPO- no need for ":"

       syspurpose unset-role
              Clear a previously set role

BUGS
       This tool is part of Red Hat Subscription Manager. To file bugs against this command-line tool, go to <https://bugzilla.redhat.com>, and select Red Hat > Red Hat Enterprise Linux > subscription-man‐
       ager.

AUTHOR
       Chris Snyder <csnyder>

COPYRIGHT
       Copyright © 2018 Red Hat, Inc.
Comment 1 Archana Pandey 2021-04-29 07:59:02 UTC 
pre-verifying on development compose with subscription-manager package version subscription-manager-1.28.16-1.el8.x86_64

Beaker Test information:
                         HOSTNAME=kvm-05-guest24.hv2.lab.eng.bos.redhat.com
                            JOBID=5322348
                         RECIPEID=9915728
                    RESULT_SERVER=
                           DISTRO=RHEL-8.5.0-20210428.d.3
                     ARCHITECTURE=x86_64



[root@kvm-05-guest24 ~]# subscription-manager version
server type: This system is currently not registered.
subscription management server: 3.2.16-1
subscription management rules: 5.41
subscription-manager: 1.28.16-1.el8
[root@kvm-05-guest24 ~]#

[root@kvm-05-guest24 ~]# rpm -qa --changelog subscription-manager | grep 1950015
- 1950015: fix typos in syspurpose(8) (#2604) (ptoscano)
[root@kvm-05-guest24 ~]# 

[root@kvm-05-guest24 ~]# man -P cat syspurpose
SYSPURPOSE(8)                                                                              Subscription Management                                                                              SYSPURPOSE(8)

NAME
       syspurpose - Set the intended purpose for this system

SYNOPSIS
       syspurpose [COMMAND] [OPTION]...

DESCRIPTION
       Syspurpose is a utility for viewing and modifying system purpose properties.

       The  properties (hints) set by syspurpose are passed to a Red Hat subscription management entitlement server (Customer Portal or Satellite 6) to help attach the most appropriate subscriptions to the
       system automatically. The entitlement server also reports whether the attached subscriptions match the specified system purpose. Satisfying system purpose properties depends greatly on the quantity,
       availability, and subscription SKU offerings that have been purchased for the organization that the system is registered to.

       The  set, unset, add, and remove commands modify the local system purpose, and when possible will report the updated settings to the Red Hat subscription management entitlement server (Customer Por‐
       tal or Satellite 6).  The show command displays the current system purpose.

       The 'syspurpose' command is deprecated and will be removed in a future major release.  Please use the 'subscription-manager syspurpose' command going forward.

COMMANDS
       syspurpose set-role VALUE
              Set the role property

       syspurpose unset-role VALUE
              Clear the role property

       syspurpose set-sla VALUE
              Set the service level agreement property

       syspurpose unset-sla VALUE
              Clear the service level agreement property

       syspurpose set-usage VALUE
              Set the system usage property

       syspurpose unset-usage VALUE
              Clear the system usage property

       syspurpose add-addons VALUE...
              Add values to the addons property

       syspurpose remove-addons VALUE...
              Remove values from the addons property

       syspurpose unset-addons VALUE...
              Clear set addons property

       syspurpose show VALUE
              Show the current system purpose properties

   Generic Commands
       The following generic commands can be used as well

       syspurpose set PROPERTY VALUE
              Set the value for a specific property. E.g. "syspurpose set usage foo" is functionally identical to "syspurpose set-usage foo".

       syspurpose unset PROPERTY
              Clears the value for a specific property. E.g. "syspurpose unset usage" is functionally identical to "syspurpose unset-usage".

       syspurpose add PROPERTY VALUE
              Add value(s) to a specific list property. E.g. "syspurpose add addons foo bar" is identical to "syspurpose add-addons foo bar".

       syspurpose remove PROPERTY VALUE
              Clear value(s) from a specific list property. E.g. "syspurpose remove addons foo bar" is identical to "syspurpose remove-addons foo bar".                                ^^^^^ TYPO fixed

       syspurpose unset PROPERTY VALUE
              Clear set addons. E.g. "syspurpose unset addons" is identical to "syspurpose unset-addons". << TYPO fixed


              Only "addons" acts as a list property.  The other properties only accept a single value.

OPTIONS
       --help Display a summary of the available commands

EXAMPLES
       syspurpose set-role "Red Hat Enterprise Linux Server"
              Indicate that this system should consume a RHEL Server subscription.

       syspurpose unset-role
              Clear a previously set role.

BUGS
       This tool is part of Red Hat Subscription Manager. To file bugs against this command-line tool, go to <https://bugzilla.redhat.com>, and select Red Hat > Red Hat Enterprise Linux > subscription-man‐
       ager.

AUTHOR
       Chris Snyder <csnyder>

COPYRIGHT
       Copyright © 2018 Red Hat, Inc.

                                                                                                                                                                                                SYSPURPOSE(8)
[root@kvm-05-guest24 ~]# 

Verified : typos have been fixed under options
                                -syspurpose remove PROPERTY VALUE 
                                -syspurpose unset PROPERTY VALUE
Comment 2 Archana Pandey 2021-04-29 08:12:11 UTC 
Extending Comment 1

fixed strings-
EXAMPLES
       syspurpose set-role "Red Hat Enterprise Linux Server"  <<< changed from "RHEL Server" as expected
              Indicate that this system should consume a RHEL Server subscription. << ":" removed as expected
Comment 5 Rehana 2021-05-17 12:09:15 UTC 
Verifying on : 
subscription-manager: 1.28.16-1.el8


# rpm -q --changelog subscription-manager | grep 1950015
- 1950015: fix typos in syspurpose(8) (#2604) (ptoscano)


syspurpose unset PROPERTY VALUE <<-- Notice the value should be removed from the syntax as well 
              Clear set addons. E.g. "syspurpose unset addons" is identical to "syspurpose unset-addons".

All the other changes are fine 

 syspurpose remove PROPERTY VALUE
              Clear value(s) from a specific list property. E.g. "syspurpose remove addons foo bar" is identical to "syspurpose remove-addons foo bar".

Examples are fixed too
EXAMPLES
       syspurpose set-role "Red Hat Enterprise Linux Server"
              Indicate that this system should consume a RHEL Server subscription.

Sending the bug back to Dev for updating the syntax for completeness.
Comment 6 Rehana 2021-05-17 12:19:13 UTC 
For the additional fix requested on updating the "syntax" a new bug as been opened Bug 1961171  .
Comment 7 Rehana 2021-05-17 12:20:31 UTC 
The requested changes on this bug description as already been addressed as shown in comment 5. 

Based on that moving the bug to verified!!
Comment 9 errata-xmlrpc 2021-11-09 19:37:58 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 (subscription-manager 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-2021:4390
Note You need to log in before you can comment on or make changes to this bug.