apport-bug options not mentioned in manpage synopsis

Bug #1071930 reported by Benjamin Drung
28
This bug affects 3 people
Affects Status Importance Assigned to Milestone
Apport
Triaged
Low
Unassigned
One Hundred Papercuts
Confirmed
Medium
Unassigned
apport (Ubuntu)
Triaged
Low
Unassigned

Bug Description

The man page of apport-bug does not mention in the synopsis that apport-bug takes options. You will not be informed about additional options until you reach the options section.

The options section says: "Please see the apport-cli(1) manpage for possible options."
Can you add that apport-bug takes the same parameters than apport-cli, they work the same, and the only different is that apport-bug has a GUI and apport-cli is for the command line (if this is correct)?

ProblemType: Bug
DistroRelease: Ubuntu 12.10
Package: apport 2.6.1-0ubuntu6
ProcVersionSignature: Ubuntu 3.5.0-17.28-generic 3.5.5
Uname: Linux 3.5.0-17-generic x86_64
ApportVersion: 2.6.1-0ubuntu6
Architecture: amd64
Date: Fri Oct 26 23:49:11 2012
InstallationDate: Installed on 2012-04-24 (184 days ago)
InstallationMedia: Ubuntu 12.04 LTS "Precise Pangolin" - Beta amd64 (20120421)
MarkForUpload: True
PackageArchitecture: all
ProcEnviron:
 TERM=xterm
 PATH=(custom, no user)
 XDG_RUNTIME_DIR=<set>
 LANG=de_DE.UTF-8
 SHELL=/bin/bash
SourcePackage: apport
UpgradeStatus: Upgraded to quantal on 2012-10-22 (3 days ago)

Revision history for this message
Benjamin Drung (bdrung) wrote :
Revision history for this message
Hans Joachim Desserud (hjd) wrote :

Thanks for reporting.

I agree that this should be clarified somehow. The same issue is still present in apport 2.17.2-0ubuntu1.1 on Ubuntu 15.04.

Note that I also found bug 1395307 which is strongly related (possibly a duplicate), and also bug 1009927 which might make sense to look at at the same time.

Changed in apport (Ubuntu):
status: New → Confirmed
tags: added: bitesize manpage string-fix trusty utopic vivid
removed: quantal
summary: - apport-bug options not mentioned in synopsis
+ apport-bug options not mentioned in manpage synopsis
Changed in apport (Ubuntu):
importance: Undecided → Medium
Changed in hundredpapercuts:
status: New → Confirmed
Changed in apport:
status: New → Confirmed
Changed in hundredpapercuts:
importance: Undecided → Medium
Revision history for this message
Martin Pitt (pitti) wrote :

> Can you add that apport-bug takes the same parameters than apport-cli

This is absolutely not true/intended. Please see "apport-bug --help" for the (much reduced) intended options. They indeed should be added to the manpage.

Changed in apport (Ubuntu):
status: Confirmed → Triaged
Changed in apport:
status: Confirmed → Triaged
Changed in apport (Ubuntu):
importance: Medium → Low
Changed in apport:
importance: Undecided → Low
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

This release of Ubuntu is no longer receiving maintenance updates. If this is still an issue on a maintained version of Ubuntu please let us know.

Changed in apport (Ubuntu):
status: Triaged → Incomplete
Revision history for this message
Guntbert Reiter (guntbert) wrote :

Nothing has changed up to Ubuntu 19.10 - the man pages seem to have not been touched since 2009.
I confirm that there is a very inconspicuous mention of `man apport-cli(1)` though.

Revision history for this message
Guntbert Reiter (guntbert) wrote :

continuing ...

Looking at apport-bug --help shows that there is a severe discrepancy between what man apport-cli shows and what apport-bug will accept.

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

I see. Thank you very much for the update Guntbert.

Changed in apport (Ubuntu):
status: Incomplete → Triaged
Revision history for this message
Akbarkhon Variskhanov (kbar) wrote :

The thing is `apport-bug` is just a wrapper script. It doesn't process any of its arguments and just passes over all positional parameters to one of `apport-cli`, `apport-gtk` and `apport-kde`. The reason `apport-bug --help` shows a minimal subset of options is that in this mode only a handful of them are supported, or at least are meaningful. If invoked as `apport-bug`, `apport-cli` by default starts in File bug report mode, so mentioning it is redundant.

I think both the man page and the help message are fine as they are.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.