mavak / trucov

True coverage tool for C / C++
1 stars 1 forks source link

help for selection is confusing #111

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
 --selection arg       specify the function(s) in all source files.

I didn't understand this when I first read it.  I am already familiar with
the tool, someone completely new may not be able to understand what this
command line option does.

Original issue reported on code.google.com by j.nick.terry@gmail.com on 9 Sep 2009 at 4:33

GoogleCodeExporter commented 9 years ago
Assigned to Ye.

1) Remove from --help print out, the --selection option.
2) You don't have to state the usage for all the commands. Instead state the 
usage at
the top, and then list all the commands.

So print:
{{{  
  Usage: trucov [ command ] [ option... ] [ selection... ]

  Available Commands:
    list          <description>
    status        <description>
    report        <description>
    dot           <description>
    dot_report    <description>
    render        <description>
    render_report <description>
}}}

And then the options would follow

Original comment by millerlyte87@gmail.com on 10 Sep 2009 at 12:14

GoogleCodeExporter commented 9 years ago

Original comment by millerlyte87@gmail.com on 10 Sep 2009 at 12:14

GoogleCodeExporter commented 9 years ago
Maybe under the Usage: ....

You should print out an example.

Usage:    trucov [ command ] [ option... ] [ selection... ]

Example: 'trucov list --brief foo foof bar' runs the list command, with option
--brief, and selection 'foo', 'foof', and 'bar'. 

Available Commands:
...
...

Original comment by millerlyte87@gmail.com on 10 Sep 2009 at 12:19

GoogleCodeExporter commented 9 years ago

Original comment by yekyaw.wsu@gmail.com on 27 Sep 2009 at 7:12

GoogleCodeExporter commented 9 years ago
Verified by Matt.

Original comment by millerlyte87@gmail.com on 28 Sep 2009 at 8:42