]>
Commit | Line | Data |
---|---|---|
11db3170 | 1 | Splint Version 3.0.0.20 |
15b3d2b2 | 2 | Alpha Release |
206c5b0f | 3 | 29 December 2001 |
885824d3 | 4 | |
5 | LCLint Documentation | |
6 | ==================== | |
7 | ||
11db3170 | 8 | For documentation on LCLint, please see http://www.splint.org |
885824d3 | 9 | |
15b3d2b2 | 10 | WARNING: this is an Alpha release - new features and changes are not |
11db3170 | 11 | reflected in the documentation. |
15b3d2b2 | 12 | |
885824d3 | 13 | Build Instructions |
14 | ================== | |
15 | ||
11db3170 | 16 | To build Splint you need: |
885824d3 | 17 | |
18 | o a (hopefully ANSI-conforming) C compiler. On most modern Unix systems, | |
19 | cc will work fine. For older or less standard systems, gcc is | |
20 | recommended. | |
21 | o gmake, the GNU make utility. If you don't have gmake installed on your | |
22 | system, download it from prep.ai.mit.edu. | |
23 | o standard Unix tools: gzip, tar | |
24 | ||
68de3f33 | 25 | You should also have: |
885824d3 | 26 | |
68de3f33 | 27 | o flex |
28 | o bison version 1.28 or later - bison 1.27 and 1.25 are believed to | |
11db3170 | 29 | have bugs that cause problems with Splint's parsers. |
68de3f33 | 30 | |
11db3170 | 31 | If these are unavailable, you may be able to build Splint anyway using |
68de3f33 | 32 | the derived grammar files. This is not recommended however. |
885824d3 | 33 | |
11db3170 | 34 | 1. Download the Splint source package (splint-<version>.src.tgz). |
68de3f33 | 35 | |
11db3170 | 36 | Copy this package to the directory where you want to build Splint. When |
37 | the tar file is extracted, it will create an splint-<version> subdirectory. | |
885824d3 | 38 | |
68de3f33 | 39 | 2. Extract files from the tar archive: |
11db3170 | 40 | tar xzf splint-<version>.src.tgz |
885824d3 | 41 | |
68de3f33 | 42 | 3. Run: ./configure |
885824d3 | 43 | |
44 | This will create a Makefile with settings for your system. If you | |
11db3170 | 45 | want to install Splint or associated libraries different |
885824d3 | 46 | directories, edit the Makefile. |
47 | ||
68de3f33 | 48 | 4. Run: gmake |
885824d3 | 49 | |
50 | It is best to do this in an emacs shell or a buffered terminal, | |
51 | so you can scroll through the output. | |
52 | ||
53 | 6. Set environment variables | |
54 | ||
11db3170 | 55 | LARCH_PATH - path to search for splint libraries and |
885824d3 | 56 | initializations files. If you are using the standard directories, this |
11db3170 | 57 | should be .:<base-directory>/splint-3.0.0.9/lib. |
885824d3 | 58 | |
59 | LCLIMPORTDIR - directory containing lcl imports files. If you are using | |
11db3170 | 60 | the standard directories, this is <base-directory>/splint-3.0.0.9/imports. |
885824d3 | 61 | |
62 | Put the commands to set these variables (the actual commands will depend | |
63 | on the shell you are using) in one of your initialization dotfiles | |
64 | (usually ~/.environment). | |
65 | ||
66 | Set up your PATH to include the directory containing | |
11db3170 | 67 | splint-<version>/bin/splint, or move the binary to a directory on |
885824d3 | 68 | your command path. |
69 | ||
70 | 7. Run: gmake test | |
71 | ||
72 | Examine the test output. If there are errors, send a bug | |
11db3170 | 73 | report to splint-bug@cs.virginia.edu |
885824d3 | 74 | |
11db3170 | 75 | To subscribe to announcements of new Splint releases, send a message to |
885824d3 | 76 | majordomo@virginia.edu containing the body: |
77 | ||
78 | subscribe lclint-announce | |
79 | ||
11db3170 | 80 | To participate in discussions related to Splint, send a message to |
885824d3 | 81 | majordomo@virginia.edu containing the body: |
82 | ||
83 | subscribe lclint-interest | |
84 | ||
15b3d2b2 | 85 | |
86 | ||
87 | ||
88 | ||
89 | ||
90 | ||
91 | ||
92 |