Bug 1014993

Summary: update yum check description in yum manpage
Product: Red Hat Enterprise Linux 6 Reporter: Karel Srot <ksrot>
Component: yumAssignee: Packaging Maintenance Team <packaging-team-maint>
Status: CLOSED ERRATA QA Contact: Karel Srot <ksrot>
Severity: low Docs Contact:
Priority: medium    
Version: 6.4CC: james.antill, jzeleny, packaging-team-maint, vmukhame
Target Milestone: rcKeywords: ManPageChange
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: yum-3.2.29-60.el6 Doc Type: Bug Fix
Doc Text:
NO DOCS NEEDED
Story Points: ---
Clone Of:
: 1015000 (view as bug list) Environment:
Last Closed: 2014-10-14 04:36:50 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 Karel Srot 2013-10-03 09:34:56 UTC
Description of problem:

man page states:

       check  Checks the local rpmdb and produces information on any problems it finds. You can pass the check command the  arguments  "dependencies"  or
              "duplicates", to limit the checking that is performed (the default is "all" which does both).

Actually, there is at least also yum check provides and yum check obsoletes. 
These are not describe which is confusing for the user who is trying to identify why "yum check" last very long while "yum check duplicates" and "yum check dependencies" are quick.

Version-Release number of selected component (if applicable):
yum-3.2.29-40.el6.noarch

Comment 1 Karel Srot 2013-10-03 09:35:55 UTC
Probably it would be worth of mentioning that yum check provides (and thus yum check all) is a bit time consuming.

Comment 2 Zdeněk Pavlas 2013-10-03 12:44:04 UTC
Well, the code is not consistent in what to check by default.

"yum check" command:
 "all" is used by default.

_rpmdb_warn_checks(chkcmd=None) function:
 ['dependencies', 'duplicates'] is used by default.

Probably the easiest way to resolve this is to resolve default only once,
in _rpmdb_warn_checks().  I've made a patch.

Comment 3 Karel Srot 2013-10-04 06:20:05 UTC
Is it a patch for the yum code or the patch for the man page? In the first case, please also update the man page with currently undocumented commands "obsoletes, provides" - maybe stating that "provides" runs quite a long time.

IMHO the default should not be 'all' just because of the long duration of 'provides' check.

Comment 4 Jan Zeleny 2013-10-04 06:59:38 UTC
(In reply to Zdeněk Pavlas from comment #2)
> Well, the code is not consistent in what to check by default.
> 
> "yum check" command:
>  "all" is used by default.
> 
> _rpmdb_warn_checks(chkcmd=None) function:
>  ['dependencies', 'duplicates'] is used by default.
> 
> Probably the easiest way to resolve this is to resolve default only once,
> in _rpmdb_warn_checks().  I've made a patch.

Zdenku, if the patch is ACKed upstream, please don't forget to include the commit info here for future reference. Thanks

Comment 5 Zdeněk Pavlas 2013-10-04 07:20:59 UTC
(In reply to Karel Srot from comment #3)
> Is it a patch for the yum code or the patch for the man page? In the first
> case, please also update the man page with currently undocumented commands
> "obsoletes, provides" - maybe stating that "provides" runs quite a long time.
> 
> IMHO the default should not be 'all' just because of the long duration of
> 'provides' check.

James thinks it's better to run all 4 checks by default, so I've just updated docs.

http://yum.baseurl.org/gitweb?p=yum.git;a=commitdiff;h=d45aee8f

Comment 6 Zdeněk Pavlas 2013-10-04 07:35:29 UTC
(In reply to Jan Zeleny from comment #4)
> (In reply to Zdeněk Pavlas from comment #2)
> > Well, the code is not consistent in what to check by default.
> > 
> > "yum check" command:
> >  "all" is used by default.
> > 
> > _rpmdb_warn_checks(chkcmd=None) function:
> >  ['dependencies', 'duplicates'] is used by default.
> > 
> > Probably the easiest way to resolve this is to resolve default only once,
> > in _rpmdb_warn_checks().  I've made a patch.
> 
> Zdenku, if the patch is ACKed upstream, please don't forget to include the
> commit info here for future reference. Thanks

What, FUS spam generated at release time is not enough?

Comment 7 Zdeněk Pavlas 2013-10-04 07:57:24 UTC
Sorry, haven't noticed it's a RHEL bug.. It makes sense then.

Comment 10 Karel Srot 2014-07-02 07:52:53 UTC
Switching back to ASSIGNED.

See the snippet below. The "check" description is correct but the 2nd paragraph starting with "The  info  command..." seems to belong rather to the "info" subcommand section.

It is not a regression and I could file a separate bug for this issue but maybe it would be easier to fix it at once since this bug is about the "yum check" description.

yum-3.2.29-59.el6:

from man yum:

       check  Checks the local rpmdb and produces information on any problems  it  finds.  You  can
              pass  the  check  command  the arguments "dependencies", "duplicates", "obsoletes" or
              "provides", to limit the checking that is performed (the default is "all" which  does
              all).

              The  info  command  can  also take ranges of transaction ids, of the form start..end,
              which will then display a merged history as if all the transactions in the range  had
              happened at once.
              Eg.  "history info 1..4" will merge the first four transactions and display them as a
              single transaction.

Comment 14 errata-xmlrpc 2014-10-14 04:36:50 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, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHBA-2014-1410.html