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