And after I run ant and then run it without any parms I get help. But still, we at least need to say, in the script, that to get help, you got to run with -h
Plus, the help got to follow standard. e.g. we need to have proper synopsis, and in standard manual format. There is a layout: http://en.wikipedia.org/wiki/Man_page#Layout and there are conventions: http://linux.die.net/man/7/man-pages, like " Brackets ([]) surround optional arguments, vertical bars (|) separate choices, and ellipses (...) can be repeated." e.g. see http://unixhelp.ed.ac.uk/CGI/man-cgi?at & http://unixhelp.ed.ac.uk/CGI/man-cgi?svn We are better off following the same styles, layout and conventions when we provide help, as they are well understood by many. Following is the help line we get and that is confusing on many fronts: " Using CARBON_HOME: D:\testing\WSO2GR~1.0\bin\.. Using JAVA_HOME: C:\Program Files\Java\jdk1.6.0_26 Unable to find the operation. Provide an operation to invoke.Usage: checkin-client <command> <options> Valid commands are: co/checkout <url/path>: Checkout a url/path. If you are checking out local registry just provide the path. If you are checking out remote r egistry provide the registry url followed by the path. Example 1 of urls: "/" Example 2 of urls: "/path1" Example 3 of urls: "http://localhost:9763/registry"; Example 4 of urls: "http://localhost:9763/registry/path1"; ci/checkin <url/path>: Commit the changes back to the registry, You should give the url/path of the registry, with the -f option. if the -f option and url/path not provided, tool will check-in to the same location it took the checkout from. up/update: Get an updated for already checkout directory Valid options are: -h: For the help screen. -u <username>: (Required) The user name of the registry login. -p <password>: The password of the registry login. -l <location>: The working directory or path of file to check-in. -f <dumpfile>: check-in or checkout using dump file specified by this option. Example to checkout the root of a registry running on localhost: checkin-client.sh/bat co http://localhost:9763/registry/ -u admin -p admin ~ ~" On Sat, Sep 24, 2011 at 7:33 AM, Samisa Abeysinghe <[email protected]> wrote: > Note that, even if the Java class has help, we still need help stuff > written on the script. Becuase, when I try the script, and I cannot how to > run it, it is natural to edit and try and locate help section. That is what > most users would do. > > Samisa... > > On Sat, Sep 24, 2011 at 7:30 AM, Samisa Abeysinghe <[email protected]>wrote: > >> Neither sh nor bat files has anything on >> --help >> -help >> /? >> >> or any of that sort. >> >> We need these scripts to print help when you run those without any command >> line params, as well as with standard help options like those above. >> >> When I want to run the command, as a user, I expect help to be there, then >> and there: Usability! >> >> Please fix this. >> >> Thanks, >> Samisa... >> > >
_______________________________________________ Carbon-dev mailing list [email protected] http://mail.wso2.org/cgi-bin/mailman/listinfo/carbon-dev
