bluedevil-sendfile: Set option descriptions for command line help
ClosedPublic

Authored by marten on Dec 1 2017, 9:22 AM.

Details

Summary

The "--kio", "--ubi" and "--files"options (or their short equivalents) have no description text set. This does not affect their functionality, but the options are not displayed correctly if the "--help" option is used:

$ bluedevil-sendfile --help
Usage: bluedevil-sendfile [options]
Bluetooth Send File Wizard

Options:
  --kio, -k <bluetooth://address>    --ubi, -u <ubi>                    --files, -f <files>                -h, --help                       Displays this help.
  -v, --version                    Displays version information.
  --author                         Show author information.
  --license                        Show licence information.
  --desktopfile <file name>        The base file name of the desktop entry for
                                   this application.

Setting a description for these options displays the help correctly:

$ bluedevil-sendfile --help
Usage: bluedevil-sendfile [options]
Bluetooth Send File Wizard

Options:
  --kio, -k <bluetooth://address>  Specify receiving device by MAC address.
  --ubi, -u <ubi>                  Specify receiving device by UBI path.
  --files, -f <files>              Files to be sent.
  -h, --help                       Displays this help.
  -v, --version                    Displays version information.
  --author                         Show author information.
  --license                        Show licence information.
  --desktopfile <file name>        The base file name of the desktop entry for
                                   this application.

This is really a problem with QCommandLineParser or something associated with it, but in the interests of good documentation there should be a description for the options anyway.

Test Plan

Built bluedevil-sendfile with these changes, observed correct "--help" output as above.

Diff Detail

Repository
R97 Bluedevil
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
marten created this revision.Dec 1 2017, 9:22 AM
Restricted Application added a project: Plasma. · View Herald TranscriptDec 1 2017, 9:22 AM
Restricted Application added a subscriber: plasma-devel. · View Herald Transcript
marten requested review of this revision.Dec 1 2017, 9:22 AM
drosca accepted this revision.Dec 1 2017, 3:39 PM
This revision is now accepted and ready to land.Dec 1 2017, 3:39 PM
This revision was automatically updated to reflect the committed changes.