3 # Common Development and Distribution License ("CDDL"), version 1.0.
   4 # You may only use this file in accordance with the terms of version
   5 # 1.0 of the CDDL.
   6 #
   7 # A full copy of the text of the CDDL should have accompanied this
   8 # source.  A copy of the CDDL is also available via the Internet at
   9 # http://www.illumos.org/license/CDDL.
  10 #
  11 
  12 #
  13 # Copyright 2014 Garrett D'Amore <garrett@damore.org>
  14 #
  15 
  16 The configuration files in this directory are structured as lines,
  17 where each line is made up of fields, separated by "|" characters,
  18 possibly surrounded by whitespace.
  19 
  20 New lines preceeded by backslashes are ignored, allowing for a continuation
  21 of lines, in the usual UNIX way.
  22 
  23 A line beginning with a hashmark is comment, and is ignore, as are lines
  24 consisting solely of whitespace.
  25 
  26 The first field is always the "keyword", which determines the meaning and
  27 presence of any other fields.
  28 
  29 These files are parsed using the test_load_config() function.  This
  30 function has the following prototype:
  31 
  32         int test_load_config(test_t, const char *, ...);
  33 
  34 The variable arguments are the keywords and handling functions.  These
  35 must be supplied in pairs and the list is terminated with a NULL, like this:
  36 
  37         test_config_load(t, "myfile.cfg", "mykeyword", keywordcb, NULL);
  38 
  39 The test_config_load function will search for the named file (provided it
  40 is not an absolute path) in a few locations:
  41 
  42         * relative to the current directory, exactly as specified
  43         * relative to $STF_SUITE/cfg/   (if $STF_SUITE is defined)

   3 # Common Development and Distribution License ("CDDL"), version 1.0.
   4 # You may only use this file in accordance with the terms of version
   5 # 1.0 of the CDDL.
   6 #
   7 # A full copy of the text of the CDDL should have accompanied this
   8 # source.  A copy of the CDDL is also available via the Internet at
   9 # http://www.illumos.org/license/CDDL.
  10 #
  11 
  12 #
  13 # Copyright 2014 Garrett D'Amore <garrett@damore.org>
  14 #
  15 
  16 The configuration files in this directory are structured as lines,
  17 where each line is made up of fields, separated by "|" characters,
  18 possibly surrounded by whitespace.
  19 
  20 New lines preceeded by backslashes are ignored, allowing for a continuation
  21 of lines, in the usual UNIX way.
  22 
  23 A line beginning with a hashmark is a comment, and is ignored, as are lines
  24 consisting solely of whitespace.
  25 
  26 The first field is always the "keyword", which determines the meaning and
  27 presence of any other fields.
  28 
  29 These files are parsed using the test_load_config() function.  This
  30 function has the following prototype:
  31 
  32         int test_load_config(test_t, const char *, ...);
  33 
  34 The variable arguments are the keywords and handling functions.  These
  35 must be supplied in pairs and the list is terminated with a NULL, like this:
  36 
  37         test_config_load(t, "myfile.cfg", "mykeyword", keywordcb, NULL);
  38 
  39 The test_config_load function will search for the named file (provided it
  40 is not an absolute path) in a few locations:
  41 
  42         * relative to the current directory, exactly as specified
  43         * relative to $STF_SUITE/cfg/   (if $STF_SUITE is defined)