RAM 6.0 BUX II Series Guía de usuario descargar pdf (Pagina 181)

B Documentation Guidelines

B.8 Generating Reference Entries

173

Tools

host/host/bin/apigen

The apigen tool is a Perl script (refgen is a Tcl script) that generates HTML files

from specially formatted source code, which may be C language modules,

assembly language modules, target.ref files, or target.nr files. The

command-line syntax and options for apigen are summarized in the reference

entry.

Processing

The steps below describe how to generate BSP documentation using the makefiles

based on the templates delivered with the VxWorks.

1. In target/config/bspname, check for the existence of the three required

constants in Makefile:

TARGET_DIR

target directory name (bspname). For example: “mv2603”

VENDOR

vendor name. For example: “Motorola”

BOARD

board model name. For example: “MVME2600”

2. Generate the reference entries by running the following command in the BSP

directory:

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 sysTffs.c through the C preprocessor (if applicable).

–Runs apigen (or refgen -mg) on sysLib.c (output of the previous step) and

target.ref (or target.nr if no target.ref is present).

– Distributes HTML reference entries to the appropriate docs directories.

NOTE: refgen requires the -mg option for backward compatibility in case there

are files with old-style nroff markup.

1 2 ... 176 177 178 179 180 181 182 183 184 185 186 187 188 189

Sin comentarios

RAM 6.0 BUX II Series Guía de usuario Pagina 181