Bug 1192120
| Summary: | typos and poor grammar in subscription-manager man page | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | John Sefler <jsefler> |
| Component: | subscription-manager | Assignee: | Chris "Ceiu" Rog <crog> |
| Status: | CLOSED ERRATA | QA Contact: | John Sefler <jsefler> |
| Severity: | low | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.7 | CC: | bcourt, crog, dgoodwin, jaudet, tlavigne |
| Target Milestone: | rc | Keywords: | Triaged |
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-05-10 20:36:19 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: | |||
| Bug Depends On: | |||
| Bug Blocks: | 1209535 | ||
|
Description
John Sefler
2015-02-12 16:14:10 UTC
[root@jsefler-os7 ~]# man subscription-manager | egrep "[Ww]ild"
SEARCH may contain the wildcards ? or * to match a single char‐
acter or zero or more characters, respectively. The wildcard
"wildcard" is not a word according to dictionary.com and oxforddictionaries.com. "wild card" is better.
[root@jsefler-os7 ~]# man subscription-manager | grep -B4 -A5 suborg
--org=ORG
Assigns the system to an organization. Infrastructures which are
managed on-site may be multi-tenant, meaning that there are mul‐
tiple organizations within one customer unit. A system may be
assigned manually to one of these suborganizations. When a sys‐
tem is registered with the Customer Portal, this is not
required. When a system is registered with an on-premise appli‐
cation such as Subscription Asset Manager, this argument is
required, even if there is only a single organization config‐
ured.
"suborganizations" is not a word. I would change this to "organizations" without the "sub" prefix.
(In reply to John Sefler from comment #3) The last man page sentence in comment 3 is wrong. It states that the ORG option is required against Subscription Asset Manager even when only a single org is configured. This is not true. Please remove this sentence from the man page. If there is only one org, then the option is not required during registration and the user will not be prompted for an org. [root@jsefler-os7 ~]# man subscription-manager | grep CONSUMERTYPE -A6
--type=CONSUMERTYPE
Sets the type of unit to register. Most units in the inventory
will use the default value of system. For development or test
systems, this can be person , which indicates a personal (rather
than organizational) subscription. Other systems can be can‐
dlepin for a local content service or domain for an IP domain.
change "For development or test systems" to "For development or test units"
change "subscription" to "unit"
change "Other systems can be candlepin" to "Another type of unit can be candlepin"
> Subscription Manager can be used to autoattach subscriptions to a system, as well. The subscription-manager command can even be invoked as part of a kickstart process. s/autoattach/auto-attach/ s/kickstart/kick-start/ > --show Shows whetehr auto-attach is enabled on the systems. s/whetehr/whether/ > Shows pools which provide products that are notalready covered; only used with --available option. s/notalready/not already/ > Adds a named overide with the provided value to repos specified with the --repo option s/overide/override/ > Removes a named overide from the repos specified with the --repo option s/overide/override/ > --remove-alll s/alll/all/ > The subscription-manager tool can be run as a post-install script as part of the kickstart installation process. This allows subscription management (registing and applying subscriptions) s/registing/registering/ Comment 6, is based on subscription-manager version 1.10.14-13, which is older than what jsefler mentions in their initial comment. My mistake. $ rpm -qa | grep subscription-manager subscription-manager-1.10.14-13.el7_0.x86_64 [root@jsefler-os7 ~]# man subscription-manager | grep "expirations" -B4 -A1
--disable
Disables the auto-attach option for the system. If auto-attach is
disabled, then any changes in installed products or subscriptions
for the system (including expirations) must be addressed manually
by the administrator.
"expirations" is not a word - change to "expired subscriptions"
[root@jsefler-os7 ~]# man subscription-manager | grep "reregister"
is corrupted or lost somehow, and the system will be reregistered using
figured, can be removed from a content service, or reregistered.
-- the system can be reregistered, with all of its subscriptions
"reregister" is not a word. I think it would be better written as "re-register".
[root@jsefler-os7 ~]# man subscription-manager | grep "instaled"
subscription-manager list --instaled --matches="*Server*"
typo "--instaled" should be "--installed"
[root@jsefler-os7 ~]# man subscription-manager | head -1
subscription-manager(8) System Manager's Manual subscription-manager(8)
^^^^^^^^^^^^^^^^^^^^^^^
change to Subscription Management
Deferring to RHEL6.7 for resolution [root@jsefler-os6 ~]# man subscription-manager | grep "plugin"
15. plugins
The plugins command lists the available subscription-manager plugins.
--list List the available subscription-manager plugins.
List the available plugin slots
List the available plugin slots and the hooks that handle them.
Show additional info about the plugins, such as the plugin con-
Except for the first two references to the plugins command, "plugins" and "plugin" should be hyphenated in the descriptions according to http://www.oxforddictionaries.com/
[root@jsefler-os6 ~]# man -P cat subscription-manager | grep "livent" -B1
best-fitting subscriptions. This is the default action and is equi-
livent to using the --auto option:
typo "equilivent" should be "--equivalent"
commit 063747b1b1d83fe89eff91fc5fb96f57d95eb5d5
Author: Chris Rog <crog>
Date: Thu Apr 9 10:25:53 2015 -0400
1192120: Fixed typos and grammar issues in subman man page
commit bcec4ce8a2c52655334e621299a3f65ad60a76e4
1189937: Added hypens to instances of the non-word "wildcard"
Was reverted by...
commit 1d93d241aafd26245c052f8da5df9dddba87818c
Revert "1189937: Added hypens to instances of the non-word "wildcard""
As noted in comment 16, some of the requested changes were counter to our style guide and reverted accordingly. Testing the unknown word "reregistered" in version...
[root@jsefler-7 ~]# rpm -q subscription-manager
subscription-manager-1.15.9-7.el7.x86_64
[root@jsefler-7 ~]# man subscription-manager | grep "re-registered"
and the system will be re-registered using the register --con‐
^^^^^^^^^^^^^
VERIFIED: fix from commit 063747b1b1d83fe89eff91fc5fb96f57d95eb5d5
[root@jsefler-7 ~]# man subscription-manager | grep "reregistered"
service, or reregistered.
deleted or corrupted -- the system can be reregistered, with all
FAILED: There are still two occurrences of "reregistered" in subscription-manager-1.15.9-7
commit 88fecdd00784f68ee148a8067ce1b23403d695dd
Author: Chris Rog <crog>
Date: Fri Oct 9 13:38:35 2015 -0400
1192120: Fixed remaining instances of "reregister" in the man pages
Verifying Version... [root@jsefler-6 ~]# rpm -q subscription-manager subscription-manager-1.16.8-8.el6.x86_64 -------------------------------------------------- Verifying comment 18 and comment 9: [root@jsefler-6 ~]# man subscription-manager | grep "re-registered" configured, can be removed from a content service, or re-registered. -- the system can be re-registered, with all of its subscriptions [root@jsefler-6 ~]# man subscription-manager | grep "reregistered" [root@jsefler-6 ~]# VERIFIED: No more occurrences of "reregistered" in subscription-manager man page -------------------------------------------------- Verifying comment 16 and comment 1: [root@jsefler-6 ~]# man subscription-manager | grep "wildcard" SEARCH may contain the wildcards ? or * to match a single character or zero or more characters, respectively. The wildcard [root@jsefler-6 ~]# man subscription-manager | grep "wild-card" [root@jsefler-6 ~]# VERIFIED: The term "wildcard" was judged to be an acceptable word. -------------------------------------------------- Verifying comment 14: [root@jsefler-6 ~]# man -P cat subscription-manager | grep "livent" [root@jsefler-6 ~]# man -P cat subscription-manager | grep "equiv" -B1 -A1 As with the register command, the system can be auto-attached to the best-fitting subscriptions. This is the default action and is equiva- lent to using the --auto option: VERIFIED: The word "equivalent" is now spelled correctly. -------------------------------------------------- Verifying comment 13: [root@jsefler-6 ~]# man subscription-manager | grep "plugin" 15. plugins The plugins command lists the available subscription-manager plugins. --list List the available subscription-manager plugins. List the available plugin slots List the available plugin slots and the hooks that handle them. Show additional info about the plugins, such as the plugin con- [root@jsefler-6 ~]# man subscription-manager | grep "plug-in" [root@jsefler-6 ~]# VERIFIED: The suggested change to "plug-in" was rejected as NOTABUG. -------------------------------------------------- Verifying comment 11: [root@jsefler-6 ~]# man subscription-manager | head -1 subscription-manager(8) Subscription Management subscription-manager(8) VERIFIED: The heading was changed to "Subscription Management" -------------------------------------------------- Verifying comment 10: [root@jsefler-6 ~]# man subscription-manager | grep "instaled" [root@jsefler-6 ~]# man subscription-manager | grep "installed" preconfigured systems which may already have products installed. subscriptions checks the currently-installed products, attached sub- expire, or any new products are installed, then subscription- is disabled, then any changes in installed products or subscrip- preference for products installed on the system. For example, if the Lists products which are currently installed on the system which not) be installed. installed; only used with --available option. Limits the output of --installed, --available and --consumed to 2. Handling the product subscriptions for installed products on installed products by tracking and managing what subscriptions are have installed, as a way of tracking what products you have versus what subscription-manager list --installed subscription-manager list --installed --matches="*Server*" installed with it. To remove a subscription for a specific product, [root@jsefler-6 ~]# VERIFIED: Typo "instaled" was corrected. -------------------------------------------------- Verifying comment 8: [root@jsefler-6 ~]# man subscription-manager | grep "expirations" -B4 -A1 [root@jsefler-6 ~]# man subscription-manager | grep "expired subscriptions" -B4 -A1 --disable Disables the auto-attach option for the system. If auto-attach is disabled, then any changes in installed products or subscrip- tions for the system (including expired subscriptions) must be addressed manually by the administrator. [root@jsefler-6 ~]# VERIFIED: Typo "expirations" has been corrected. -------------------------------------------------- Verifying comment 5: [root@jsefler-6 ~]# man subscription-manager | grep "Sets the type" -A5 -B1 --type=CONSUMERTYPE Sets the type of unit to register. Most units in the inventory will use the default value of system. For development or test units, this can be person , which indicates a personal (rather than organizational) unit. Another type of unit can be candlepin for a local content service or domain for an IP domain. VERIFIED: changed "For development or test systems" to "For development or test units" changed "subscription" to "unit" changed "Other systems can be candlepin" to "Another type of unit can be candlepin" -------------------------------------------------- Verifying comment 3 and comment 4: [root@jsefler-6 ~]# man subscription-manager | grep -B1 -A8 "Assigns the system" --org=ORG Assigns the system to an organization. Infrastructures which are managed on-site may be multi-tenant, meaning that there are mul- tiple organizations within one customer unit. A system may be assigned manually to one of these organizations. When a system is registered with the Customer Portal, this is not required. When a system is registered with an on-premise application such as Subscription Asset Manager, this argument is required, unless there is only a single organization configured. VERIFIED: The term "suborganizations" has been changed to "organizations". 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://rhn.redhat.com/errata/RHBA-2016-0797.html |