From abdfca17070f12e0da8391fdd76de7777bacfcf4 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alexis=20Laferri=C3=A8re?= Date: Sun, 15 Jun 2014 14:00:17 -0400 Subject: [PATCH] pep8analysis: add doc to web interface MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Alexis Laferrière --- contrib/pep8analysis/www/index.html | 72 ++++++++++++++++++++++++++++++++++- 1 file changed, 71 insertions(+), 1 deletion(-) diff --git a/contrib/pep8analysis/www/index.html b/contrib/pep8analysis/www/index.html index 1f72b50..cda34f4 100644 --- a/contrib/pep8analysis/www/index.html +++ b/contrib/pep8analysis/www/index.html @@ -88,11 +88,21 @@
-
Loading the tool... This may take some time.
+
+
Description and Usage + +
+
+

This tools finds strange behavior in Pep/8 programs by exploring all detectable execution paths.

+

Upon analyzing a program, this tool reports dead code blocks and data within the execution path. It also detects wrongful use of data such as accessing uninitialized memory, printing a word and reading code.

+

To use: copy-paste your code in the source code block and launch the analysis using the Analyze button.

+
+
+
Pep/8 Source Code
@@ -132,6 +142,66 @@
+ +
+
+
Output Documentation + +
+
+

Line and memory references

+

Shorthand are used in the error messages, some refer directly to the line numbers others to the address in the memory of the running program.

+ + + + + + + + + + + + + + + + + + + + +
ShorthandDescription
web:5Source line 5
L8Source line 8
rA, rXRegisters A, X
m24Memory at address 24 (bytes)
instr@m24Intruction at address 24 (bytes). Usually, this would be the (24/4+1=) 7th instruction, if there is no data blocks. And the 7th line if there is no data blocks or comments.
+ +

Common errors and warnings

+ +

Note that the tool reports possible errors and strange behaviors. For an advanced or expert user, it may raise errors on correct code.

+ + + + + + + + + + + + + + + + + + + + + +
ErrorMeaning
... the CFG may be wrongThe program structure is too complex to analyze. This happens when jumping to dynamic addresses and when using switch statements.
unreachable instructionsThere's dead code.
data in program flowThe program may execute raw data. There's probably a BR missing.
overwriting code at...An instruction writes over an existing instruction (probably your code).
expected "type" in "address", got "something"An instruction uses data with an unexepected type. It may be a CHARO using something other than a char. Or a copy of uninitialized data over an initialized word.
+
+
+
+
-- 1.7.9.5