Skip to content

Pure documentation. README is old. Binaries from build/bin don't render "description" when launched with -h or --help. #10

Description

@GoogleCodeExporter
Great project first of all! Respect to you kosmos ppl. 
But any chance that we(users) can have more broad and comprehensible 
documenation on binaries and scripts?

For example:
$ ./telemetry_server --help
./telemetry_server: invalid option -- '-'
./telemetry_server: invalid option -- 'e'
Usage: ./telemetry_server -m <machines file>  -l <log fn>

Program tells me what usage should I use, but it doesn't help user to 
understood, actually, what is "telemetry_server" by itself  :)

This kind of problem affects all binaries - lack of description. 

Or this one:
$ ./rebalancer --help
Usage: ./rebalancer <network defn> <data dir> <outputFn>

Any chance to know what is <network defn> ??


Thank you in advance. 
In anycase, great job!

Original issue reported on code.google.com by artem.vy...@gmail.com on 7 Jun 2012 at 10:50

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions