RAM 6.0 BUX II Series Uživatelská příručka stáhnout pdf (Strana 146)

VxWorks

BSP Developer’s Guide, 6.0

138

B.1 Introduction

Reference documentation for Wind River board support packages (BSPs) consists

of UNIX-style reference entries (formerly known as man pages) for the module

sysLib.c and the file target.ref. Documentation in HTML format is generated from

these files with the Wind River tool apigen. During a BSP build, make runs apigen

and places the HTML output in the docs directory of your installation. The

resulting reference entries can be displayed online with an HTML browser.

This chapter covers Wind River conventions for style and format, and the

procedures for generating BSP documentation. The BSP templates supplied with

the VxWorks provide examples of the writing style, text format, module layout,

and text commands discussed throughout this chapter.

Modules formatted with the conventions discussed here will be compatible with

all Wind River documentation markup and formatting scripts. This is a

requirement for BSPs that are turned over to Wind River for distribution.

B.2 Written Style

This section describes a few of the general requirements for written style in Wind

River technical publications. The items that follow are only a portion of the

standards described in Wind River’s style guide, but are chosen for inclusion here

based on their frequent misuse.

Specific requirements for BSPs are in B.3 Sections for Libraries and Subroutines, p.145,

and B.4 Sections for target.ref, p.153.

Sentences

■

Keep sentences brief and to the point, presenting information in a simple,

straightforward manner.

■

Always use complete sentences.

■

Keep sentences in present tense. Do not use future or past tense unless they are

necessary to convey the idea.

■

Do not use abbreviated English—do not exclude articles (the, a, an) for brevity.

1 2 ... 141 142 143 144 145 146 147 148 149 150 151 ... 188 189

Žádné komentáře

RAM 6.0 BUX II Series Uživatelská příručka Strana 146