WARNING: this is an Alpha release - new features and changes are not
reflected in the documentation.
-Build Instructions
-==================
-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
- recommended.
- o gmake, the GNU make utility. If you don't have gmake installed on your
- system, download it from prep.ai.mit.edu.
- o standard Unix tools: gzip, tar
+ 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.
-You should also have:
+ To build Splint you need:
- 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.
+ a (hopefully ANSI-conforming) C compiler. GNU gcc is recommended, but most modern C compilers should work.
+ make, the GNU make utility. If you don't have make installed on your system, download it from ftp.gnu.org.
+ standard Unix tools: gzip, tar
-If these are unavailable, you may be able to build Splint anyway using
-the derived grammar files. This is not recommended however.
+ Instructions:
-1. Download the Splint source package (splint-<version>.src.tgz).
+ 1.Download http://www.splint.org/downloads/splint-3.0.1.src.tgz. (the latest stable release).
- Copy this package to the directory where you want to build Splint. When
- the tar file is extracted, it will create an splint-<version> subdirectory.
+ 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.
-2. Extract files from the tar archive:
- tar xzf splint-<version>.src.tgz
+ 2.tar xzf splint-3.0.1.src.tgz (extract files from the archive)
-3. Run: ./configure
-
- This will create a Makefile with settings for your system. If you
- want to install Splint or associated libraries different
- directories, edit the Makefile.
+ 3.cd splint-3.0.1 (enter the extracted directory)
-4. Run: gmake
+ 4.configure
- It is best to do this in an emacs shell or a buffered terminal,
- so you can scroll through the output.
+ This will create a Makefile with settings for your system. Use configure --prefix=directory if you want to install Splint in prefix directory directory.
-6. Set environment variables
+ 5.make
- LARCH_PATH - path to search for splint libraries and
- initializations files. If you are using the standard directories, this
- should be .:<base-directory>/splint-<version>/lib.
+ 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.
- LCLIMPORTDIR - directory containing lcl imports files. If you are using
- the standard directories, this is <base-directory>/splint-<version>/imports.
+ 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:
- 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).
+ subscribe lclint-announce
+
- Set up your PATH to include the directory containing
- splint-<version>/bin/splint, or move the binary to a directory on
- your command path.
+ If the build was successful, it then runs the test suite. You should see:
-7. Run: gmake test
+ Testing splint 3.0.1...
- Examine the test output. If there are errors, send a bug
- report to splint-bug@cs.virginia.edu
+ Version Info:
+ Splint 3.0.1 --- 07 Jan 2002
-To subscribe to announcements of new Splint releases, send a message to
-majordomo@virginia.edu containing the body:
+ Maintainer: splint-bug@cs.virginia.edu
-subscribe lclint-announce
+ ... (about 100 lines of test output elided)
-To participate in discussions related to Splint, send a message to
-majordomo@virginia.edu containing the body:
+ Checking manual...
+ Checking tests2.2...
+ Checking tests2.4...
+ Checking tests2.5...
+ Checking db1...
+ Checking db2...
+ Checking db3...
-subscribe lclint-interest
-
+ Examine the test output. If there are errors, send a bug report to splint-bug@cs.virginia.edu.
+ 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).
+ 6.make install
+ 7.Set environment variables:
+ 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.
+ LCLIMPORTDIR - directory containing lcl imports files. If you are using the standard directories, this is base-directory/splint-3.0.1/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 splint-3.0.1/bin/splint, or move the binary to a directory on your command path.
andersk / splint.git / blobdiff