X-Git-Url: http://andersk.mit.edu/gitweb/splint.git/blobdiff_plain/15b3d2b27a3dce7a3b65e88fb0d1732e235117f4..dcdc46c89f1cdcf06352c1da08f2e4e3accfb373:/README?ds=sidebyside diff --git a/README b/README index bf5a4c4..6081398 100644 --- a/README +++ b/README @@ -1,20 +1,26 @@ - LCLint Version 3.0.0.9 + Splint - annotation-assisted static program checker + http://www.splint.org + + Copyright (C) 1994-2002 + University of Virginia, + Massachusetts Institute of Technology + + Version 3.0.0.20 Alpha Release - 19 August 2001 + 30 December 2001 -LCLint Documentation +Splint Documentation ==================== -For documentation on LCLint, please see http://lclint.cs.virginia.edu. +For documentation on Splint, please see http://www.splint.org WARNING: this is an Alpha release - new features and changes are not -reflected in the documentation. The file BUFFERCHECKING contains -preliminary documentation on the array bounds checking. +reflected in the documentation. Build Instructions ================== -To build LCLint you need: +To build Splint you need: o a (hopefully ANSI-conforming) C compiler. On most modern Unix systems, cc will work fine. For older or less standard systems, gcc is @@ -23,56 +29,62 @@ To build LCLint you need: system, download it from prep.ai.mit.edu. o standard Unix tools: gzip, tar -1. Download the LCLint source package (lclint.src.tar.gz). +You should also have: - Copy this package to the directory where you want to build LCLint. When - the tar file is extracted, it will create an lclint-3.0.0.9 subdirectory. + o flex + o bison version 1.28 or later - bison 1.27 and 1.25 are believed to + have bugs that cause problems with Splint's parsers. -2. Uncompress the package: - gzip -d lclint.src.tar.gz +If these are unavailable, you may be able to build Splint anyway using +the derived grammar files. This is not recommended however. -3. Extract files from the tar archive: - tar xf lclint.src.tar +1. Download the Splint source package (splint-.src.tgz). -4. Run: configure + Copy this package to the directory where you want to build Splint. When + the tar file is extracted, it will create an splint- subdirectory. + +2. Extract files from the tar archive: + tar xzf splint-.src.tgz + +3. Run: ./configure This will create a Makefile with settings for your system. If you - want to install LCLint or associated libraries different + want to install Splint or associated libraries different directories, edit the Makefile. -5. Run: gmake +4. Run: gmake It is best to do this in an emacs shell or a buffered terminal, so you can scroll through the output. 6. Set environment variables - LARCH_PATH - path to search for lclint libraries and + LARCH_PATH - path to search for splint libraries and initializations files. If you are using the standard directories, this - should be .:/lclint-3.0.0.9/lib. + should be .:/splint-3.0.0.20/lib. LCLIMPORTDIR - directory containing lcl imports files. If you are using - the standard directories, this is /lclint-3.0.0.9/imports. + the standard directories, this is /splint-3.0.0.20/imports. Put the commands to set these variables (the actual commands will depend on the shell you are using) in one of your initialization dotfiles (usually ~/.environment). Set up your PATH to include the directory containing - lclint-3.0.0.9/bin/lclint, or move the binary to a directory on + splint-/bin/splint, or move the binary to a directory on your command path. 7. Run: gmake test Examine the test output. If there are errors, send a bug - report to lclint-bug@cs.virginia.edu + report to splint-bug@cs.virginia.edu -To subscribe to announcements of new lclint releases, send a message to +To subscribe to announcements of new Splint releases, send a message to majordomo@virginia.edu containing the body: subscribe lclint-announce -To participate in discussions related to lclint, send a message to +To participate in discussions related to Splint, send a message to majordomo@virginia.edu containing the body: subscribe lclint-interest