Bug 1500666

Summary: Typo in man page (to to)
Product: Red Hat Enterprise Linux 7 Reporter: Stephen Wadeley <swadeley>
Component: yumAssignee: Valentina Mukhamedzhanova <vmukhame>
Status: CLOSED DUPLICATE QA Contact: BaseOS QE Security Team <qe-baseos-security>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.3CC: james.antill, mdomonko, swadeley
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-10-31 17:22:15 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 Stephen Wadeley 2017-10-11 09:59:11 UTC
Description of problem:

 -C, --cacheonly
              Tells yum to run entirely from system cache - does not download or update any headers unless it has to to perform the requested action.

{I see typo there, "to to", I will raise a bug against yum).

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

 ~]# rpm -q yum
yum-3.4.3-154.el7.noarch




Thank you

Comment 2 Michal Domonkos 2017-10-11 11:06:58 UTC
This is actually not a typo :)  The meaning is:

"Tells yum to run entirely from system cache - does not download or update any headers unless it has to [download or update any headers] to perform the requested action."

I can remember myself also pausing for a second when reading this before it finally "clicked", though :)

Would adding a comma after the first "to" make it more readable and/or correct?

Comment 3 Stephen Wadeley 2017-10-11 11:31:55 UTC
Ok, I see now.

Lets try:

1]
Tells yum to run entirely from system cache, does not download or update any headers unless it has to, to perform the requested action.

{I hate the use of dashes and slashes in running text, so that was my first thought}.

2]
Tells yum to run entirely from system cache - does not download or update any headers to perform the requested action unless it has to.

{short is good}

3]
Tells yum to run entirely from system cache; does not download or update any headers to perform the requested action unless it has to.

{but then, ideally, you should change all use of - as sentence break.}

Thank you

Comment 4 Michal Domonkos 2017-10-11 11:44:41 UTC
(In reply to Stephen Wadeley from comment #3)
> 1]
> Tells yum to run entirely from system cache, does not download or update any
> headers unless it has to, to perform the requested action.

This slightly changes the meaning.  Running from system cache means not downloading any headers (the comma would imply the latter is done in addition to the former).

> {I hate the use of dashes and slashes in running text, so that was my first
> thought}.

I do agree; that eliminates 2] as well.
 
> 3]
> Tells yum to run entirely from system cache; does not download or update any
> headers to perform the requested action unless it has to.

I like this the most :)

I'll make this into a quick patch when time allows...  Thanks!