README (de572d98) README (fc2512cf)
1#
2# This file and its contents are supplied under the terms of the
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 2015 Garrett D'Amore <garrett@damore.org>
1#
2# This file and its contents are supplied under the terms of the
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 2015 Garrett D'Amore <garrett@damore.org>
14# Copyright 2016 Joyent, Inc.
14#
15
16The configuration files in this directory are structured using the
17syntax defined in the ../README file. They make use of the compilation
18environments declared in ../compilation.cfg, and are processed by the
19symbols test.
20
21We have organized the files by header file, that is the tests for symbols

--- 29 unchanged lines hidden (view full) ---

51 this type can be declared when the <header> is included.
52
53value | <name> | <type> | <header> | <envs>
54
55 Tests for a value named <name>, of type <type>. The test attempts to
56 assign the given value to a scratch variable declared with the given
57 type. The value can be a macro or other C symbol.
58
15#
16
17The configuration files in this directory are structured using the
18syntax defined in the ../README file. They make use of the compilation
19environments declared in ../compilation.cfg, and are processed by the
20symbols test.
21
22We have organized the files by header file, that is the tests for symbols

--- 29 unchanged lines hidden (view full) ---

52 this type can be declared when the <header> is included.
53
54value | <name> | <type> | <header> | <envs>
55
56 Tests for a value named <name>, of type <type>. The test attempts to
57 assign the given value to a scratch variable declared with the given
58 type. The value can be a macro or other C symbol.
59
60define | <name> | <value> | <header> | <envs>
61
62 Tests for a definition named <name>. The test verifies that the
63 pre-processor sees the definition. If the <value> entry is not
64 empty then the check also verifies that there is strict equality
65 between the pre-processor value and it. Only strict equality checks
66 are supported at this time.
67
59func | <name> | <type> | <type> [; <type> ]... | <header> | <envs>
60
61 Tests whether a function <name>, returning the first <type>, and
62 taking arguments of following <type> values, is declared. Note that
63 the argument types are separated by semicolons. For varargs style
64 functions, leave out the ... part. For function declarations
65 that have no declared arguments, either void can specified, or
66 the type list can be omitted.
67
68Examples:
69
70 type | size_t | sys/types.h | ALL
71 value | NULL | void * | stdlib.h | ALL
68func | <name> | <type> | <type> [; <type> ]... | <header> | <envs>
69
70 Tests whether a function <name>, returning the first <type>, and
71 taking arguments of following <type> values, is declared. Note that
72 the argument types are separated by semicolons. For varargs style
73 functions, leave out the ... part. For function declarations
74 that have no declared arguments, either void can specified, or
75 the type list can be omitted.
76
77Examples:
78
79 type | size_t | sys/types.h | ALL
80 value | NULL | void * | stdlib.h | ALL
72 func strnlen | int | const char *; int | string.h | ALL
81 define | thread_local | | threads.h | -ALL +C11
82 define | __alignas_is_defined | 1 | threads.h | -ALL +C11
83 func | strnlen | int | const char *; int | string.h | ALL