Bug 1266468

Summary: Typoes/tweaks to "git-review" man page.
Product: [Fedora] Fedora Reporter: Robert P. J. Day <rpjday>
Component: git-reviewAssignee: Pete Zaitcev <zaitcev>
Status: CLOSED EOL QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: unspecified    
Version: 22CC: mcepl, mcepl, zaitcev
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-07-19 20:14:18 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 Robert P. J. Day 2015-09-25 11:03:26 UTC
Some possible tweaks to the git-review man page. First, there seem to be some options missing from the man page that are listed in the output of "git-review --help", such as:

  -i, --new-changeid    Regenerate Change-id before submitting
  -F, --force-rebase    Force rebase even when not needed.
  --no-custom-script    Do not run custom scripts.
  --license             Print the license and exit

and possibly more, those are the ones i noticed; you might want to verify both lists of options yourself.

Next, reading down the man page:

* "change can be changeNumber as obtained using ---list option..."
                                                ^^^ ???

* "Sets the target topic for this change on the gerrit server"
                                                ^ Capitalize.

* "List the available reviews on the gerrit server for this project."
                                     ^ Capitalize.

* "-v --verbose"
     ^ Missing comma.

  QUESTION regarding the following:

   "gitreview.rebase ...
       This setting takes precedence over repository-specific configuration
       in the .gitreview file."

    Really? I have no idea if that's true, but it seems backwards in that,
  normally, repo-specific settings override global ones. So I'm not saying 
  it's wrong, only that it's unusual. Moving on ...

* "place information about your gerrit installation in it..."
                                ^ Capitalize.

   (I'll stop mentioning that issue now, you can scan the man page and
    fix it if you wish anywhere else.)

* "Setting defaultrebase to zero will make git-review not [sic] to rebase changes ..."  Gramatically awkward.


That should do it.

Comment 1 Matěj Cepl 2016-05-05 21:13:45 UTC
Shouldn't this report go immediately to https://github.com/openstack-infra/git-review ?

Comment 2 Fedora End Of Life 2016-07-19 20:14:18 UTC
Fedora 22 changed to end-of-life (EOL) status on 2016-07-19. Fedora 22 is
no longer maintained, which means that it will not receive any further
security or bug fix updates. As a result we are closing this bug.

If you can reproduce this bug against a currently maintained version of
Fedora please feel free to reopen this bug against that version. If you
are unable to reopen this bug, please file a new report against the
current release. If you experience problems, please add a comment to this
bug.

Thank you for reporting this bug and we are sorry it could not be fixed.