Some work on the files in os2/, removed unnecessary

[splint.git] / os2 / README.OS2

lclint 3.0.0.16 for OS/2\r
========================\r
\r
This file is originally part of the binary distribution of lclint for OS/2.\r
\r
Contents:\r
---------\r
\r
 Differences to the Unix versions\r
 Installation\r
 Bugs and known problems\r
 Where to get\r
 History\r
 Afterword\r
\r
\r
Differences to the Unix versions:\r
---------------------------------\r
\r
1. lclint searches for the initialization file in the current directory \r
   and additionally in the directory pointed to by the environment \r
   variable "HOME" if set. \r
\r
2. For path specifications "\" can be used instead of "/". In most\r
   cases any of both, even in combination are fine.\r
\r
3. lclint/2 will use the value of the environment variable TMP (if not set\r
   TEMP) for creating and reading temporary files if possible. Else the\r
   current directory is used.\r
\r
\r
Installation:\r
-------------\r
\r
For installing lclint there are four steps necessary:\r
\r
1. Place the executable file lclint.exe in some directory in your PATH.\r
2. Install all that's in the "imports" and "lib" subdirectories somewhere\r
   you like it. You will need a HPFS drive to install these files.\r
3. Set the environment variable LARCH_PATH to the `lib' subdir in the \r
   main LCLint directory, like:\r
     set LARCH_PATH=d:\software\lclint-3.0.0.16\lib\r
   Then set LCLIMPORTDIR to the `imports' subdir in the main LCLint\r
   directory, like:\r
     set LCLIMPORTDIR=d:\software\lclint-3.0.0.16\imports\r
   You may want to add these statements to your your config.sys file \r
   as soon as you've got the software working. \r
4. If you want to use some standard settings different from what's built\r
   in edit and place the configuration file `.lclintrc' somewhere lclint \r
   can find it. This is the directory pointed to by the HOME environment\r
   variable if set or else the directory containing the executable file.\r
   It seems a good idea to put all global stuff into that file and all\r
   project dependent information into another `.lclintrc' in the directory\r
   containing the sources to be checked by lclint. lclint will first\r
   read the global and then the local `.lclintrc'.\r
\r
For building lclint you will need the complete sources package. Untar that\r
file. You need HPFS to compile the package because there are plenty of \r
files with long filenames. Refer to the file BUILD.OS2 for further \r
instructions. \r
\r
\r
Bugs and known problems:\r
------------------------\r
\r
There are a few things that still do not work properly. As lclint was\r
originally developed on and for Unix systems e.g. path names differ.\r
Currently all paths specified in the command line have to contain\r
backslashes rather than slashes which will be quite normal for people\r
with no Unix background anyway. Also not all tests work well yet, at\r
the moment only the "quicktest" with a few changes is available.\r
\r
\r
Where to get:\r
-------------\r
\r
In any case future versions of lclint for OS/2 will be available from the\r
lclint homepage at:\r
 - http://lclint.cs.virginia.edu/\r
\r
I will try to upload the file to at least the following sites (the file \r
should be located somewhere in the OS2/DEVELOP areas):\r
 - ftp.cdrom.com\r
 - ftp.hobbes.nmsu.edu\r
 - ftp.leo.org\r
I always put any fixes (even unofficial ones) to my private ftp directory\r
at:\r
 - ftp.fh-wedel.de/pub/fh-wedel/staff/herbert/lclint\r
\r
\r
History:\r
--------\r
\r
The following things specific to the OS/2 version of lclint have changed / \r
fixed since the first official release:\r
\r
version 3.0.0.16:\r
- Finally fully united the OS/2 port with the main source tree.\r
- Bugfixes.\r
\r
version 3.0.0.14:\r
- first OS/2 version of the current alpha.\r
- changed the name of the initialization file to `.lclintrc'.\r
\r
version 2.5m:\r
- only some fixes mostly derived from the Win32 port.\r
\r
version 2.4b:\r
- First official OS/2 release.\r
- Switched from IBM's CSet++ 2.01 to VisualAge C++ 3.0.\r
\r
version 2.3i:\r
- Due to my mistake the "HOME" environment variable was ignored even if it \r
  was set.\r
\r
version 2.3h:\r
- IBM's CSet++ is now used as default compiler instead of emx/gcc.\r
- lclint compiled as a.out binary using emx/gcc now runs fine under DOS.\r
- In the previous release some temporary files did not get removed properly.\r
- Sometimes lclint delivered the names of temporary files rather than the\r
  original source files when reporting errors.\r
- Sometimes include files were not found.\r
\r
\r
Due to the differences between Unix and OS/2 (file-I/O, standard directory\r
structures etc.) there are still some more to expect!\r
\r
\r
Afterword:\r
----------\r
\r
I have not yet fully ported Makfiles / scripts for a full-featured test\r
suite. The simple Makefile.os2 in the test/ directory allows checking\r
the C sources belonging to the suite and looking at the output (or \r
directing it to a file using "make -f Makefile.os2 >test.log 2>&1" or\r
something similar. \r
\r
After having used lclint/2 on a few projects now I may say it has got \r
more reliable. Still I do not know enough about it yet to be able to do  \r
more sophisticated testing than just using it for my sources or running\r
the (simplified) test suite. If you run across any OS/2-specific problems \r
write me an email -- I will *try* to fix it. But, please, do not forget \r
that I am *not* the author of lclint!\r
\r
You can reach me via Email or fido-netmail:\r
\r
Email: herbert@paulina.shnet.org (at home)\r
       herbert@fh-wedel.de (at work)\r
Fido:  2:240/5216.18\r
\r
Have fun!\r
\r
Martin "Herbert" Dietze\r