os2/README.OS2

   1 splint 3.1.1 for OS/2\r
   2 =====================\r
   3 \r
   4 This file is originally part of the binary distribution of splint for OS/2.\r
   5 \r
   6 Contents:\r
   7 ---------\r
   8 \r
   9  Differences to the Unix versions\r
  10  Installation\r
  11  Bugs and known problems\r
  12  Where to get\r
  13  History\r
  14  Afterword\r
  15 \r
  16 \r
  17 Differences to the Unix versions:\r
  18 ---------------------------------\r
  19 \r
  20 1. splint searches for the initialization file in the current directory \r
  21    and additionally in the directory pointed to by the environment \r
  22    variable "HOME" if set. \r
  23 \r
  24 2. For path specifications "\" can be used instead of "/". In most\r
  25    cases any of both, even in combination are fine.\r
  26 \r
  27 3. splint/2 will use the value of the environment variable TMP (if not set\r
  28    TEMP) for creating and reading temporary files if possible. Else the\r
  29    current directory is used.\r
  30 \r
  31 \r
  32 Installation:\r
  33 -------------\r
  34 \r
  35 For installing splint there are four steps necessary:\r
  36 \r
  37 1. Place the executable file splint.exe in some directory in your PATH.\r
  38 2. Install all that's in the "imports" and "lib" subdirectories somewhere\r
  39    you like it. You will need a HPFS drive to install these files.\r
  40 3. Set the environment variable LARCH_PATH to the `lib' subdir in the \r
  41    main splint directory, like:\r
  42      set LARCH_PATH=d:\software\splint-3.0.0.16\lib\r
  43    Then set LCLIMPORTDIR to the `imports' subdir in the main splint\r
  44    directory, like:\r
  45      set LCLIMPORTDIR=d:\software\splint-3.0.0.16\imports\r
  46    You may want to add these statements to your your config.sys file \r
  47    as soon as you've got the software working. \r
  48 4. If you want to use some standard settings different from what's built\r
  49    in edit and place the configuration file `.splintrc' somewhere splint \r
  50    can find it. This is the directory pointed to by the HOME environment\r
  51    variable if set or else the directory containing the executable file.\r
  52    It seems a good idea to put all global stuff into that file and all\r
  53    project dependent information into another `.splintrc' in the directory\r
  54    containing the sources to be checked by splint. splint will first\r
  55    read the global and then the local `.splintrc'.\r
  56 \r
  57 For building splint you will need the complete sources package. Untar that\r
  58 file. You need HPFS to compile the package because there are plenty of \r
  59 files with long filenames. Refer to the file BUILD.OS2 for further \r
  60 instructions. \r
  61 \r
  62 \r
  63 Bugs and known problems:\r
  64 ------------------------\r
  65 \r
  66 There are a few things that still do not work properly. As splint was\r
  67 originally developed on and for Unix systems e.g. path names differ.\r
  68 Currently all paths specified in the command line have to contain\r
  69 backslashes rather than slashes which will be quite normal for people\r
  70 with no Unix background anyway. Also not all tests work well yet, at\r
  71 the moment only the "quicktest" with a few changes is available.\r
  72 \r
  73 \r
  74 Where to get:\r
  75 -------------\r
  76 \r
  77 In any case future versions of splint for OS/2 will be available from the\r
  78 splint homepage at:\r
  79  - http://splint.cs.virginia.edu/\r
  80 \r
  81 I will try to upload the file to at least the following sites (the file \r
  82 should be located somewhere in the OS2/DEVELOP areas):\r
  83  - ftp.cdrom.com\r
  84  - ftp.hobbes.nmsu.edu\r
  85  - ftp.leo.org\r
  86 I always put any fixes (even unofficial ones) to my private ftp directory\r
  87 at:\r
  88  - ftp.fh-wedel.de/pub/fh-wedel/staff/herbert/splint\r
  89 \r
  90 \r
  91 History:\r
  92 --------\r
  93 \r
  94 The following things specific to the OS/2 version of splint have changed / \r
  95 fixed since the first official release:\r
  96 \r
  97 version 3.1.1\r
  98 - Set the default system directory to `/os2/'.\r
  99 - Bugfixes.\r
 100 \r
 101 version 3.0.0.16:\r
 102 - Finally fully united the OS/2 port with the main source tree.\r
 103 - Bugfixes.\r
 104 \r
 105 version 3.0.0.14:\r
 106 - first OS/2 version of the current alpha.\r
 107 - changed the name of the initialization file to `.splintrc'.\r
 108 \r
 109 version 2.5m:\r
 110 - only some fixes mostly derived from the Win32 port.\r
 111 \r
 112 version 2.4b:\r
 113 - First official OS/2 release.\r
 114 - Switched from IBM's CSet++ 2.01 to VisualAge C++ 3.0.\r
 115 \r
 116 version 2.3i:\r
 117 - Due to my mistake the "HOME" environment variable was ignored even if it \r
 118   was set.\r
 119 \r
 120 version 2.3h:\r
 121 - IBM's CSet++ is now used as default compiler instead of emx/gcc.\r
 122 - splint compiled as a.out binary using emx/gcc now runs fine under DOS.\r
 123 - In the previous release some temporary files did not get removed properly.\r
 124 - Sometimes splint delivered the names of temporary files rather than the\r
 125   original source files when reporting errors.\r
 126 - Sometimes include files were not found.\r
 127 \r
 128 \r
 129 Due to the differences between Unix and OS/2 (file-I/O, standard directory\r
 130 structures etc.) there are still some more to expect!\r
 131 \r
 132 \r
 133 Afterword:\r
 134 ----------\r
 135 \r
 136 I have not yet fully ported Makfiles / scripts for a full-featured test\r
 137 suite. The simple Makefile.os2 in the test/ directory allows checking\r
 138 the C sources belonging to the suite and looking at the output (or \r
 139 directing it to a file using "make -f Makefile.os2 >test.log 2>&1" or\r
 140 something similar. \r
 141 \r
 142 After having used splint/2 on a few projects now I may say it has got \r
 143 more reliable. Still I do not know enough about it yet to be able to do  \r
 144 more sophisticated testing than just using it for my sources or running\r
 145 the (simplified) test suite. If you run across any OS/2-specific problems \r
 146 write me an email -- I will *try* to fix it. But, please, do not forget \r
 147 that I am *not* the author of splint!\r
 148 \r
 149 My eMail address is `herbert@spamcop.net'. The first time you write me \r
 150 you'll get an automatically generated mail asking for confirmation. I\r
 151 regret to need this measure, previous addresses were spammed unusable,\r
 152 you know the story.\r
 153 \r
 154 Have fun!\r
 155 \r
 156 Martin "Herbert" Dietze\r
 157 \r