Bug 1449172 - Inconsistency in help and man-page of spacewalk-repo-sync
Summary: Inconsistency in help and man-page of spacewalk-repo-sync
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite 5
Classification: Red Hat
Component: Server
Version: 580
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Gennadii Altukhov
QA Contact: Lukáš Hellebrandt
URL:
Whiteboard:
Depends On:
Blocks: sat58-errata
TreeView+ depends on / blocked
 
Reported: 2017-05-09 11:27 UTC by Martin Korbel
Modified: 2017-10-19 11:57 UTC (History)
4 users (show)

Fixed In Version: spacewalk-backend-2.5.3-152-sat
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-10-19 11:57:19 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2017:2915 0 normal SHIPPED_LIVE Red Hat Satellite 5.8.0 bug fix update 2017-10-19 15:56:50 UTC

Description Martin Korbel 2017-05-09 11:27:40 UTC
Description of problem:

I find out a few inconsistencies in spacewalk-repo-sync --help & man spacewalk-repo-sync.


Version-Release number of selected component (if applicable):
spacewalk-java-2.5.14-77.

How reproducible:
100%

Steps to Reproduce:
1. spacewalk-repo-sync --help 
2. man spacewalk-repo-sync

Actual results:

1. Option "lastest" is missing in man page.
 
 > spacewalk-repo-sync --help
  -n, --latest          Sync latest packages only. Use carefully - you might
                        need to fix some dependencies on your own.

2. In the man page, there is missing value of "config" option (paragraph OPTIONS). 

 > spacewalk-repo-sync --help
  -g CONFIG, --config=CONFIG
                        Configuration file

 > man spacewalk-repo-sync
  -g, --config
              Configuration  file where more than one channel can be specified
              for synchronization. See section Examples.

3. The values for options include/exclude are named differently. It's confusing, the options expect filter / expression or exact name of package.

  > spacewalk-repo-sync --help
  -i FILTERS, --include=FILTERS
                        List of included packages
  -e FILTERS, --exclude=FILTERS
                        List of excluded packages

  > man spacewalk-repo-sync
   -i PKG1,PKG2..., --include PKG1,PKG2...
              Comma or space separated list of included packages.

   -e PKG1,PKG2..., --exclude PKG1,PKG2...
              Comma or space separated list of excluded packages.

4. Option "quiet" is missing in Sat5.8. In Sat5.7 there is this option. 

  Sat5.7
  > spacewalk-repo-sync --help
   -q, --quiet           Print no output, still logs output


Expected results:

   The consistent information in both manuals.


Item 1,2 & 4 are regresion against Sat5.7.

Comment 1 Gennadii Altukhov 2017-06-23 15:40:52 UTC
Option "quiet" was removed in upstream 1d796ba2f83ef03375b30781cffd5a64c51a4d75 (this commit is already included in Sat 5.8).

The rest of problems are fixed in upstream. spacewalk.git:
7b929c61e32d0df930478733cbadf719e585f05a

Comment 4 Lukáš Hellebrandt 2017-09-12 13:56:44 UTC
Verified with spacewalk-backend-2.5.3-152.

Help and manpage are now still not the same but they are consistent. Issues 1, 2 and 3 have been fixed and issue 4 is not a bug.

Comment 6 errata-xmlrpc 2017-10-19 11:57:19 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.

https://access.redhat.com/errata/RHBA-2017:2915


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