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>
@@ -17,19 +17,17 @@
.\" "
.\" " CDDL HEADER END
.\" "
.\" "Copyright 2009 Sun Microsystems, Inc. All rights reserved."
.\" "Use is subject to license terms."
-.TH xref 1ONBLD "10 Aug 2009"
+.TH XREF 1ONBLD "Aug 10, 2009"
.SH NAME
.I xref
\- build and maintain source cross-references
.SH SYNOPSIS
\fBxref [-cfp] [-m <makefile>] [-x cscope|ctags|etags[,...]] [<subtree> ...]\fP
-.LP
.SH DESCRIPTION
-.IX "OS-Net build tools" "xref" "" "\fBxref\fP"
.LP
.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
@@ -36,11 +34,13 @@
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:
+.nf
*.[Ccdshlxy] Makefile* *.il* *.cc llib-* *.xml *.dtd.* *.ndl
+.fi
However, this default behavior can be changed, either through command-line
options or by setting the cross-reference customization macros (see
\fICUSTOMIZATION MACROS\fP) in the Makefile rooted at each specified
subtree.
@@ -141,18 +141,16 @@
$ cd $SRC
$ cat > /tmp/zfs.mk
XRDIRS=uts/common/fs/zfs common/zfs lib/libzfs cmd/zfs cmd/zpool
.fi
$ xref -f -x cscope -m /tmp/zfs.mk
-.LP
.SH ENVIRONMENT VARIABLES
Because xref uses xref.mk to carry out the requested operations and
invokes make(1) with the -e option, the value of any macros used by
xref.mk can be overridden through environment variables. This is
chiefly useful for customizing the programs used to build the cross
references; see \fIEXAMPLES\fP.
-.LP
.SH SEE ALSO
.LP
.IR make(1),
.IR bringover(1ONBLD)
.IR flg.flp(1ONBLD)