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

Unified Diff: pkg/analyzer/README.md

Issue 1076873003: Update analyzer readme (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Addressed more comments Created 5 years, 8 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 | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/analyzer/README.md
diff --git a/pkg/analyzer/README.md b/pkg/analyzer/README.md
index c8db3be4e6ce009e269c74ecf42b46e97462b1cd..2423774cf9d88dd9c7e100008dbbe772b2d30bcc 100644
--- a/pkg/analyzer/README.md
+++ b/pkg/analyzer/README.md
@@ -1,20 +1,27 @@
-This code is part of an experimental port of the Editor's analysis engine from
-Java to Dart. While we will continue to support the Java version of the analysis
-engine and the services built on it, we also intend to provide the same services
-to Dart-based applications. This is very early code and we expect it to change,
-possibly in significant ways. While we are eager to see other people make use
-of the analysis engine, we also want to be clear, in case you are interested in
-doing so, that the current API's should in no way be considered to be stable.
+The analysis package defines support for performing static analysis of Dart
+code. It was designed to support tooling efforts, but has also been used for
+such things as statistics gathering and code transformers.
-In particular, this code was automatically translated from the Java
-implementation. The Java implementation that was translated is still under
-development and will continue to change over time. The translator that was used
-is still under development and the output produced by the translator will change
-over time. Therefore, the API presented by this code will change. In addition,
-any edits made to this code will be overwritten the next time we re-generate
-this code.
+If you are interested in providing Dart support in a long-running tool, such as
+an editor or IDE, you should use the analysis server instead of this package.
+The analysis server is currently shipped as an executable in the SDK and will
+be released as a package in the near future. In the meantime, if you'd like to
+learn more about it, please look at the
+[Analysis Server API Specification](http://htmlpreview.github.io/?https://github.com/dart-lang/bleeding_edge/blob/master/dart/pkg/analysis_server/doc/api.html)
+or contact the mailing list (see below).
-If you are interested in using this code, despite the disclaimer above,
-fantastic! Please let the editor team know so that we can get a sense of the
-interest in it. Also, feel free to ask questions and make requests for
-additional functionality.
+The API's in this package are, quite frankly, a mess at the moment. They were
+originally machine generated by a translator and were based on an earlier Java
+implementation. Several of the API's still look like their Java predecessors
+(or worse) rather than clean Dart API's.
+
+In addition, there is currently no clean distinction between public and internal
+API's. We plan to address this issue soon, but doing so will, unfortunately,
+require a large number of breaking changes. We will try to minimize the pain
+this causes for our clients, but some pain is inevitable.
+
+Questions and requests for additional functionality are welcome, and can be made
+by either opening an issue at
+[https://code.google.com/p/dart/issues](https://code.google.com/p/dart/issues)
+or by emailing
+[analyzer-discuss@dartlang.org](https://groups.google.com/a/dartlang.org/forum/#!forum/analyzer-discuss).
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698