Bug 45186 - contradictory documentation for pkcon
Summary: contradictory documentation for pkcon
Status: RESOLVED NOTABUG
Alias: None
Product: PackageKit
Classification: Unclassified
Component: General (show other bugs)
Version: unspecified
Hardware: x86-64 (AMD64) Linux (All)
: medium normal
Assignee: Richard Hughes
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-01-24 09:52 UTC by Christopher Yeleighton
Modified: 2018-08-21 15:53 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Christopher Yeleighton 2012-01-24 09:52:16 UTC
{ man pkcon; }

: SYNOPSIS
: pkcon [search] [debug install] [remove]

That means that you can pass up to three keywords, all optional, in fixed order.

So let’s try then:

{ pkcon; }

<--
Usage:
  pkcon [OPTION...] PackageKit Console Program

PackageKit Console Interface

Subcommands:
  get-actions
  get-groups
  get-filters
  get-transactions
  get-time
  search [name|details|group|file] [data]
  install [packages]
  install-local [files]
  download [directory] [packages]
  install-sig [type] [key_id] [package_id]
  remove [package]
  update <package>
  refresh [--force]
  resolve [package]
  get-updates
  get-depends [package]
  get-requires [package]
  get-details [package]
  get-distro-upgrades
  get-files [package]
  get-update-detail [package]
  get-packages
  repo-list
  repo-enable [repo_id]
  repo-disable [repo_id]
  repo-set-data [repo_id] [parameter] [value];
  what-provides [search]


Help Options:
  -?, --help               Show help options
  --help-all               Show all help options

Application Options:
  --version                Show the program version and exit
  --filter                 Set the filter, e.g. installed
  --root                   Set the install root, e.g. '/' or '/mnt/ltsp'
  -n, --nowait             Exit without waiting for actions to complete
  -y, --noninteractive     Install the packages without asking for confirmation
  --background             Run the command using idle network bandwidth and also using less power
  -p, --plain              Print to screen a machine readable output, rather than using animated widgets
  -c, --cache-age          The maximum metadata cache age. Use -1 for 'never'.
  -h, --help               Show help options.
  -v, --verbose            Show debugging information for all files
-->

Clearly, both descriptions cannot be correct at the same time.
Comment 1 Christopher Yeleighton 2012-01-24 11:17:06 UTC
I tried { help2man pkcon; } but the help text is incompatible with help2man.

Besides, the usage string is no good: 

: pkcon [OPTION...] PackageKit Console Program

means "PackageKit Console Program" are required arguments.
Comment 2 Richard Hughes 2012-01-25 01:29:31 UTC
I'm not sure what to put there. A patch would be very much appreciated! :)
Comment 3 Christopher Yeleighton 2012-01-25 02:07:16 UTC
(In reply to comment #2)
> I'm not sure what to put there. A patch would be very much appreciated! :)

Let’s start with fixing the Usage string.

How about the following start?

<--
pkcon - PackageKit Command Line Utility
Usage: pkcon [$OPTION ...] $SUBCOMMAND
-->

If we agree to this, maybe I could fix the layout so that help2man would produce something that actually makes sense.
Comment 4 Richard Hughes 2018-08-21 15:53:10 UTC
We moved the upstream bugtracker to GitHub a long time ago. If this issue still affects you please re-create the issue here: https://github.com/hughsie/PackageKit/issues
 
Sorry for the impersonal message, and fingers crossed your issue no longer happens. Thanks.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.