Print this page
6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/tools/scripts/hdrchk.1onbld.man.txt
+++ new/usr/src/tools/scripts/hdrchk.1onbld.man.txt
1 -hdrchk(1ONBLD) illumos Build Tools hdrchk(1ONBLD)
1 +HDRCHK(1ONBLD) illumos Build Tools HDRCHK(1ONBLD)
2 2
3 3
4 4
5 5 NAME
6 6 hdrchk - check that header files conform to ON standards
7 7
8 8 SYNOPSIS
9 9 hdrchk [-a] file [file ...]
10 10
11 11 DESCRIPTION
12 12 hdrchk verifies that C header files (*.h) conform to the standards of
13 13 the ON consolidation. See HEADER STANDARDS for details.
14 14
15 15 OPTIONS
16 16 -a Apply (more lenient) application header rules.
17 17
18 18 HEADER STANDARDS
19 19 Standards for all header files:
20 20
21 21 1. Begin with a comment containing a copyright message.
22 22
23 23 2. Enclosed in a guard of the form:
24 24
25 25 #ifndef GUARD
26 26 #define GUARD
27 27 #endif /* [!]GUARD */
28 28
29 29 The preferred form is without the bang character, but either is
30 30 acceptable.
31 31
32 32 3. Has a valid ident declaration.
33 33
34 34 Additional standards for system header files:
35 35
36 36 1. The file guard must take the form '_FILENAME_H[_]', where FILENAME
37 37 matches the basename of the file. If it is installed in a
38 38 subdirectory, it should be of the form '_DIR_FILENAME_H[_]', though
39 39 this is not currently enforced. The form without the trailing
40 40 underscore is preferred in both cases.
41 41
42 42 2. All #include directives must use the <> form.
43 43
44 44 3. If the header file contains anything besides comments and
45 45 preprocessor directives, then it must be enclosed in a C++ guard of
46 46 the form:
47 47
48 48 #ifdef __cplusplus
↓ open down ↓ |
37 lines elided |
↑ open up ↑ |
49 49 extern "C" {
50 50 #endif
51 51
52 52 #ifdef __cplusplus
53 53 }
54 54 #endif
55 55
56 56
57 57
58 58
59 - 02 July 2008 hdrchk(1ONBLD)
59 + July 2, 2008 HDRCHK(1ONBLD)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX