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>
*** 18,56 ****
.\" CDDL HEADER END
.\"
.\" Copyright 2008 Sun Microsystems, Inc. All rights reserved.
.\" Use is subject to license terms.
.\"
! .TH hdrchk 1ONBLD "02 July 2008"
.SH NAME
hdrchk \- check that header files conform to ON standards
.SH SYNOPSIS
.nf
\fBhdrchk\fR [\fB-a\fP] \fIfile\fR [\fIfile ...\fR]\fP
.fi
- .LP
.SH DESCRIPTION
- .IX "OS-Net build tools" "hdrchk" "" "\fBhdrchk\fP"
.LP
.I hdrchk
verifies that C header files (*.h) conform to the standards of the ON
consolidation.
See HEADER STANDARDS for details.
- .LP
.SH OPTIONS
- .LP
.TP 10
.B -a
Apply (more lenient) application header rules.
- .LP
.SH HEADER STANDARDS
.LP
Standards for all header files:
.TP 4
.B 1.
Begin with a comment containing a copyright message.
- .LP
.TP 4
.B 2.
Enclosed in a guard of the form:
.LP
.nf
--- 18,50 ----
.\" CDDL HEADER END
.\"
.\" Copyright 2008 Sun Microsystems, Inc. All rights reserved.
.\" Use is subject to license terms.
.\"
! .TH HDRCHK 1ONBLD "Jul 02, 2008"
.SH NAME
hdrchk \- check that header files conform to ON standards
.SH SYNOPSIS
.nf
\fBhdrchk\fR [\fB-a\fP] \fIfile\fR [\fIfile ...\fR]\fP
.fi
.SH DESCRIPTION
.LP
.I hdrchk
verifies that C header files (*.h) conform to the standards of the ON
consolidation.
See HEADER STANDARDS for details.
.SH OPTIONS
.TP 10
.B -a
Apply (more lenient) application header rules.
.SH HEADER STANDARDS
.LP
Standards for all header files:
.TP 4
.B 1.
Begin with a comment containing a copyright message.
.TP 4
.B 2.
Enclosed in a guard of the form:
.LP
.nf
*** 61,71 ****
.sp
.RS 4n
The preferred form is without the bang character, but either is
acceptable.
.RE
- .LP
.TP 4
.B 3.
Has a valid ident declaration.
.LP
Additional standards for system header files:
--- 55,64 ----
*** 74,88 ****
The file guard must take the form '_\fBFILENAME\fP_H[_]', where
\fBFILENAME\fP matches the basename of the file.
If it is installed in a subdirectory, it should be of the
form '_\fBDIR\fP_\fBFILENAME\fP_H[_]', though this is not currently enforced.
The form without the trailing underscore is preferred in both cases.
- .LP
.TP 4
.B 2.
All #include directives must use the <> form.
- .LP
.TP 4
.B 3.
If the header file contains anything besides comments and preprocessor
directives, then it must be enclosed in a C++ guard of the form:
.LP
--- 67,79 ----