andersk Git - splint.git/blame_incremental

... / ...

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