| OLD | NEW |
| 1 // Copyright (c) 2015, the Dartino project authors. Please see the AUTHORS file | 1 // Copyright (c) 2015, the Dartino project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE.md file. | 3 // BSD-style license that can be found in the LICENSE.md file. |
| 4 | 4 |
| 5 library fletchc.verbs.documentation; | 5 library dartino_compiler.verbs.documentation; |
| 6 | 6 |
| 7 const String synopsis = """ | 7 const String synopsis = """ |
| 8 Manages interactions with the fletch compiler and runtime. | 8 Manages interactions with the dartino compiler and runtime. |
| 9 Example: fletch run sample.dart | 9 Example: dartino run sample.dart |
| 10 | 10 |
| 11 Usage: fletch <action> [<argument>]... | 11 Usage: dartino <action> [<argument>]... |
| 12 where <action> is one of the following:"""; | 12 where <action> is one of the following:"""; |
| 13 | 13 |
| 14 const String debugDocumentation = """ | 14 const String debugDocumentation = """ |
| 15 debug | 15 debug |
| 16 Start an interactive debug session | 16 Start an interactive debug session |
| 17 | 17 |
| 18 debug backtrace | 18 debug backtrace |
| 19 Print the current stack trace | 19 Print the current stack trace |
| 20 | 20 |
| 21 debug break <location> | 21 debug break <location> |
| (...skipping 30 matching lines...) Expand all Loading... |
| 52 debug print *<name> | 52 debug print *<name> |
| 53 Print the structure of the local variable with the given name | 53 Print the structure of the local variable with the given name |
| 54 | 54 |
| 55 debug print-all | 55 debug print-all |
| 56 Print the value of all local variables | 56 Print the value of all local variables |
| 57 | 57 |
| 58 debug restart | 58 debug restart |
| 59 Restart the selected frame | 59 Restart the selected frame |
| 60 | 60 |
| 61 debug run-to-main | 61 debug run-to-main |
| 62 Run the compiled code on the Fletch VM and break at the main method | 62 Run the compiled code on the Dartino VM and break at the main |
| 63 method |
| 63 | 64 |
| 64 debug step | 65 debug step |
| 65 Step to next source position | 66 Step to next source position |
| 66 | 67 |
| 67 debug step-bytecode | 68 debug step-bytecode |
| 68 Step one bytecode | 69 Step one bytecode |
| 69 | 70 |
| 70 debug step-over | 71 debug step-over |
| 71 Step to next source location; do not follow calls | 72 Step to next source location; do not follow calls |
| 72 | 73 |
| 73 debug step-over-bytecode | 74 debug step-over-bytecode |
| 74 Step one bytecode; do not follow calls | 75 Step one bytecode; do not follow calls |
| 75 | 76 |
| 76 debug toggle internal | 77 debug toggle internal |
| 77 Toggle visibility of internal frames | 78 Toggle visibility of internal frames |
| 78 """; | 79 """; |
| 79 | 80 |
| 80 const String helpDocumentation = """ | 81 const String helpDocumentation = """ |
| 81 help all List all commands | 82 help all List all commands |
| 82 """; | 83 """; |
| 83 | 84 |
| 84 const String createDocumentation = """ | 85 const String createDocumentation = """ |
| 85 create session <name> [with <settings file>] | 86 create session <name> [with <settings file>] |
| 86 Create a new session with the given name. Read settings from | 87 Create a new session with the given name. Read settings from |
| 87 <settings file> (defaults to '.fletch-settings'). | 88 <settings file> (defaults to '.dartino-settings'). |
| 88 | 89 |
| 89 Settings are specified in JSON (comments allowed): | 90 Settings are specified in JSON (comments allowed): |
| 90 | 91 |
| 91 { | 92 { |
| 92 // Location of the package configuration file (a relative URI) | 93 // Location of the package configuration file (a relative URI) |
| 93 "packages": ".packages", | 94 "packages": ".packages", |
| 94 | 95 |
| 95 // A list of strings that are passed to the compiler | 96 // A list of strings that are passed to the compiler |
| 96 "options": ["--verbose"], | 97 "options": ["--verbose"], |
| 97 | 98 |
| (...skipping 10 matching lines...) Expand all Loading... |
| 108 } | 109 } |
| 109 """; | 110 """; |
| 110 | 111 |
| 111 const String compileDocumentation = """ | 112 const String compileDocumentation = """ |
| 112 compile <file> [in session <name>] | 113 compile <file> [in session <name>] |
| 113 Compile <file> | 114 Compile <file> |
| 114 """; | 115 """; |
| 115 | 116 |
| 116 const String attachDocumentation = """ | 117 const String attachDocumentation = """ |
| 117 attach tcp_socket [<host>:]<port> | 118 attach tcp_socket [<host>:]<port> |
| 118 Attach to Fletch VM on the given socket | 119 Attach to Dartino VM on the given socket |
| 119 """; | 120 """; |
| 120 | 121 |
| 121 const String runDocumentation = """ | 122 const String runDocumentation = """ |
| 122 run [<file>] [in session remote] | 123 run [<file>] [in session remote] |
| 123 Run <file> on the Fletch VM. If no <file> is given, run the | 124 Run <file> on the Dartino VM. If no <file> is given, run the |
| 124 previous file. Defaults to running on the local PC; | 125 previous file. Defaults to running on the local PC; |
| 125 use 'in session remote' to run remotely. | 126 use 'in session remote' to run remotely. |
| 126 """; | 127 """; |
| 127 | 128 |
| 128 const String endDocumentation = """ | 129 const String endDocumentation = """ |
| 129 x-end session <name> | 130 x-end session <name> |
| 130 End the named session | 131 End the named session |
| 131 """; | 132 """; |
| 132 | 133 |
| 133 const String servicecDocumentation = """ | 134 const String servicecDocumentation = """ |
| 134 x-servicec <file> | 135 x-servicec <file> |
| 135 Compile service IDL file named <file> to custom Fletch interface | 136 Compile service IDL file named <file> to custom Dartino interface |
| 136 """; | 137 """; |
| 137 | 138 |
| 138 const String exportDocumentation = """ | 139 const String exportDocumentation = """ |
| 139 export [<dartfile>] to <snapshot> | 140 export [<dartfile>] to <snapshot> |
| 140 Compile <dartfile> and create a snapshot in <snapshot>. If no | 141 Compile <dartfile> and create a snapshot in <snapshot>. If no |
| 141 <dartfile> is given, export the previously compiled file | 142 <dartfile> is given, export the previously compiled file |
| 142 """; | 143 """; |
| 143 | 144 |
| 144 const String quitDocumentation = """ | 145 const String quitDocumentation = """ |
| 145 quit Quits the Fletch background process, and terminates all | 146 quit Quits the Dartino background process, and terminates all |
| 146 Fletch sessions currently running. | 147 Dartino sessions currently running. |
| 147 """; | 148 """; |
| 148 | 149 |
| 149 const String showDocumentation = """ | 150 const String showDocumentation = """ |
| 150 show devices | 151 show devices |
| 151 Show all Fletch capable devices connected | 152 Show all Dartino capable devices connected |
| 152 directly or available on the network | 153 directly or available on the network |
| 153 | 154 |
| 154 show log [in session <name>] | 155 show log [in session <name>] |
| 155 Show log for given session | 156 Show log for given session |
| 156 """; | 157 """; |
| 157 | 158 |
| 158 // TODO(lukechurch): Review UX. | 159 // TODO(lukechurch): Review UX. |
| 159 const String upgradeDocumentation = """ | 160 const String upgradeDocumentation = """ |
| 160 x-upgrade agent with <package-file> [in session <session>] | 161 x-upgrade agent with <package-file> [in session <session>] |
| 161 Upgrade the agent used in session to the version provided in the | 162 Upgrade the agent used in session to the version provided in the |
| 162 .deb package <package-file> | 163 .deb package <package-file> |
| 163 """; | 164 """; |
| 164 | 165 |
| 165 // TODO(lukechurch): Review UX. | 166 // TODO(lukechurch): Review UX. |
| 166 const String downloadToolsDocumentation = """ | 167 const String downloadToolsDocumentation = """ |
| 167 x-download-tools | 168 x-download-tools |
| 168 Downloads the third party tools required for MCU developemnt. | 169 Downloads the third party tools required for MCU developemnt. |
| 169 This is currently GCC ARM Embedded and OpenOCD. | 170 This is currently GCC ARM Embedded and OpenOCD. |
| 170 """; | 171 """; |
| OLD | NEW |