Chromium Code Reviews Chromium Code Reviews
Issue 932883002:
Addition of the --no-index flag to the analysis server spec. (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart| OLD | NEW |
|---|---|
| 1 | 1 |
| 2 <html> | 2 <html> |
| 3 <head> | 3 <head> |
| 4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
| 5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
| 9 <h1 style="color:#999999">Version <version>1.2.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.2.0</version></h1> |
| 10 <p> | 10 <p> |
| (...skipping 144 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 155 can also be set to <tt>normalize-eol-always</tt>. The default option | 155 can also be set to <tt>normalize-eol-always</tt>. The default option |
| 156 (<tt>as-is</tt>) reads files as they are on disk. The | 156 (<tt>as-is</tt>) reads files as they are on disk. The |
| 157 <tt>normalize-eol-always</tt> option does the following: | 157 <tt>normalize-eol-always</tt> option does the following: |
| 158 <ul> | 158 <ul> |
| 159 <li>'\r\n' is converted to '\n';</li> | 159 <li>'\r\n' is converted to '\n';</li> |
| 160 <li>'\r' by itself is converted to '\n';</li> | 160 <li>'\r' by itself is converted to '\n';</li> |
| 161 <li>this happens regardless of the OS editor is running on.</li> | 161 <li>this happens regardless of the OS editor is running on.</li> |
| 162 </ul> | 162 </ul> |
| 163 </dd> | 163 </dd> |
| 164 </dl> | 164 </dl> |
| 165 <dl> | |
| 166 <dt>--no-index</dt> | |
| 167 <dd> | |
| 168 An indication that no indexer calls will be made to the analysis server, | |
|
Brian Wilkerson
2015/02/17 17:54:46
"An indication" seems a little weak. The flag expl
| |
| 169 and thus, no index should be created. If this flag is passed and an API is | |
| 170 used that requires an index, then an <tt>NO_INDEX_GENERATED</tt> exception | |
|
Brian Wilkerson
2015/02/17 17:54:46
"an" --> "a"
"exception" --> "error"
| |
| 171 will be thrown. The set of API calls that require an index include: | |
| 172 refactoring calls, code completions and searching. | |
|
scheglov
2015/02/17 17:48:36
Would be nice to document also corresponding API r
jwren
2015/02/17 17:54:41
Agreed. After we know what the set of APIs are, I
Brian Wilkerson
2015/02/17 17:54:46
I think we need to actually include this informati
| |
| 173 <!-- TODO(jwren/scheglov): make sure that this of APIs that is complete. - -> | |
| 174 </dd> | |
| 175 </dl> | |
| 165 </blockquote> | 176 </blockquote> |
| 166 <domain name="server"> | 177 <domain name="server"> |
| 167 <p> | 178 <p> |
| 168 The server domain contains API’s related to the execution of | 179 The server domain contains API’s related to the execution of |
| 169 the server. | 180 the server. |
| 170 </p> | 181 </p> |
| 171 <request method="getVersion"> | 182 <request method="getVersion"> |
| 172 <p>Return the version number of the analysis server.</p> | 183 <p>Return the version number of the analysis server.</p> |
| 173 <result> | 184 <result> |
| 174 <field name="version"> | 185 <field name="version"> |
| (...skipping 2915 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3090 <value> | 3101 <value> |
| 3091 <code>INVALID_EXECUTION_CONTEXT</code> | 3102 <code>INVALID_EXECUTION_CONTEXT</code> |
| 3092 <p> | 3103 <p> |
| 3093 The context root used to create an execution context does not | 3104 The context root used to create an execution context does not |
| 3094 exist. | 3105 exist. |
| 3095 </p> | 3106 </p> |
| 3096 </value> | 3107 </value> |
| 3097 <value> | 3108 <value> |
| 3098 <code>INVALID_OVERLAY_CHANGE</code> | 3109 <code>INVALID_OVERLAY_CHANGE</code> |
| 3099 <p> | 3110 <p> |
| 3100 An analysis.updateContent request contained a | 3111 An "analysis.updateContent" request contained a |
|
Brian Wilkerson
2015/02/17 17:54:46
I don't think we quote request/notification names
| |
| 3101 ChangeContentOverlay object which can't be applied, due | 3112 ChangeContentOverlay object which can't be applied, due |
| 3102 to an edit having an offset or length that is out of | 3113 to an edit having an offset or length that is out of |
| 3103 range. | 3114 range. |
| 3104 </p> | 3115 </p> |
| 3105 </value> | 3116 </value> |
| 3106 <value> | 3117 <value> |
| 3107 <code>INVALID_PARAMETER</code> | 3118 <code>INVALID_PARAMETER</code> |
| 3108 <p> | 3119 <p> |
| 3109 One of the method parameters was invalid. | 3120 One of the method parameters was invalid. |
| 3110 </p> | 3121 </p> |
| 3111 </value> | 3122 </value> |
| 3112 <value> | 3123 <value> |
| 3113 <code>INVALID_REQUEST</code> | 3124 <code>INVALID_REQUEST</code> |
| 3114 <p> | 3125 <p> |
| 3115 A malformed request was received. | 3126 A malformed request was received. |
| 3116 </p> | 3127 </p> |
| 3117 </value> | 3128 </value> |
| 3118 <value> | 3129 <value> |
| 3130 <code>NO_INDEX_GENERATED</code> | |
| 3131 <p> | |
| 3132 The "--no-index" flag was passed when the analysis server created, | |
|
Brian Wilkerson
2015/02/17 17:54:46
"server created" --> "server was created"
| |
| 3133 but this API call requires an index to have been generated. | |
| 3134 </p> | |
| 3135 </value> | |
| 3136 <value> | |
| 3119 <code>REFACTORING_REQUEST_CANCELLED</code> | 3137 <code>REFACTORING_REQUEST_CANCELLED</code> |
| 3120 <p> | 3138 <p> |
| 3121 Another refactoring request was received during processing of | 3139 Another refactoring request was received during processing of |
| 3122 this one. | 3140 this one. |
| 3123 </p> | 3141 </p> |
| 3124 </value> | 3142 </value> |
| 3125 <value> | 3143 <value> |
| 3126 <code>SERVER_ALREADY_STARTED</code> | 3144 <code>SERVER_ALREADY_STARTED</code> |
| 3127 <p> | 3145 <p> |
| 3128 The analysis server has already been started (and hence | 3146 The analysis server has already been started (and hence |
| (...skipping 693 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3822 <h2>Errors</h2> | 3840 <h2>Errors</h2> |
| 3823 <p> | 3841 <p> |
| 3824 This section contains a list of all of the errors that are | 3842 This section contains a list of all of the errors that are |
| 3825 produced by the server and the data that is returned with each. | 3843 produced by the server and the data that is returned with each. |
| 3826 </p> | 3844 </p> |
| 3827 <p> | 3845 <p> |
| 3828 TBD | 3846 TBD |
| 3829 </p> | 3847 </p> |
| 3830 </body> | 3848 </body> |
| 3831 </html> | 3849 </html> |
| OLD | NEW |
