Permalink
Browse files

adding notes into the usage doc based on the review

  • Loading branch information...
caridy committed Dec 11, 2012
1 parent 8bc8b74 commit 9de37dc6f5bd1ea008b7a55fc1fd7fe2713c87d9
Showing with 11 additions and 0 deletions.
  1. +11 −0 lib/app/commands/benchmark.js
@@ -179,6 +179,17 @@ exports.usage = [
'Example: mojito benchmark baz.js --context environment:development',
' (execute a custom benchmark test with a custom context)',
'',
+ 'NOTES:',
+ ' * The name of the yui module that defines the benchmark test should',
+ ' match the filename. In the first example, the test should be defined',
+ ' as `YUI.add("foo-benchmark", function (Y) {/*...*/});`, otherwise',
+ ' the test will fail.',
+ ' * Any yui module from yui core, mojito core or application level module',
+ ' that runs on the server runtime could be required as part of the',
+ ' "requires" array in the benchmark test without any extra configuration.',
+ ' * If you want to require a yui module that is meant to run in the client',
+ ' runtime, make sure you specify the proper --context option.',
+ '',
'OPTIONS: ',
' --context [string] A comma-separated list of key:value pairs',
' that define the base context used to read',

0 comments on commit 9de37dc

Please sign in to comment.