Bug 10726

Summary: urpmi man-pages: name long and short options in same line
Product: Mageia Reporter: Hartmut Goebel <h.goebel>
Component: RPM PackagesAssignee: Thierry Vignaud <thierry.vignaud>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: Low Keywords: Junior_job
Version: Cauldron   
Target Milestone: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Source RPM: urpmi-7.27.3-2.mga3.src.rpm CVE:
Status comment:
Attachments: 0001-Fix-formatting-errors-in-pod-files.patch
0002-Correct-white-space-errors-in-pod-files.patch
0003-Put-corresponding-long-and-short-options-in-same-lin.patch
0004-Minor-markup-improvements.patch
0005-Put-corresponding-long-and-short-options-in-same-lin.patch
0006-Group-options-by-purpose-and-add-sub-headlines-for-e.patch
This is a concatinated comtent of patched 0001 to 0006. Just to ease download.

Description Hartmut Goebel 2013-07-07 11:53:19 CEST
The list of options in urpm* man-pages should be more concise:
More concise list of options in urpm* man-pages
* long and short options should by named together in one line

Currently e.g. the man-page of `urpmi` contains:
  --fuzzy
     [... descrption of this option ...] "(this is the same as -y)."

  --quiet
  [...approx. 250 lines ...]
  -q This is the same as --quiet.

This should become

  --fuzzy, -y
     [... descrption of this option ...]
  --quite, -q
     [... descrption of this option ...]

This is like the man-page for e.g. `ls` does it.

Of course this should be done not only with the man-page of urpmi, but also for the other tools' man-pages: urpmq, urpmf, urpmi.update, etc.

Reproducible: 

Steps to Reproduce:
Manuel Hiebel 2013-07-09 09:37:44 CEST

Keywords: (none) => Junior_job

David Walser 2013-08-11 02:46:03 CEST

Assignee: bugsquad => thierry.vignaud

Comment 1 Thierry Vignaud 2013-08-21 16:26:10 CEST
patch welcome :-)

Priority: Normal => Low
Version: 3 => Cauldron

Comment 2 Thierry Vignaud 2014-11-24 14:14:49 CET
ping for a patch
Comment 3 Hartmut Goebel 2014-11-25 01:08:22 CET
Created attachment 5635 [details]
0001-Fix-formatting-errors-in-pod-files.patch
Comment 4 Hartmut Goebel 2014-11-25 01:09:02 CET
Created attachment 5636 [details]
0002-Correct-white-space-errors-in-pod-files.patch
Comment 5 Hartmut Goebel 2014-11-25 01:09:21 CET
Created attachment 5637 [details]
0003-Put-corresponding-long-and-short-options-in-same-lin.patch
Comment 6 Hartmut Goebel 2014-11-25 01:09:40 CET
Created attachment 5638 [details]
0004-Minor-markup-improvements.patch
Comment 7 Hartmut Goebel 2014-11-25 01:09:58 CET
Created attachment 5639 [details]
0005-Put-corresponding-long-and-short-options-in-same-lin.patch
Comment 8 Hartmut Goebel 2014-11-25 01:10:29 CET
Created attachment 5640 [details]
0006-Group-options-by-purpose-and-add-sub-headlines-for-e.patch
Comment 9 Hartmut Goebel 2014-11-25 01:12:34 CET
Created attachment 5641 [details]
This is a concatinated comtent of patched 0001 to 0006. Just to ease download.
Comment 10 Hartmut Goebel 2014-11-25 01:13:50 CET
Here are the patches. I hope, they will get into Mga 5, though.
Comment 11 Dick Gevers 2014-11-25 02:59:04 CET
Please permit me to say there are some typos in patch 6/6:

In para. 1:

s/download-options/download options   # typically English does not use the hyphen here

s/, database-options/and database options


In para. 2:

s/gropus/groups

s/rarly/rarely


In para. 3:

s/matchin/matching

s/farly/fairly
Comment 12 Thierry Vignaud 2014-11-25 11:04:28 CET
Looks good.
Please apply.
but use git rebase --interactive HEAD~10 in order to fix the stuff spot by Dick.

Also make sure to rebase over this morning HEAD, I find it better not to have a merge commit :-)
Comment 13 Hartmut Goebel 2014-11-25 13:27:06 CET
(In reply to Thierry Vignaud from comment #12)

> Please apply.

Whom do you mean? I have not commit permission (and do not want to have them).
Comment 14 Hartmut Goebel 2014-11-25 13:27:56 CET
(In reply to Dick Gevers from comment #11)
> Please permit me to say there are some typos in patch 6/6:

Good that you spotted them. Thanks.
Comment 15 Thierry Vignaud 2014-11-25 19:38:55 CET
Pushed.
I've merged your patches when needed

Status: NEW => RESOLVED
Resolution: (none) => FIXED