BSP Developer's Guide

9
Documentation Guidelines
The following example demonstrates our general style:
.TS
expand;
l l l .
Column Head 1 | Column Head 2 | Column Head 3
_
Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3
Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3
.TE
Alternatively, in the target.nr file only you can instead use tab characters as the
column separator in place of “|”.
9.5.4 Processing
9
The steps below describe how to generate BSP documentation using the makefiles
based on the templates delivered with the BSP Developer’s Kit.
1. In target/config/bspname, check for the existence of the three required constants
in Makefile:
TARGET_DIR
target directory name (bspname); for example, “mv147”
VENDOR
vendor name; for example, “Motorola”
BOARD
board model name; for example, “MVME147, MVME147S-1”
2. Generate the reference pages by running:
make man
This does the following:
– Builds an appropriate depend.bspname.
– Runs sysLib.c through the C preprocessor to collect any drivers included
by #include directives.
– Runs refgen -mg.
– Distributes HTML reference pages to the appropriate WIND_BASE/docs
directories.
193