Notation Conventions - Analog Devices VisualDSP++ 5.0 Service Manual

Data sheets, which can be downloaded from the Analog Devices Web site,
change rapidly, and therefore are not included on the technical library
CD. Technical manuals change periodically. Check the Web site for the
latest manual revisions and associated documentation errata.

Notation Conventions

Text conventions used in this manual are identified and described as fol-
lows. Note that additional conventions, which apply only to specific
chapters, may appear throughout this document.
Example
{this | that}
[this | that]
[this,...]
.
SECTION
filename
VisualDSP++ 5.0 Device Drivers and System
Services Manual for Blackfin Processors
Description
Alternative required items in syntax descriptions appear within curly
brackets and separated by vertical bars; read the example as
. One or the other is required.
that
Optional items in syntax descriptions appear within brackets and
separated by vertical bars; read the example as an optional
.
that
Optional item lists in syntax descriptions appear within brackets
delimited by commas and terminated with an ellipse; read the example
as an optional comma-separated list of
Commands, directives, keywords, and feature names are in text with
font.
letter gothic
Non-keyword placeholders appear in text with italic style format.
Note: For correct operation, ...
A Note provides supplementary information on a related topic. In the
online version of this book, the word Note appears instead of this
symbol.
Caution: Incorrect device operation may result if ...
Caution: Device damage may result if ...
A Caution identifies conditions or inappropriate usage of the product
that could lead to undesirable results or product damage. In the online
version of this book, the word Caution appears instead of this symbol.
Preface
this
this
.
this
or
or
xxxvii