BSP Developer's Guide

VxWorks 5.5
BSP Developer’s Guide
Specific requirements for BSPs are in 9.4 Subsections, p.183.
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.
Separate sentences by two spaces.
Punctuation
■
■
■
Always use a colon after the phrase or sentence introducing an example,
display, itemized list, or table.
A comma should always precede the conjunction and, or, or nor when it
separates the last of a series of three or more words or phrases. This comma
is not optional. For example:
apples, oranges, and bananas
Avoid the use of quotation marks. If they are necessary, form quotations using
the straight double-quote ( " ) only. Use single quotes only as described in
Special Elements, p.180. Do not create quotations with the old troff convention
of double back-quotes and apostrophes.
Word Usage
■
■
■
■
Do not use capital letters to convey emphasis; use italics. For information on
how to apply font changes, see Table 9-3. In general, avoid applying italics for
emphasis—the best way to convey emphasis is a well cast sentence.
Do not use the word so to mean thus or therefore. However, the construction so
that is acceptable.
Do not use contractions (don’t, doesn’t, can’t, and so on).
Do not exclude articles (the, a, an) for brevity.
174