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>
*** 1,6 ****
! xref(1) User Commands xref(1)
NAME
xref - build and maintain source cross-references
--- 1,6 ----
! xref(1ONBLD) illumos Build Tools xref(1ONBLD)
NAME
xref - build and maintain source cross-references
*** 12,22 ****
DESCRIPTION
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
--- 12,22 ----
DESCRIPTION
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
*** 30,41 ****
assumed to be relative to the current working directory.
OPTIONS
-c Clobber (rather than build) cross-references.
! -f Do not use flg.flp(1) to locate additional related files.
! This option is ignored if -c is specified.
-m makefile
Use the customization macros specified in makefile when
building the cross-reference, rather than those in Makefile.
If no Makefile exists or no customizations are desired, then
--- 30,41 ----
assumed to be relative to the current working directory.
OPTIONS
-c Clobber (rather than build) cross-references.
! -f Do not use flg.flp(1ONBLD) to locate additional related
! files. This option is ignored if -c is specified.
-m makefile
Use the customization macros specified in makefile when
building the cross-reference, rather than those in Makefile.
If no Makefile exists or no customizations are desired, then
*** 96,106 ****
$SRC/cmd/agents:
$ xref $SRC/cmd/agents
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):
$ xref -f -x cscope $SRC
Build just the standard cscope cross-reference for $SRC/uts:
--- 96,106 ----
$SRC/cmd/agents:
$ xref $SRC/cmd/agents
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):
$ xref -f -x cscope $SRC
Build just the standard cscope cross-reference for $SRC/uts:
*** 119,129 ****
xref.mk can be overridden through environment variables. This is
chiefly useful for customizing the programs used to build the cross
references; see EXAMPLES.
SEE ALSO
! make(1), bringover(1), flg.flp(1)
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
--- 119,129 ----
xref.mk can be overridden through environment variables. This is
chiefly useful for customizing the programs used to build the cross
references; see EXAMPLES.
SEE ALSO
! make(1), bringover(1ONBLD) flg.flp(1ONBLD)
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
*** 133,138 ****
to the etags utility. For instance, to use the one included with
SUNWgnu-emacs, set ETAGS to /usr/gnu/bin/etags prior to invoking xref.
! 10 Aug 2009 xref(1)
--- 133,138 ----
to the etags utility. For instance, to use the one included with
SUNWgnu-emacs, set ETAGS to /usr/gnu/bin/etags prior to invoking xref.
! 10 Aug 2009 xref(1ONBLD)