Print this page
6205 onbld manuals should be declared as 1onbld
Reviewed by: Dan McDonald <danmcd@omniti.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>
*** 17,27 ****
.\" "
.\" " CDDL HEADER END
.\" "
.\" "Copyright 2009 Sun Microsystems, Inc. All rights reserved."
.\" "Use is subject to license terms."
! .TH xref 1 "10 Aug 2009"
.SH NAME
.I xref
\- build and maintain source cross-references
.SH SYNOPSIS
\fBxref [-cfp] [-m <makefile>] [-x cscope|ctags|etags[,...]] [<subtree> ...]\fP
--- 17,27 ----
.\" "
.\" " CDDL HEADER END
.\" "
.\" "Copyright 2009 Sun Microsystems, Inc. All rights reserved."
.\" "Use is subject to license terms."
! .TH xref 1ONBLD "10 Aug 2009"
.SH NAME
.I xref
\- build and maintain source cross-references
.SH SYNOPSIS
\fBxref [-cfp] [-m <makefile>] [-x cscope|ctags|etags[,...]] [<subtree> ...]\fP
*** 32,42 ****
.I xref
is a simple tool for building and maintaining source cross-references for
subtrees of a workspace. By default, xref builds cscope-fast, ctags, and
etags (if available; see NOTES) source cross-references for all of the
eligible files underneath each named subtree, plus any additional eligible
! files reported by flg.flp(1). File eligibility is determined by pattern
matching -- by default, files matching the following patterns are
eligible:
*.[Ccdshlxy] Makefile* *.il* *.cc llib-* *.xml *.dtd.* *.ndl
--- 32,42 ----
.I xref
is a simple tool for building and maintaining source cross-references for
subtrees of a workspace. By default, xref builds cscope-fast, ctags, and
etags (if available; see NOTES) source cross-references for all of the
eligible files underneath each named subtree, plus any additional eligible
! files reported by flg.flp(1ONBLD). File eligibility is determined by pattern
matching -- by default, files matching the following patterns are
eligible:
*.[Ccdshlxy] Makefile* *.il* *.cc llib-* *.xml *.dtd.* *.ndl
*** 52,62 ****
.TP 10
.B -c
Clobber (rather than build) cross-references.
.TP 10
.B -f
! Do not use flg.flp(1) to locate additional related files. This option is
ignored if \fB-c\fP is specified.
.TP
.B -m \fImakefile\fP
Use the customization macros specified in \fImakefile\fP when building the
cross-reference, rather than those in Makefile. If no Makefile exists
--- 52,62 ----
.TP 10
.B -c
Clobber (rather than build) cross-references.
.TP 10
.B -f
! Do not use flg.flp(1ONBLD) to locate additional related files. This option is
ignored if \fB-c\fP is specified.
.TP
.B -m \fImakefile\fP
Use the customization macros specified in \fImakefile\fP when building the
cross-reference, rather than those in Makefile. If no Makefile exists
*** 125,135 ****
Build cscope-fast, ctags, and etags cross-references for $SRC/cmd/agents:
.LP
$ xref $SRC/cmd/agents
.LP
Build just the cscope-fast cross-reference for $SRC, and do not use
! flg.flp(1) (since there are no additional source files to find):
.LP
$ xref -f -x cscope $SRC
.LP
Build just the standard cscope cross-reference for $SRC/uts:
.LP
--- 125,135 ----
Build cscope-fast, ctags, and etags cross-references for $SRC/cmd/agents:
.LP
$ xref $SRC/cmd/agents
.LP
Build just the cscope-fast cross-reference for $SRC, and do not use
! flg.flp(1ONBLD) (since there are no additional source files to find):
.LP
$ xref -f -x cscope $SRC
.LP
Build just the standard cscope cross-reference for $SRC/uts:
.LP
*** 152,163 ****
references; see \fIEXAMPLES\fP.
.LP
.SH SEE ALSO
.LP
.IR make(1),
! .IR bringover(1),
! .IR flg.flp(1)
.SH NOTES
The etags utility is no longer bundled with the Sun Studio, which
means it may not be available on all developer systems. If xref cannot
locate the etags utility and the -x option has not been specified, then
xref will silently not build etags.
--- 152,163 ----
references; see \fIEXAMPLES\fP.
.LP
.SH SEE ALSO
.LP
.IR make(1),
! .IR bringover(1ONBLD)
! .IR flg.flp(1ONBLD)
.SH NOTES
The etags utility is no longer bundled with the Sun Studio, which
means it may not be available on all developer systems. If xref cannot
locate the etags utility and the -x option has not been specified, then
xref will silently not build etags.