qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-18 08:24:44 -07:00
Code Releases Activity

godoc/static/analysis: update user documentation

Browse Source 
Change-Id: I765b246b44210612a8d7d0484beab07a86fa79c5
Reviewed-on: https://go-review.googlesource.com/9243
Reviewed-by: Robert Griesemer <gri@golang.org>
This commit is contained in:
Alan Donovan 2015-04-22 14:48:18 -04:00
parent a9866431ad
commit a87e08b564
1 changed files with 18 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
godoc/static/analysis/help.html
View File

@ -18,18 +18,6 @@
results in the source and package views. This document provides a
brief tour of these features.
</p>
<p>
The current status of the analysis features is that of a technology
preview; there are many problems and user-interface difficulties
which will be addressed in due course. Some known problems are
mentioned in passing, accompanied by a warning triangle, <span
style='font-size:120%; color:darkred; background-color:
yellow'>⚠</span>.
Nonetheless, godoc's static analysis may be immediately useful today
for small-to-medium sized Go corpora, and it contains several
advances over the state of the art in code browsing.
</p>
<h2>Type analysis features</h2>
<p>
@ -50,10 +38,6 @@
displays the error message.
</p>
<img class="ss" width='811' src='error1.png'><br/>
<p>
<span class='err'>⚠</span> The mark-up for compilation errors may
cause duplication of portions of the input.
</p>
<h3>Identifier resolution</h3>
<p>
@ -114,8 +98,8 @@
channel.
</p>
<p>
Pointer analysis is slower than type analysis, taking an additional
15 seconds or so for the standard libraries and their tests.
Compared to type analysis, pointer analysis requires more time and
memory, and is impractical for code bases exceeding a million lines.
</p>
<h3>Call graph navigation</h3>
@ -249,19 +233,22 @@
<h2>Known issues</h2>
<p>
<span class='err'>⚠</span> All analysis results pertain to exactly
All analysis results pertain to exactly
one configuration (e.g. amd64 linux). Files that are conditionally
compiled based on different platforms or build tags are not visible
to the analysis.<br/>
<span class='err'>⚠</span> Files that <code>import "C"</code> require
preprocessing by the cgo tool. The file offsets after preprocessing
do not align with the unpreprocessed file, so markup is misaligned.<br/>
<span class='err'>⚠</span> Files are not periodically re-analyzed.
If the files change underneath the running server, the displayed
markup is misaligned.<br/>
<span class='err'>⚠</span> Additional issues are listed at
<a href='https://go.googlesource.com/tools/+/master/godoc/analysis/README'>tools/godoc/analysis/README</a>.<br/>
to the analysis.
</p>
<p>
Files that <code>import "C"</code> require
preprocessing by the cgo tool. The file offsets after preprocessing
do not align with the unpreprocessed file, so markup is misaligned.
</p>
<p>
Files are not periodically re-analyzed.
If the files change underneath the running server, the displayed
markup is misaligned.
</p>
<p>
Additional issues are listed at
<a href='https://go.googlesource.com/tools/+/master/godoc/analysis/README'>tools/godoc/analysis/README</a>.
</p>