Made some additional changes to the makefile. Now it builds correctly.

[splint.git] / os2 / BUILD.OS2

Building lclint:\r
----------------\r
\r
This file is originally part of the binary distribution of lclint for OS/2.\r
\r
For building lclint for OS/2 you need the complete "original" source\r
package (available e.g. via Dave Evans' lclint homepage) and maybe \r
some more recent patches for the OS/2 version. The LCLint home page\r
is at:\r
\r
  http://lclint.cs.virginia.edu/\r
\r
My fixes can be found at:\r
\r
  http://www.fh-wedel.de/pub/fh-wedel/staff/di/lclint/index.html\r
\r
You may want to set the correct date and version to be written into the \r
lclint.exe binary in the Makefile.os2 file, although it is not strictly \r
necessary. This should be enough to build the program. During make \r
execution then some information will be written to a config file read \r
by the sub makefile in the src/ directory.\r
\r
Use the batch file makeos2.cmd from inside the os2/ directory to build \r
lclint. The options to that batch file are:\r
\r
  makeos2 [--emx|-e|--gcc|-g|--icc|-i|--oldconf|-o|--test|-t|--package|-p]\r
\r
This batch should be called from inside the os2 directory. The options \r
starting with "e" build LCLint using emx/gcc with debug code. The letter \r
"g" stands for gcc using the OMF object format and optimization rather \r
than debug code. For IBMs icc compiler use "i".  Each of the above \r
options will create a new configuration. To continue a build with an \r
existing configuration use "o". Finally "t" runs the "quicktest" part \r
of the test suite (other tests are not yet supported).\r
\r
If you experience problems with the automatic configuration file creation\r
from within Makefile.os2 you may alternatively call makeos2.cmd with the\r
`-o' option and use the existing config.inc file (assuming that you use\r
IBMC, else edit it by hand). In that case you may also want to edit the\r
local_constants.h and herald.h files from this directory to have it match \r
your setup.\r
\r
After building the program you may want to testrun it, using the batch\r
file `run_lclint.cmd' or go through the test suite using `makeos2 -t'. \r
Before that you will need to set the environment variables in the \r
`setenv.cmd' file that is called from the other two batches.\r
\r
Please, be aware that you need the flex library in order to build lclint.\r
As far as I remember the OS/2 version of flex comes with this library for\r
the emx/gcc compiler. If not, you will easily be able to compile it \r
following the instructions from flex'es README.OS2 file.\r
\r
If you want to use IBM's compiler, you will probably not find the lib\r
as easily as the whole flex package has so far only been ported for \r
emx/gcc. However you can compile the lib with IBM's compiler, too. To\r
do this, you will have to get the flex sources from one of the usual \r
ftp sites and compile at least the library. \r
\r
To compile the flex library using IBM's VisualAge C++ compiler, you \r
only need to perform the following steps:\r
\r
- enter the flex source directory.\r
- enter "icc -c -Q -O libmain.c" and "icc -c -Q -O libyywrap.c"\r
- enter "ilib fl.lib" from the command line (the library must not \r
  exist) and "y", "+libmain.obj+libyywrap.obj" and "<enter>" from the \r
  ilib prompt.\r
- copy fl.lib somewhere where it gets found, I suggest "ibmcpp\lib".\r
\r
When using emx/gcc you can either produce code using the OMF object format\r
or use a.out. The latter has the consequence of needing emx.dll to run the \r
binary and under certain circumstances being able to run it under DOS using \r
emx.exe or rsx.exe as DOS extender (you may want to replace the "-g" switch\r
by "-O3" in the compiler settings for optimization rather than debug code)\r
in such a case. \r
\r
To create such a binary override the default settings in the makefile by \r
invoking the following little batch (the default settings for using the \r
a.out format defined in Makefile.os2 do *not* produce an executable that \r
runs under DOS):\r
\r
    @echo off\r
    if exist bin\lclint del bin\lclint\r
    make all -f makefile.os2 "COMPILER=gcc-emx" "CC=gcc -O3" "E="\r
    if errorlevel 1 goto end\r
    cd bin\r
    echo on\r
    emxbind lclint -p\r
    @echo off\r
    cd ..\r
    :end\r
\r
Please be aware that for debugging purposes the a.out format is the best \r
choice. I did not succeed in debugging any single step of lclint using \r
ipmd as it crashed each time I tried to load the lclint executable.\r
\r
The Makefile.os2 is currently configured to use flex and bison to generate \r
some source files. If you do not have these tools on your system you should \r
change the corresponding section to use the .der files shipping with the \r
lclint sources.\r
\r
Herbert in September 2001\r
\r