chiark - git - mdw - mLib/blob - test/tvec-timeout.3.in

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" Manual for test timeouts
   4 .\"
   5 .\" (c) 2024 Straylight/Edgeware
   6 .\"
   7 .
   8 .\"----- Licensing notice ---------------------------------------------------
   9 .\"
  10 .\" This file is part of the mLib utilities library.
  11 .\"
  12 .\" mLib is free software: you can redistribute it and/or modify it under
  13 .\" the terms of the GNU Library General Public License as published by
  14 .\" the Free Software Foundation; either version 2 of the License, or (at
  15 .\" your option) any later version.
  16 .\"
  17 .\" mLib is distributed in the hope that it will be useful, but WITHOUT
  18 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 .\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  20 .\" License for more details.
  21 .\"
  22 .\" You should have received a copy of the GNU Library General Public
  23 .\" License along with mLib.  If not, write to the Free Software
  24 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  25 .\" USA.
  26 .
  27 .\"--------------------------------------------------------------------------
  28 .so ../defs.man \" @@@PRE@@@
  29 .
  30 .\"--------------------------------------------------------------------------
  31 .TH tvec-timeout 3mLib "11 March 2024" "Straylight/Edgeware" "mLib utilities library"
  32 .\" @TVEC_TIMEOUTENV
  33 .\" @TVEC_TIMEOUTINIT
  34 .
  35 .\"--------------------------------------------------------------------------
  36 .SH NAME
  37 tvec-timeout \- test vector framework timeouts
  38 .
  39 .\"--------------------------------------------------------------------------
  40 .SH SYNOPSIS
  41 .
  42 .nf
  43 .B "#include <mLib/tvec-timeout.h>"
  44 .PP
  45 .ta 2n
  46 .B "struct tvec_timeoutenv {"
  47 .B "    struct tvec_env _env;"
  48 .B "    int timer;"
  49 .B "    double t;"
  50 .B "    const struct tvec_env *env;"
  51 .B "};"
  52 .B "#define TVEC_TIMEOUTENV ..."
  53 .BI "#define TVEC_TIMEOUTINIT(" timer ", " t ") ..."
  54 .fi