ghc/CONTRIB/pphs/docs/Error_Messages.tex

   1 \chapter{Error messages given}
   2
   3 The {\tt pphs} program generates error messages to {\tt stderr},
   4 with error codes.  Normal operation of the program will be
   5 indicated by error code {\tt 0}.
   6
   7 \section{\tt Call with one file name}
   8
   9 Error code {\tt 1} is produced when {\tt pphs} is not called with
  10 exactly one filename.  Either no filename was given, or too many
  11 filenames were given.  Call {\tt pphs} again with one filename.
  12
  13 \section{\tt File could not be opened}
  14
  15 Error code {\tt 2} is produced when the filename given when {\tt pphs}
  16 was called could not be opened.  This could be because it did not exist,
  17 or was read-protected.  Call {\tt pphs} again with a filename that exists
  18 and is readable.
  19
  20 \section{\tt Stack is too big}
  21
  22 Error code {\tt 3} is produced when the program has used up too much of
  23 the computer's memory.  It is not possible to run {\tt pphs} on this file
  24 without getting more memory for the computer to use.
  25
  26 \section{\tt Queue is too big}
  27
  28 Error code {\tt 4} is produced when the program has used up too much of
  29 the computer's memory.  It is not possible to run {\tt pphs} on this file
  30 without getting more memory for the computer to use.
  31
  32 \section{\tt Stack underflow}
  33
  34 Error code {\tt 5} is produced when the program attempts to remove an item
  35 from a stack in memory that doesn't exist.  This should not happen in the
  36 {\tt pphs} program.