contrib/pep8analysis/README.md

   1 # Pep/8 Analysis, static checker to detect bugs and bad programming practices in Pep/8 programs
   2
   3 For more information about the Pep/8 assembly language visit http://code.google.com/p/pep8-1/.
   4
   5 # Installation
   6
   7 Make sure you have a Nit compiler installed (http://nitlanguage.org) and the environment variable NIT\_DIR correctly set to the Nit installation directory.
   8
   9 Clone the source from http://github.com/xymus/pep8analysis.git and compile with `make`.
  10
  11 # Usage
  12
  13 For basic results, execute on the Pep/8 program prog.pep with `bin/pep8analyzer prog.pep`.
  14
  15 Call `bin/pep8analyer --help` for a description of the available (and up to date) options.
  16
  17 The tools provides its results in two ways, the final report and an annotated CFG (usually created in the out directory).
  18
  19 # Analyses
  20
  21 ## Dead code and possible execution of data
  22
  23 The tools analyses statically the program according to possbile branches and function calls to find wrongfully placed instructions and directives. It reports dead code blocks and possibly executed data blocks.
  24
  25 ## Range analysis
  26
  27 The range analysis reports the value of registers and memory on the annotated CFG.
  28
  29 ## Reaching definitions
  30
  31 The reaching definitions analysis tracks what lines may have assigned values to register and memory. Its results are on the anotated CFG. They can be used to better understand a program.
  32
  33 ## Types analysis
  34
  35 The types analysis detects wrongful use of types or of uninitialized data. It reports possible errors in the final report.