Bug 1449172

Summary: Inconsistency in help and man-page of spacewalk-repo-sync
Product: Red Hat Satellite 5 Reporter: Martin Korbel <mkorbel>
Component: ServerAssignee: Gennadii Altukhov <galtukho>
Status: CLOSED ERRATA QA Contact: Lukáš Hellebrandt <lhellebr>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 580CC: galtukho, jdobes, lhellebr, tlestach
Target Milestone: ---Keywords: Regression
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: spacewalk-backend-2.5.3-152-sat Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-10-19 11:57: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: 1450111    

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