Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(220)

Unified Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 2397293002: Improve server documentation (issue 27521) (Closed)
Patch Set: Created 4 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « pkg/analysis_server/doc/api.html ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/analysis_server/tool/spec/spec_input.html
diff --git a/pkg/analysis_server/tool/spec/spec_input.html b/pkg/analysis_server/tool/spec/spec_input.html
index 5290921df233eb5fc1f93a8782722fac2392328d..07a0577a4ffc25d902c3563ab157506c0021554e 100644
--- a/pkg/analysis_server/tool/spec/spec_input.html
+++ b/pkg/analysis_server/tool/spec/spec_input.html
@@ -148,27 +148,39 @@
<h4>Options</h4>
<blockquote>
<dl>
- <dt>--no-error-notification</dt>
+ <dt>--client-id</dt>
<dd>
- Disable notifications about errors (see analysis.error). If this
- flag is not specified then notifications will be sent for all
- errors produced for all files in the actual analysis roots.
+ <p>
+ Specifies an identifier associated with the client. Used when
+ generating error reports.
+ </p>
+ <p>
+ Clients are strongly encouraged to provide this information in
+ order to improve the quality of information that can be provided
+ to them.
+ </p>
</dd>
</dl>
<dl>
- <dt>--file-read-mode</dt>
+ <dt>--client-version</dt>
+ <dd>
+ <p>
+ Specifies the version of the client that is communicating with
+ the server. Used when generating error reports.
+ </p>
+ <p>
+ Clients are strongly encouraged to provide this information in
+ order to improve the quality of information that can be provided
+ to them.
+ </p>
+ </dd>
+ </dl>
+ <dl>
+ <dt>--no-error-notification</dt>
<dd>
- An enumeration of the ways files can be read from disk. Some clients
- normalize end of line characters which would make the file offset and
- range information incorrect. The default option is <tt>as-is</tt>, but
- can also be set to <tt>normalize-eol-always</tt>. The default option
- (<tt>as-is</tt>) reads files as they are on disk. The
- <tt>normalize-eol-always</tt> option does the following:
- <ul>
- <li>'\r\n' is converted to '\n';</li>
- <li>'\r' by itself is converted to '\n';</li>
- <li>this happens regardless of the OS editor is running on.</li>
- </ul>
+ Disable notifications about errors (see analysis.error). If this
+ flag is not specified then notifications will be sent for all
+ errors produced for all files in the actual analysis roots.
</dd>
</dl>
<dl>
@@ -178,7 +190,24 @@
API is used that requires an index, then an error, <tt>NO_INDEX_GENERATED</tt>,
will be thrown. The set of API calls that require an index include:
refactoring calls, code completions and searching.
- <!-- TODO(jwren/scheglov): make sure that this of APIs that is complete. -->
+ <!-- TODO(jwren/scheglov): make sure that this list of APIs that is complete. -->
+ </dd>
+ </dl>
+ <dl>
+ <dt>--file-read-mode</dt>
+ <dd>
+ <p><b>Deprecated</b></p>
+ An enumeration of the ways files can be read from disk. Some clients
+ normalize end of line characters which would make the file offset and
+ range information incorrect. The default option is <tt>as-is</tt>, but
+ can also be set to <tt>normalize-eol-always</tt>. The default option
+ (<tt>as-is</tt>) reads files as they are on disk. The
+ <tt>normalize-eol-always</tt> option does the following:
+ <ul>
+ <li>'\r\n' is converted to '\n';</li>
+ <li>'\r' by itself is converted to '\n';</li>
+ <li>this happens regardless of the OS editor is running on.</li>
+ </ul>
</dd>
</dl>
</blockquote>
« no previous file with comments | « pkg/analysis_server/doc/api.html ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698