X-Git-Url: http://nitlanguage.org diff --git a/contrib/pep8analysis/www/index.html b/contrib/pep8analysis/www/index.html index 1f72b50..045087f 100644 --- a/contrib/pep8analysis/www/index.html +++ b/contrib/pep8analysis/www/index.html @@ -14,41 +14,91 @@ + @@ -71,16 +127,20 @@ - Pep/8 Analysis + Xymus.net
@@ -88,11 +148,25 @@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 program button.
+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.
+Shorthand | +Description | +
---|---|
web:5 | +Source line 5 | +
L8 | +Source line 8 | +
rA, rX | +Registers A, X | +
m24 | +Memory at address 24 (bytes) | +
instr@m24 | +Intruction 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. | +
Note that the tool reports possible errors and strange behaviors. For an advanced or expert user, it may raise errors on correct code.
+ +Error | +Meaning | +
---|---|
... the CFG may be wrong | +The program structure is too complex to analyze. This happens when jumping to dynamic addresses and when using switch statements. | +
unreachable instructions | +There's dead code. | +
data in program flow | +The 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.+ |
+