User`s guide

VxWorks
BSP Developer’s Guide, 6.0
172
and model of the board. For example: mv2603 = Motorola MVME2603. The
files relevant to documentation are:
Makefile
Master makefile for building BSP and VxWorks modules. Three constants
must be defined for documentation:
TARGET_DIR, VENDOR, and BOARD.
See Processing, p.173, for more information.
sysLib.c
Library of board-dependent C routines.
target.ref
Source for the target-information reference entry, containing general
information about a board’s installation requirements or capabilities as
they relate to VxWorks. Note that this file replaces the target.nr file of
previous releases; however, BSP makefiles beginning with VxWorks 5.5
can also recognize and process target.nr files for backward compatibility.
If both files exist, the make system gives precedence to target.ref.
docs/.../bspname
The generated HTML reference-entry files for BSPs are output to the
docs/extensions/eclipse/plugins/com.windriver.ide.doc.vxworks_6.0/
vxworks_bsp_api_reference_6.0/bspname directory for VxWorks 6.0 (or
the docs/vxworks/bsp/bspname directory in VxWorks 5.5). All files are
generated from the source files in target/config/bspname by the make
process, which runs apigen (or refgen -mg for VxWorks 5.5). The files are:
bspname.html
Target-information reference entry generated from target.ref (or
target.nr). As shown in the following example, you must include
/target.ref after bspname to generate this file correctly:
\" bspname/target.ref - BSP target specific documentation
sysLib.html
Reference entry for sysLib.c.
libIndex.html
Index of the BSP’s library-level reference entries.
rtnIndex.html
Index of the BSP’s routine reference entries.
sysTffs.html (optional, VxWorks 6.0 only)
Reference entries for TrueFFS, if installed.