]>
Commit | Line | Data |
---|---|---|
146e25eb | 1 | Splint - annotation-assisted static program checker |
2 | http://www.splint.org | |
3 | ||
4 | Copyright (C) 1994-2002 | |
5 | University of Virginia, | |
6 | Massachusetts Institute of Technology | |
7 | ||
1b8ae690 | 8 | Version 3.0.1 |
9 | 7 January 2001 | |
885824d3 | 10 | |
146e25eb | 11 | Splint Documentation |
885824d3 | 12 | ==================== |
13 | ||
146e25eb | 14 | For documentation on Splint, please see http://www.splint.org |
885824d3 | 15 | |
15b3d2b2 | 16 | WARNING: this is an Alpha release - new features and changes are not |
11db3170 | 17 | reflected in the documentation. |
15b3d2b2 | 18 | |
885824d3 | 19 | |
885824d3 | 20 | |
9dcb30d1 | 21 | Splint should compile effortlessly on standard Unix systems, and with a bit of effort on non-Unix platforms. If you produce a port for a non-Unix platform, please let splint@cs.virginia.edu know. |
885824d3 | 22 | |
9dcb30d1 | 23 | To build Splint you need: |
885824d3 | 24 | |
9dcb30d1 | 25 | a (hopefully ANSI-conforming) C compiler. GNU gcc is recommended, but most modern C compilers should work. |
26 | make, the GNU make utility. If you don't have make installed on your system, download it from ftp.gnu.org. | |
27 | standard Unix tools: gzip, tar | |
68de3f33 | 28 | |
9dcb30d1 | 29 | Instructions: |
885824d3 | 30 | |
9dcb30d1 | 31 | 1.Download http://www.splint.org/downloads/splint-3.0.1.src.tgz. (the latest stable release). |
68de3f33 | 32 | |
9dcb30d1 | 33 | Copy this package to the directory where you want to build Spint. When the tar file is extracted, it will create a splint-3.0.1 subdirectory. |
885824d3 | 34 | |
9dcb30d1 | 35 | 2.tar xzf splint-3.0.1.src.tgz (extract files from the archive) |
885824d3 | 36 | |
9dcb30d1 | 37 | 3.cd splint-3.0.1 (enter the extracted directory) |
885824d3 | 38 | |
9dcb30d1 | 39 | 4.configure |
885824d3 | 40 | |
9dcb30d1 | 41 | This will create a Makefile with settings for your system. Use configure --prefix=directory if you want to install Splint in prefix directory directory. |
885824d3 | 42 | |
9dcb30d1 | 43 | 5.make |
885824d3 | 44 | |
9dcb30d1 | 45 | GNU's make utility is required; it may be named gmake or gnumake on your system. It is best to do this in an emacs shell or a buffered terminal, so you can scroll through the output. |
885824d3 | 46 | |
9dcb30d1 | 47 | This builds Splint. While it is building, subscribe to the lclint-announce mailing list by sending a message to majordomo@virginia.edu containing the body: |
885824d3 | 48 | |
9dcb30d1 | 49 | subscribe lclint-announce |
50 | ||
885824d3 | 51 | |
9dcb30d1 | 52 | If the build was successful, it then runs the test suite. You should see: |
885824d3 | 53 | |
9dcb30d1 | 54 | Testing splint 3.0.1... |
885824d3 | 55 | |
9dcb30d1 | 56 | Version Info: |
57 | Splint 3.0.1 --- 07 Jan 2002 | |
885824d3 | 58 | |
9dcb30d1 | 59 | Maintainer: splint-bug@cs.virginia.edu |
885824d3 | 60 | |
9dcb30d1 | 61 | ... (about 100 lines of test output elided) |
885824d3 | 62 | |
9dcb30d1 | 63 | Checking manual... |
64 | Checking tests2.2... | |
65 | Checking tests2.4... | |
66 | Checking tests2.5... | |
67 | Checking db1... | |
68 | Checking db2... | |
69 | Checking db3... | |
885824d3 | 70 | |
9dcb30d1 | 71 | Examine the test output. If there are errors, send a bug report to splint-bug@cs.virginia.edu. |
15b3d2b2 | 72 | |
9dcb30d1 | 73 | The remaining steps are only necessary ff you want to install the Splint binary and libraries in a different directory (set when you ran configure). |
15b3d2b2 | 74 | |
9dcb30d1 | 75 | 6.make install |
76 | 7.Set environment variables: | |
15b3d2b2 | 77 | |
9dcb30d1 | 78 | LARCH_PATH - path to search for splint libraries and initializations files. If you are using the standard directories, this should be .:base-directory/splint-3.0.1/lib. |
15b3d2b2 | 79 | |
9dcb30d1 | 80 | LCLIMPORTDIR - directory containing lcl imports files. If you are using the standard directories, this is base-directory/splint-3.0.1/imports. |
81 | ||
82 | 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). | |
83 | ||
84 | Set up your PATH to include the directory containing splint-3.0.1/bin/splint, or move the binary to a directory on your command path. | |
15b3d2b2 | 85 | |
86 | ||
87 | ||
88 |